Skip to main content plugin for django

Project description

django-ratchet is a simple middleware for reporting errors from Django apps to


django-ratchet requires:

  • Python 2.6 or 2.7
  • Django 1.4+
  • requests 0.13.1+
  • a account


Install using pip:

pip install django-ratchet


Basic configuration requires two changes in your

  1. Add 'django_ratchet.middleware.RatchetNotifierMiddleware' as the last item in MIDDLEWARE_CLASSES:

        # ... other middleware classes ...
  2. Add the RATCHET settings dictionary somewhere in The bare minimum is:

    RATCHET = {
        'access_token': '32charactertokengoeshere',

Most users will want a few extra settings to take advantage of more features:

    'access_token': '32charactertokengoeshere',
    'environment': 'production',
    'branch': 'master',
    'root': '/absolute/path/to/code/root',

Here’s the full list of configuration variables:

Access token from your project

Environment name. Any string up to 255 chars is OK. For best results, use “production” for your production environment.

default: development if settings.DEBUG is True, production otherwise


One of:

  • blocking – runs in main thread
  • thread – spawns a new thread
  • agent – writes messages to a log file for consumption by ratchet-agent

default: thread


Request timeout (in seconds) when posting to Ratchet.

default: 1

Absolute path to the root of your application, not including the final /. If your is in /home/brian/www/coolapp/, then this should be set to /home/brian/www/coolapp . Required for Github integration.
Name of the checked-out branch. Required for Github integration.
If handler is agent, the path to the log file. Filename must end in .ratchet

URL items are posted to.



Contributions are welcome. The project is hosted on github at

Additional Help

If you have any questions, feedback, etc., drop me a line at

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for django-ratchet, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size django-ratchet-0.2.1.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page