Getting the source

You will first want to clone the source repository locally with git:

$ git clone

Setup Environment

I would recommend using virtualenv to set up a dev environment. After creating an environment, install all dep dependencies with:

$ pip install -r dev-requirements.txt

Running Tests

Tests are run using pytest and can be found inside tests/*.

Tests can simply be run using:

$ py.test

This will discover and run the test suite using your default Python interpreter. To run tests for all supported platforms, we use tox.

$ tox

Submitting Patches

Patches are accepted via Pull Requests on GitHub.


If you are submitting a security patch, please see our Security page for special instructions.


All new code and changed code must come with 100% test coverage to be considered for acceptance.