Developer’s Overview

Contributing

You can contribute to the project or report issues on the Github repository: https://github.com/BloomyControls/bs120x-enet-python

Bear in mind, the Python library is a thin wrapper around the C/C++ drivers. If you have a problem or feature request pertaining to the C/C++ drivers, you should contribute directly to the C/C++ drivers: https://github.com/BloomyControls/bs120x-enet

Building and Installing

Before doing any of the commands below, you should set up a virtual environment:

python -m venv .venv
.venv\Scripts\Activate.ps1

python -m venv .venv
. .venv/bin/Activate

To install requirements for building:

python -m pip install build

To install the project locally from source:

python -m pip install .

To build HTML documentation:

python -m pip install -r docs/doc-requirements.txt
python -m sphinx -an docs/_build

Creating a New release

  • Always release from the main branch.

  • Update the version, either using hatch version or by manually editing __init__.py

  • To build distribution package: python -m build

  • To create a release and publish to PyPi, push a tag to the main branch. Make sure you have updated the version appropriately first!