Skip to main content generic python library

Project description

pyratchet is a generic library for reporting exceptions and other messages to

import ratchet, sys
ratchet.init('YOUR_ACCESS_TOKEN', 'production')  # access_token, environment

except IOError:
    ratchet.report_message('Got an IOError in the main loop', 'warning')
    # catch-all


pyratchet requires:

  • Python 2.6 or 2.7

  • requests 0.12+

  • a account


Install using pip:

pip install ratchet


For generic Python or a non-Django/non-Pyramid framework, follow these instructions:

Somewhere in your initialization code, call ratchet.init() with your access_token:

ratchet.init('YOUR_ACCESS_TOKEN_HERE', environment='production')

Other options can be passed as keyword arguments. See the reference below for all options.

If you are integrating with Django, follow these instructions:

  1. In your, add 'ratchet.contrib.django.middleware.RatchetNotifierMiddleware' as the last item in MIDDLEWARE_CLASSES:

        # ... other middleware classes ...
  2. Add these configuration variables in

    RATCHET = {
        'access_token': 'YOUR_ACCESS_TOKEN_HERE',
        'environment': 'development' if DEBUG else 'production',
        'branch': 'master',
        'root': '/absolute/path/to/code/root',

If you are integrating with Pyramid, follow these instructions:

  1. In your ini file (e.g. production.ini), add ratchet.contrib.pyramid to the end of your pyramid.includes:

    pyramid.includes =
  2. Add these ratchet configuration variables:

    ratchet.access_token = YOUR_ACCESS_TOKEN_HERE
    ratchet.environment = production
    ratchet.branch = master
    ratchet.root = %(here)s

The above will configure ratchet to catch and report all exceptions that occur in your Pyramid app. However, if there are any middleware applications that wrap your app, Ratchet will not be able to catch exceptions.

In order to catch exceptions from Pyramid and middleware code, you will need to create a pipeline where the ratchet middleware wraps your Pyramid app.

  • Change your ini file to use a pipeline:

    pipeline =
    pyramid.includes =
    access_token = YOUR_ACCESS_TOKEN_HERE
    environment = production
    branch = master
    root = %(here)s

Unfortunately, the ratchet tween and the ratchet filter configurations contains duplicated information. We’ll look into fixing this in future versions.


The Django and Pyramid integration will automatically report uncaught exceptions to Ratchet.

Call ratchet.report_exc_info() to report an exception, or ratchet.report_message() to report an arbitrary string message. See the docstrings for more info.

Configuration reference


Access token from your project


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


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


Absolute path to the root of your application, not including the final /.


Name of the checked-out branch.

default: master


If handler is agent, the path to the log file. Filename must end in .ratchet


URL items are posted to.



List of field names to scrub out of POST. Values will be replaced with astrickses. If overridiing, make sure to list all fields you want to scrub, not just fields you want to add to the default. Param names are converted to lowercase before comparing against the scrub list.

default ['passwd', 'password', 'secret', 'confirm_password', 'password_confirmation']

Developer Resources

Get in touch! We’d love to hear what you think and we’re happy to help.

Project details

Download files

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

Source Distribution

ratchet-0.4.1.tar.gz (11.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page