If you wish to contribute to this project, then you should fork the repository found here:

Once that has been done and you have a checkout, you can follow these instructions to perform various development tasks:

Setting up a virtualenv

The recommended way to set up a development environment is to turn your checkout into a virtualenv and then install the package in editable form as follows:

$ virtualenv .
$ bin/pip install -e .[test]

Running the tests

Once you’ve set up a virtualenv, the tests can be run as follows:

$ source bin/activate
$ pytest

Building the documentation

The Sphinx documentation is built by doing the following, having activated the virtualenv above, from the directory containing

$ source bin/activate
$ cd docs
$ make html

To check that the description that will be used on PyPI renders properly, do the following:

$ python --long-description | > desc.html

Making a release

To make a release, just update the version in, update the change log and push to and Carthorse should take care of the rest.