Setup

Requirements

  • Make:
    • Windows: http://mingw.org/download/installer
    • Mac: http://developer.apple.com/xcode
    • Linux: http://www.gnu.org/software/make
  • Python: $ asdf 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

Installation

Install project dependencies into a virtual environment:

$ make install

Development Tasks

Manual

Run the tests:

$ make test

Run static analysis:

$ make check

Build the documentation:

$ make docs

Automatic

Keep all of the above tasks running on change:

$ make dev

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

Continuous Integration

The CI server will report overall build status:

$ make all

Release Tasks

Release to PyPI:

$ make upload