This project is Free and Open Source Software released under the terms of the MIT license. Contributions are highly welcomed and appreciated. Every little help counts, so do not hesitate!

Report a bug

If you encounter any problems, please file a bug report in the project issue tracker along with a detailed description.

Submit a pull request

Contributors are invited to review the product high level design and the short term product planning.

Tests can be run with pytest with:

$ py.test -v --timeout=0 --pep8 --flakes --mccabe --cov=pytest_nodev --cov-report=html \
    --cache-clear pytest_nodev tests

coverage is can be checked with:

$ open htmlcov/index.html

the complete python versions tests can be run via tox with:

$ tox

Please ensure the coverage at least stays the same before you submit a pull request.


The documentation is in reStructuredText format, you can build a local copy with:

$ sphinx-build docs docs/html
$ open docs/html/index.html