Cookiecutter Python UV Boilerplate

This project is a cookiecutter template for a Python project using uv.

Requirements

• direnv
• uv

Setup

1. Run the following command to get started:

   uvx cookiecutter https://github.com/araa47/cookiecutter-python-uv-boilerplate.git
   

   This will prompt you for project information (name, description, version) and create a new directory with your project.

2. Navigate to the project directory and run:

   direnv allow
   

   This sets up the environment. See .envrc for details.

Project Features

1. Environment Management: direnv for automatic environment setup.

2. Dependency Management: uv for managing Python versions and dependencies, replacing pyenv and poetry.

3. Code Quality: pre-commit for managing pre-commit hooks. See .pre-commit-config.yaml for configured hooks.

4. Testing: pytest for writing and running tests.

5. Continuous Integration:

   • GitHub Actions for linting, formatting, and testing on pull requests.
   • GitHub Actions for testing on merges to main.