Features¶

To use this app, add a configuration statement with your intended webhook callback path:

config.include('pyramid_sendgrid_webhooks', '/sendgrid/webhooks')

Then, set up subscribers for any events that you want to be notified of:

from pyramid_sendgrid_webhooks import events

def handle_bounce(event):
    request = event.request
    print event.reason

...
config.add_subscriber(handle_bounce, events.BounceEvent)

Currently the app adds a single endpoint at {PREFIX}/receive. This will be the webhook path to give to Sendgrid. In the example above, the full endpoint would therefore be at /sendgrid/webhooks/receive.

Credits¶

Tools used in rendering this package:

• Cookiecutter
• cookiecutter-pypackage

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up pyramid_sendgrid_webhooks for local development.

1. Fork the pyramid_sendgrid_webhooks repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/pyramid_sendgrid_webhooks.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv pyramid_sendgrid_webhooks
   $ cd pyramid_sendgrid_webhooks/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 pyramid_sendgrid_webhooks tests
   $ python setup.py test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/GoodRx/pyramid-sendgrid-webhooks/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

To run a subset of tests:

$ python -m unittest tests.test_pyramid_sendgrid_webhooks

Development Lead¶

• Kyle Stark <kyle@goodrx.com>

Contributors¶

None yet. Why not be the first?