cookiecutter-uv-example 0.0.3

This is a template repository for Python projects that use uv for their dependency management.

cookiecutter-uv-example

This is a template repository for Python projects that use uv for their dependency management.

• Github repository: https://github.com/fpgmaas/cookiecutter-uv-example/
• Documentation https://fpgmaas.github.io/cookiecutter-uv-example/

Getting started with your project

1. Create a New Repository

First, create a repository on GitHub with the same name as this project, and then run the following commands:

git init -b main
git add .
git commit -m "init commit"
git remote add origin [e-mail]:fpgmaas/cookiecutter-uv-example.git
git push -f origin main

2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

make install

3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

uv run pre-commit run -a
git add .
git commit -m 'Fix formatting issues'
git push origin main

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

• Create an API Token on PyPI.
• Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
• Create a new release on Github.
• Create a new tag in the form *.*.*.

For more details, see here.

---

Repository initiated with fpgmaas/cookiecutter-uv.