Setup¶
Requirements¶
- Make:
- macOS:
$ xcode-select --install
- Linux: https://www.gnu.org/software/make
- Windows: https://mingw.org/download/installer
- macOS:
- Python:
$ pyenv install
- Poetry: https://poetry.eustace.io/docs/#installation
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 watch
In order to have OS X notifications,
brew install terminal-notifier
.
Continuous Integration¶
The CI server will report overall build status:
$ make ci
Release Tasks¶
Release to PyPI:
$ make upload