uvi uv init

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

[!IMPORTANT] This project 'works' but is far from perfect!

See todos: TODO.md

• uv for dependency management
• CI/CD with GitHub Actions
• Pre-commit hooks with pre-commit
• Code quality with ruff (including Pylint-equivalent rules), mypy, deptry, and prettier
• Publishing to PyPI by creating a new release on GitHub
• Testing and coverage with pytest and codecov
• Documentation with MkDocs
• Compatibility testing for multiple versions of Python with tox-uv
• Containerization with Docker
• Development environment with VSCode devcontainers

Docs

• Docs

Installation & Usage

For both methods follow the prompts to configure your project. Once completed, a new directory containing your project will be created. Then navigate into your newly created project directory and follow the instructions in the README.md to complete the setup of your project.

Method 1: Using the CLI tool (Recommended)

Install the uvi tool globally:

uv tool install uvi

# or using pip
pip install uvi

Then navigate to the directory where you want to create your project and run:

uvi

Method 2: Using Cookiecutter directly

Alternatively, you can use cookiecutter directly:

uvx cookiecutter https://github.com/shaneholloman/uvi.git
# or if you don't have uv installed:
pip install cookiecutter
cookiecutter https://github.com/shaneholloman/uvi.git