django-hoptoad / README.rst

Full commit
mahmoudimus 8802249 

mahmoudimus 1c4fe03 
mahmoudimus 8802249 

mahmoudimus 1c4fe03 

mahmoudimus 323f000 
mahmoudimus 1c4fe03 
mahmoudimus 8802249 


django-hoptoad is some simple Middleware for letting Django_-driven websites report their errors to Hoptoad_.  Now ponies_ can ride the toad too.

.. _Django:
.. _Hoptoad:
.. _ponies:


django-hoptoad requires:

* Python_ 2.6
* Django_ 1.0+
* A Hoptoad_ account

.. _Python:


Grab the the django-hoptoad code by cloning the Mercurial_ repository (or just `download the latest version <>`_ and unzip it somewhere)::

    hg clone

There's a git mirror too if you *really* want it::

    git clone git://

Once you download it, you can install it in the usual manner::

    cd django-hoptoad
    python install

If you'd prefer to be able to update at any time by pulling down changes with Mercurial or git, you can symlink the module into your ``site-packages`` directory instead of using ``python install``::

    ln -s /full/path/to/django-hoptoad/hoptoad /full/path/to/site-packages/

To make sure it works you can run::

    python -c 'import hoptoad'

.. _Mercurial:


To set up a Django project to notify Hoptoad of its errors, you need to do two things in its `` file.

First, add the ``HoptoadNotifierMiddleware`` as the last item in the ``MIDDLEWARE_CLASSES``` setting::

        # ... other middleware classes ...

Next, you'll need to add a ``HOPTOAD_API_KEY`` setting.  You can get the key from the Hoptoad project page::

    HOPTOAD_API_KEY = 'Your Hoptoad API key.'


There are more advanced options that can be used to customize your Hoptoad_ notification process; please go to `Configuration guide <>`_ to see more advanced configuration and usage options.


The documentation for django-hoptoad is at the `project page <>`_. There's a `Quick Start guide <>`_, `Configuration guide <>`_, `Troubleshooting guide <>`_, and a few other things there.

The documentation is stored in the ``docs/`` directory of the repository if you prefer to read it offline.


This Middleware is a work in progress.  If you have a suggestion or find a bug please `add an issue <>`_ and let me know.