To install for development:

  1. Fork the webhook2lambda2sqs repository on GitHub
  2. Create a new branch off of master in your fork.
$ virtualenv webhook2lambda2sqs
$ cd webhook2lambda2sqs && source bin/activate
$ pip install -e
$ cd src/webhook2lambda2sqs

The git clone you’re now in will probably be checked out to a specific commit, so you may want to git checkout BRANCHNAME.


  • pep8 compliant with some exceptions (see pytest.ini)
  • 100% test coverage with pytest (with valid tests)


Testing is done via pytest, driven by tox.

  • testing is as simple as:
    • pip install tox
    • tox -e <environment name>
  • If you want to pass additional arguments to pytest, add them to the tox command line after “–”. i.e., for verbose pytext output on py27 tests: tox -e py27 -- -v

Acceptance Tests

These will actually spin up the entire system end-to-end, send some messages via POST and GET, and test that they work. It should clean everything up when finished.

tox -e acceptance

Use export NO_TEARDOWN=true to prevent tear-down of the infrastructure. When you’re ready to destroy it, unset NO_TEARDOWN and run tox -e acceptance again.

Release Checklist

  1. Open an issue for the release; cut a branch off master for that issue.
  2. Run the acceptance tox environment locally.
  3. Confirm that there are CHANGES.rst entries for all major changes.
  4. Ensure that Travis tests passing in all environments.
  5. Ensure that test coverage is no less than the last release (ideally, 100%).
  6. Increment the version number in webhook2lambda2sqs/ and add version and release date to CHANGES.rst, then push to GitHub.
  7. Confirm that README.rst renders correctly on GitHub.
  8. Upload package to testpypi:
  9. Create a pull request for the release to be merged into master. Upon successful Travis build, merge it.
  10. Tag the release in Git, push tag to GitHub:
  • tag the release. for now the message is quite simple: git tag -a X.Y.Z -m 'X.Y.Z released YYYY-MM-DD'
  • push the tag to GitHub: git push origin X.Y.Z
  1. Upload package to live pypi:
    • twine upload dist/*
  2. make sure any GH issues fixed in the release were closed.