CONTRIBUTING.md

Contributor Guide

Setup

Requirements

• Make:
  • macOS: $ xcode-select --install
  • Linux: https://www.gnu.org
  • Windows: $ choco install make https://chocolatey.org
• Python: $ asdf install (https://asdf-vm.com)[https://asdf-vm.com/guide/getting-started.html]
• Poetry: https://python-poetry.org
• Graphviz:
  • macOS: $ brew install graphviz
  • Linux: https://graphviz.org/download
  • Windows: https://graphviz.org/download

To confirm these system dependencies are configured correctly:

$ make bootstrap
$ 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

Demo Tasks

Run the program:

$ make run

Launch an IPython session:

$ make shell

Release Tasks

Release to PyPI:

$ make upload