django-hoptoad 0.2

django-hoptoad is some simple Middleware for letting Django-driven websites report their errors to Hoptoad.

django-hoptoad is some simple Middleware for letting [Django][]-driven websites report their errors to [Hoptoad][]. Now [ponies][] can ride the toad too.

[Django]: http://djangoproject.com/ [Hoptoad]: http://hoptoadapp.com/ [ponies]: http://djangopony.com/

Requirements

django-hoptoad requires:

• [Python][] 2.5+ (preferably 2.6+ as that’s what I’ve tested it with)

• [PyYAML][] (pip install pyyaml or easy_install pyyaml)

• [Django][] 1.0+

• A [Hoptoad][] account

[Python]: http://python.org/ [PyYAML]: http://pyyaml.org/

Installation

Grab the the django-hoptoad code by cloning the [Mercurial][] repository (or just [download the latest version][tip-dl] and unzip it somewhere):

hg clone http://bitbucket.org/sjl/django-hoptoad/

There’s a git mirror too if you really want it.

git clone git://github.com/sjl/django-hoptoad.git

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

cd django-hoptoad python setup.py 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 setup.py 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]: http://mercurial.selenic.com/ [tip-dl]: http://bitbucket.org/sjl/django-hoptoad/get/tip.zip

Usage

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

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

MIDDLEWARE_CLASSES = ( # … other middleware classes … ‘hoptoad.middleware.HoptoadNotifierMiddleware’, )

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.’

Documentation

The documentation for django-hoptoad is at the [project page][project]. There’s a [Quick Start guide][quickstart], [Configuration guide][config], [Troubleshooting guide][troubleshooting], and a few other things there.

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

[project]: http://sjl.bitbucket.org/django-hoptoad/ [quickstart]: http://sjl.bitbucket.org/django-hoptoad/quickstart/ [config]: http://sjl.bitbucket.org/django-hoptoad/config/ [troubleshooting]: http://sjl.bitbucket.org/django-hoptoad/troubleshooting/

Suggestions

This Middleware is a work in progress. If you have a suggestion or find a bug please [add an issue][issues] and let me know.

[issues]: http://bitbucket.org/sjl/django-hoptoad/issues/?status=new&status=open