KeyError Django client

View all documentation


The Django KeyError client posts errors that occur in your Django projects back to KeyError.

Requirements

  • Django >= 1.0.2
  • Python >= 2.5

Installation

  1. Install the django_keyerror package, eg. via Pip

    $ pip install django-keyerror

    If you do not use Pip, you can obtain the code from the django-keyerror Git repository.

  2. Check if installation was successful:

    $ ./manage.py shell
    Python 2.6.6 (r266:84292, Dec 26 2010, 22:31:48)
    [GCC 4.4.5] on linux2
    Type "help", "copyright", "credits" or "license" for more information.
    (InteractiveConsole)
    >>> import django_keyerror
    >>>

    If you don't see any errors here, installation was succesful.

  3. Add django_keyerror to your INSTALLED_APPS:

    INSTALLED_APPS = [
      # [..]
      'django_keyerror',
      # [..]
    ]
  4. Add the KeyError middleware to the top of your MIDDLEWARE_CLASSES:

    MIDDLEWARE_CLASSES = [
      'django_keyerror.middleware.KeyErrorMiddleware',
      # [..]
    ]
  5. Add your KeyError secret key to your settings.py:

    KEYERROR_SECRET_KEY = '..secret..'
  6. That's it! Your Django project will now send us your error tracebacks.

Code

The client code is released under the terms of the BSD license and is available on Github.

Have any questions? Please email us at hello@keyerror.com.