uv cookiecutter template

My template for Python apps built with uv

About

This repository implements a template for a minimal Python package that uses uv+Setuptools for packaging and dependency management.

Installation

1. Install cookiecutter first and then:

   cookiecutter gh:dirmeier/cookiecutter-uv

2. After having created a project, install all dependencies using uv:

   uv sync --all-extras

3. Init a GitHub repo using

   git init
   git remote add origin git git@github.com:{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}.git

4. Setup Codecov and Codacy, or your preferred code coverage and code quality tools. Fix the respective links in the header of README.md.

5. Install pre-commit and gitlint via:

   pre-commit install
   gitlint install-hook

6. Create a new branch for development via:

   git checkout -b my-new-feature

7. Develop code, implement unit tests and write documentation.

8. Test everything via

   make format
   make lints 
   make tests 
   make docs

9. Commit your changes using an informative commit message. Read this for help.

10. Push your changes to your feature branch and create a pull request.

11. Squash-merge your changes onto main or, ideally, clean up your commit history and rebase onto main.

12. Don't forget to create tags and releases.

Author

Simon Dirmeier sfyrbnd @ pm me