Minimal uv2nix Template

A minimal template for Python projects using uv2nix and Nix flakes.

Features

• Simple Python project structure
• uv2nix integration for dependency management
• Nix flake for reproducible development environments

Getting Started

Prerequisites

• Nix with flakes enabled
• direnv (recommended for automatic environment switching)

Creating a New Project

1. Click the "Use this template" button at the top of this repository page
2. OR use GitHub CLI: gh repo create my-project --template KaoruBB/uv2nix-template
3. Clone your new repository and update the project details in pyproject.toml

Development Workflow

# After cloning your new repository
cd your-project-name

# If using direnv:
direnv allow

# Alternatively, manually enter the development shell:
nix develop

# Run the example
python main.py

Adding Dependencies

1. Run uv add <package> to add a new Python package.
2. Update the flake with direnv reload

Project Structure

• flake.nix: Nix flake configuration
• pyproject.toml: Python project dependencies
• main.py: Example Python script
• uv.lock: Lock file for Python dependencies
• .envrc: direnv configuration for automatic environment activation

License

MIT