python-controllino

python-controllino is a python module for using serial devices that implement the 8tronix Controllino Protocol.

For documentation, please refer to the docstrings in src/controllino or the tests.

Technical notes for devs

Test Suite

Run make venv && make to create a virtual environment for testing and run the test suite.

Style guide

• Our Python code follows the Black style guide
• The formatting of our Python docstrings follows 3.8 Comments and Docstrings of the Google Python Style Guide
• We use prettier to format markdown files
• The Python code, specification and documentation is licensed under GPL-3.0-or-later, all examples are unlicensed; we follow the REUSE-3.0 specification

Workflow

We use the standard gitflow branching model. Pull requests should only go into the develop branch. The develop branch will be regularly merged into master.