Development¶

Development requirement¶

Boussole is developed with:

Test Development Driven (TDD) using Pytest;
Respecting flake and pip8 rules using flake8;
Sphinx for documentation with enabled Napoleon extension (using only the Google style);

Every requirement is available in file dev_requirements.txt.

Install for development¶

First ensure you have pip and virtualenv installed, then in your console terminal type this:

mkdir boussole-dev
cd boussole-dev
virtualenv --system-site-packages .
source bin/activate
pip install -r https://raw.githubusercontent.com/sveetch/boussole/master/dev_requirements.txt

Boussole will be installed in editable mode from the last commit on master branch.

When pip has finished installing requirements with success, you will be able to check for boussole version, just type:

boussole version