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:

1

$ make doctor

Installation

Install project dependencies into a virtual environment:

1

$ make install

Development Tasks

Manual

Run the tests:

1

$ make test

Run static analysis:

1

$ make check

Build the documentation:

1

$ make docs

Automatic

Keep all of the above tasks running on change:

1

$ make watch

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

Continuous Integration

The CI server will report overall build status:

1

$ make ci

Release Tasks

Release to PyPI:

1

$ make upload