Setup

Requirements

Make:
- Windows: http://mingw.org/download/installer
- Mac: http://developer.apple.com/xcode
- Linux: http://www.gnu.org/software/make
Python: $ pyenv install
Poetry: https://poetry.eustace.io/docs/#installation
Graphviz: http://www.graphviz.org/Download.php

To confirm these system dependencies are configured correctly:

$ make doctor

Install project dependencies into a virtual environment:

$ make install

Run the tests:

$ make test

Run static analysis:

$ make check

Build the documentation:

$ make docs

Keep all of the above tasks running on change:

$ make watch

In order to have OS X notifications, brew install terminal-notifier.

The CI server will report overall build status:

$ make ci

Release to PyPI:

$ make upload