Contributing

You are considering to contribute. Thank you! This document should get you up and running with your development environment.

Development environment

Clone the repo with its submodules: git clone --recurse-submodules https://github.com/Cereal2nd/velbus-aio
(optional) To keep dependencies from different projects from conflicting, it's usually better to install every project in its own Virtual Environment. Start by creating a new virtualenv: python3 -m venv venv This will create a new directory called venv (the second venv in the command). You need to activate the virtual environment every time you open a new shell by running source venv/bin/activate. Your prompt will be prefixed with (venv) to indicate the virtual environment is active.
Install the development dependencies: pip install -r requirements-dev.txt
Prepare your changes
Run the tests to check if everything still works as expected: pytest
Run pre-commit run --all-files to check and correct formatting