Contribute

Setup Development Environment

Ensure Python 3.11 is available on your machine.
Create local checkout of this repository, for example in a folder named /serial_tool.
Navigate to this folder.
Prepare virtual environment with python 3.11: python -m venv venv
Activate environment.
Update pip: python -m pip install -U pip.
Install package in editable mode, while supplying [dev] argument:
```
 $ python -m pip install -e .[dev] 
```
Install pre-commit hook:
```
$ pre-commit install
```

Notes:

All settings are available in pyproject.toml. Avoid adding any other cfg files if possible.
For new functionalities, tests are mandatory. Current state without test is a painful legacy.
Pylint is disabled in pre-commit, as there is just to many warnings. However, inspect issues before commiting anything.

Scripts

... are available in ./scripts directory. Windows users only, but the commands should be easily ported to any platform.

VS Code workspace

VS Code workspace is available with already configured pytest/black/pylint actions.