For contributing

Installing environment

Clone the repository.

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

Install uv using the guide from their website – https://docs.astral.sh/uv/getting-started/installation/.

Inside project directory install dependencies.

uv sync

After that, install pre-commit hook.

uv run 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.

uv build

Publish the package.

uv publish --token <your-api-token>

Warning

Make a release with notes about changes.

How to generate badges?

Just exec that command.

uv run ./.bc/badges.py

Then all badges actualize ourselves.

How to build sphinx docs?

cd docs && make html