Development

In order to make changes to this library, you will need:

Poetry Installation

Install Poetry using one of options.

Pip:

pip install poetry

Brew:

brew install poetry

ASDF:

asdf plugin add poetry
asdf install poetry latest
asdf global poetry latest

Use this command to initialize project (along with it’s virtualenv) and fetch dependencies.

poetry install

In order to run any command inside virtualenv:

poetry run command args
# For example
poetry run pytest

You may also activate virtualenv inside current terminal (equivalent to source venv) and run commands:

poetry shell
# venv activated
pytest

Register your PyPI token (once):

poetry config pypi-token.pypi your-pypi-token

Build project:

poetry build

Publish to PyPI manually:

poetry publish

For linting:

ruff check

Ruff may automatically fix minor issues. If not, it will show file with the issue.

For formatting:

ruff format