For contributing

Installing environment

Clone the repository.

git clone git@github.com:esoft-tech/py-bc-configs.git

Install poetry using the guide from their website – https://python-poetry.org/docs/#installation.

After installation, apply this in order for poetry to create venv in your project folder.

poetry config virtualenvs.in-project true

Inside project directory install dependencies.

poetry install

After that, install pre-commit hook.

./.venv/bin/python -m pre-commit install

Done 🪄 🐈‍⬛ Now you can develop.

If you want contributing

• Check that ruff passed.

• Check that mypy passed.

• Before adding or changing the functionality, write unittests.

• Check that unittests passed.

If you need to build and publish the package

Up the package version in the pyproject.toml.

- version = "0.1.0"
+ version = "0.1.1"

Commit changes and push them to the origin.

git add pyproject.toml
git commit -m "Up to 0.1.1"
git push

Make a tag and push them to the origin.

git tag 0.1.1
git push origin 0.1.1

Build the package.

poetry build

Configurate your pypi token for the poetry.

poetry config pypi-token.pypi <your-api-token>

Publish the package.

poetry publish

Warning

Make a release with notes about changes.

How to generate badges?

Just exec that command.

./.venv/bin/python ./.bc/badges.py

Then all badges actualize ourselves.

How to build sphinx docs?

bash ./.bc/build_docs.sh