uv_cookie

Cookiecutter template for uv projects

This is a modern Cookiecutter template that can be used to create a Python project with all the necessary tools for development, testing, and linting. It supports the following features:

• uv for dependency management
• ruff for linting
• pytest for testing
• pre-commit for pre-commit hooks
• pyright for static type checking
• conventional-pre-commit for commit message linting
• CI/CD with GitHub Actions
• Comes with (pandas and numpy) pre-installed

Quickstart

On your local machine, navigate to the directory in which you want to create a project directory, and run the following command:

uvx cookiecutter https://github.com/lobennett/uv_cookie.git

or if you don't have uv installed yet:

pip install cookiecutter
cookiecutter https://github.com/lobennett/uv_cookie.git

Follow the prompts to configure your project. Once completed, a new directory with the name [project_slug] will be created. Then navigate into your newly created project directory (e.g. cd [project_slug]) and follow the instructions in the README.md to complete the setup.

Notes

This project is based on Jeanette's packaging notes repository.