Skip to main content notifier plugin for Pyramid

Project description

pyramid_ratchet is a simple middleware for reporting errors from Pyramid apps to


pyramid_ratchet requires:

  • Python 2.6 or 2.7

  • Pyramid 1.2+

  • requests 0.12+

  • a error reporting account


Install using pip:

pip install pyramid_ratchet


Add pyramid_ratchet to the beginning of your pyramid.includes:

pyramid.includes =

Add the bare minimum configuration variables:

ratchet.access_token = 32charactertoken

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

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

Here’s the full list of configuration variables:


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 /. %(here)s is probably what you want.


Name of the checked-out branch.

default: master


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


When true, adds a hook to send a test error report (but not interrupt the request in any other way) whenever the query string contains pyramid_ratchet_test=true.

default: true


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

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

pyramid_ratchet-0.2.3.tar.gz (2.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