Contributor Guide
Setup
Requirements
- Make:
- macOS:
$ xcode-select --install - Linux: https://www.gnu.org/software/make
- Windows: https://mingw.org/download/installer
- macOS:
- Python:
$ asdf install - Poetry: https://poetry.eustace.io/docs/#installation
- Graphviz:
- macOS:
$ brew install graphviz - Linux: https://graphviz.org/download
- Windows: https://graphviz.org/download
- macOS:
To confirm these system dependencies are configured correctly:
$ make doctor
Installation
Install project dependencies into a virtual environment:
$ make install
Development Tasks
List commands
To get a list of available commands run:
$ make
Manual
Run the tests:
$ make test # all tests
$ make test-unit
$ make test-int
Run static analysis and automatically fix some errors:
$ make check
Serve the documentation locally:
$ 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.
Release Tasks
Release to PyPI:
$ make upload