Contributing

Patches are more than welcome! You can find the issue tracker on GitHub and we’d love pull requests.

Style

Patches should follow PEP8 and should not introduce any new violations as detected by the flake8 tool.

Tests

Patches fixing bugs should include regression tests (ideally tests that fail without the rest of the patch). Patches adding new features should test those features thoroughly.

To run the tests, install the requirements (probably into a virtualenv):

pip install -e .
pip install -e .[tests]

Then just py.test to run the tests:

py.test