Contributing

Setup

We use uv as our package manager. To get started, follow these steps:

pip install uv
uv sync
. .venv/bin/activate

You can run tests using unittest or coverage with our custom setup script:

With unittest:

python django_utils_kit/tests/setup.py

With coverage:

coverage run django_utils_kit/tests/setup.py
coverage report --fail-under=90
coverage html

In the CI, tests are run on multiple Python versions (from 3.9 to 3.13) to ensure compatibility on each version.

Git hooks are set in the .githooks folder (as .git/hooks is not tracked in .git)

Run the following command to tell git to look for hooks in this folder:

git config core.hooksPath .githooks

Pre-commit hooks will run ruff, mypy, and coverage on each commit.

We use GitHub actions to verify, build, and deploy the application. We currently have:

code_quality: runs ruff, mypy, and coverage
publish_package: Deploys the package on PyPi
tests: runs unittests on multiple Python versions (from 3.9 to 3.13)
update_deps: updates the dependencies (as dependabot does not support uv yet)