Contributing¶

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

Environment setup¶

You only need two tools, uv and Copier.

curl -LsSf https://astral.sh/uv/install.sh | sh

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Then install Copier:

uvx copier --with copier-templates-extensions

Then you can clone the repository, enter it and set it up with:

git clone https://github.com/oedokumaci/python-production-template
cd python-production-template
make setup

Running tests¶

To run the tests, use:

make test

Serving docs¶

To serve the docs locally, use:

make docs