For Contributors
Requirements
- Make:
- Windows: http://cygwin.com/install.html
- Mac: https://developer.apple.com/xcode
- Linux: http://www.gnu.org/software/make (likely already installed)
- virtualenv: https://pypi.python.org/pypi/virtualenv#installation
- Pandoc: http://johnmacfarlane.net/pandoc/installing.html
- Graphviz: http://www.graphviz.org/Download.php
Installation
Create a virtualenv:
$ make env
Run the tests:
$ make test
$ make tests # includes integration tests
Build the documentation:
$ make doc
Run static analysis:
$ make pep8
$ make pep257
$ make pylint
$ make check # includes all checks
Release to PyPI:
$ make upload-test # dry run upload to a test server
$ make upload