Python repository template

This serves as an example of how to set up a new Python project.

You should update this README to be specific to your project. You should update pyproject.toml with the name of your project and rename the src/repository_template directory to be appropriate for your project.

Run the example

A simple "Hello World" example can be run using:

uv run scripts/example.py

Set up the hooks

These pre-push hooks ensure that the formatter is run and the badges are updated every time you attempt to git push. This way formatting errors are caught and be corrected before they reach the GitHub continuous-integration (CI) step. The badges are then automatically up-to-date.

git config --local core.hooksPath .githooks/

Check the formatting

The formatting can be checked manually using:

./scripts/format.sh

this is exactly the script that is run in the CI pipeline and the pre-push hook. Formatting uses Prettier for markdown, shfmt for shell scripts, and ruff for Python.

Run the tests

The tests can be run manually using:

./scripts/test.sh