Any development help is greatly appreciated. If you have have any new features, bug fixes or documentation improvements please feel free to contribute.

Getting started

To start developing on this project, fork this project on our Github page and install from source using the instructions in Install. Additionally, you will need to install the following dependencies for running test and compiling documentation.

Running Tests

This project has been configured to use the Nose testing framework and Tox for automation. The following command will run all tests for the project. Since many of the tests connect to the server, running the tests may take quite a few seconds.


To run only local tests, you can use the following command:

nosetests -a '!live_tests'

To local tests for Python versions 2.7, 3.3, 3.4, 3.5 and PyPy:

tox documentation

The documentation can be overly verbose and very inconsistent with the implementations of many of its features. You can view the documentation by visiting the following links:

Submitting bugs and patches

All bug reports, new feature requests and pull requests are handled through this project’s Github issues page.