Dashboard

A Python interactive dashboard package.

Developer guide

Versioning

This project uses semantic versioning. Version increments are checked using Raver.

Python packaging information

This project is packaged using flit. Packaging information as well as dependencies are stored in pyproject.toml.

Installing the project and its dependencies can be done using raver install.

Building the project (creating a wheel) can be done using raver build.

Testing

The tests need to be put in the tests/ directory and can be run using raver test on both Windows and Linux as long as Raver and its dependencies pytest and pytest-cov are installed in the active Python environment. Running pytest in the tests directory works as well.

Documentation

Building the documentation (in HTML) can be done using raver docs. The documentation is then built locally at doc/build using sphinx.