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
- 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
On a Raspberry Pi, you'll need to run the following first:
sudo apt install libffi-dev chromium-chromedriver
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.bashrc
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 ci
Demo Tasks
Run the program:
$ make run
````
Launch an IPython session:
```text
$ make shell
Release Tasks
Release to PyPI:
$ make upload