For Contributors



  • Make:
    • Windows:
    • Mac:
    • Linux:
  • pipenv:

To confirm these system dependencies are configured correctly:

$ make doctor


Install project dependencies into a virtual environment:

$ make install

Development Tasks


Manually run the tests:

$ make test

or keep them running on change:

$ make watch

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

Static Analysis

Run linters and static analyzers:

$ make pylint
$ make pycodestyle
$ make pydocstyle
$ make check  # includes all checks

Continuous Integration

The CI server will report overall build status:

$ make ci