Installation

You want to contribute to this project ? :tada:
You are more than welcome, but before you head-start, please read the few instructions below...

OS supported

• Debian 10
• Debian 11
• Ubuntu 20.04
• Ubuntu 22.04

Setup a virtual environment

Python Virtual Environment is strongly suggested in order to avoid dependecy conflicts on your system. The poetry project is used for development.

Tools to generate your doc are strongly advised except if you like to do this manually. This project use

• lazydoc to auto-generate markdown doc from DocString
• mkdocs to auto-generate html page from basic markdown structure and lazydoc output
• mkdocs-awesome-pages-plugin in order to have a beautiful theme :wink:

Code Style

This project use BLACK code rules as code style, please respect this.

Adapt code exceptions

If you are using vscode along with poetry you can find inside pyproject.toml some exclusion on Black style code. If you need to add some extras ones here is the Error codes.

Install project

Once your prerequises are met, you should then launch poetry and install dependencies

cd /path/to/project
poetry shell
poetry install