CONTRIBUTING.md

Development

Python version

Pyenv is recommended for managing python versions. Currently, python 3.8+ is used for development.

Virtualenv

Uses Poetry. For initial setup, run:

# Install poetry (1.0+)
pip install -U poetry

# Configure poetry to install virtualenv in local directory
poetry config virtualenvs.create true
poetry config virtualenvs.in-project true

# Install virtualenv in local directory
poetry install

VSCode will automatically load the virtualenv. ruff (linting) and black (formatter) are installed as dev dependencies.

To activate the local virtualenv:

source .venv/bin/activate
# or
poetry shell

Creating a new release

Update the library version in the following files with every PR according to semver guidelines -

• pyproject.toml

Add a new tag -

git tag -a <tagname> -m "tag message"

Push the new tag -

git push origin <tagname>