Testing

The only Python package that needs to be installed globally is Tox. All the dependencies, testing tools and documentation tools will be installed by Tox in virtual environments. Tox will test against Python 2.7 and PyPy. Python 2.7 virtual environment will have coverage.py installed for unit test coverage checking which will be reported in the terminal when you run Tox. Detailed HTML reports will be generated in the htmlcov directory.

$ pip install tox
$ tox

Usually it will suffice to run:

$ tox -e py27

However, before committing, you should make sure that PyPy works as well.

Building documentation

Documentation is built using Sphinx, which is going to be installed by Tox in the Python 2.7 virtual environment.

$ make docs

The output will be in docs/build/html.