Development

Development requirements

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 Google style);

  • tox to run tests on various environments;

Every requirements are available in package extra requirements in section dev.

Install for development

First ensure you have pip and virtualenv packages installed then type:

git clone https://github.com/sveetch/boussole.git
cd boussole
make install

Boussole will be installed in editable mode from the latest commit on master branch with some development tools.

Unittests

Unittests are made to works on Pytest, a shortcut in Makefile is available to start them on your current development install:

make tests

Tox

To ease development against multiple Python versions a tox configuration has been added. You are strongly encouraged to use it to test your pull requests.

Before using it you will need to install tox, it is recommended to install it at your system level (tox dependancy is not in requirements):

sudo pip install tox

Then go in the boussole directory, where the setup.py and tox.ini live and execute tox:

tox

Documentation

Use the Makefile action docs to build documentation:

make docs

Use the Makefile action livedocs to serve documentation and automatically rebuild it when you change documentation files:

make livedocs

livedocs does not perform a first build for you, if you never built documentation or make changes before launching it, you need to make a build yourself before.

And go on http://localhost:8002/ or your server machine IP with port 8002.

Contribution

  • Every new feature or changed behavior must pass tests, Flake8 code quality and must be documented.

  • Every feature or behavior must be compatible for all supported environment.

Releasing

First thing is to ensure changelog have been correctly updated with informations about your release.

Before releasing, use tox to perform tests on all supported environments then finally launch a full quality job which will check about everything (tests, flake, doc, etc..):

make quality

When finishing a release, you must update the frozen dependencies file:

make freeze-dependencies

Remember to do it when the release version is finalized like 2.0.0, not during a pre release like 2.0.0-pre.1.

When it’s done, push everything to the repository and make attempted release:

make release

This will build the package release and send it to Pypi with twine. You may think to configure your Pypi account on your machine to avoid to input it each time and obviously you need to be granted to manage this project.