Setup

Requirements

Make:
- macOS: $ xcode-select --install
- Linux: https://www.gnu.org/software/make
- Windows: https://mingw.org/download/installer
Python: $ pyenv install
Poetry: https://python-poetry.org/docs/#installation
Graphviz:
- macOS: $ brew install graphviz
- Linux: https://graphviz.org/download
- Windows: https://graphviz.org/download

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