Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 1.84 KB

README.md

File metadata and controls

54 lines (41 loc) · 1.84 KB

Python Project Template

My personal template for Python projects.

Features

  • Modern Python tooling with uv for dependency management and environment setup
  • Pre-configured pyproject.toml
  • Automated workflows - just commands for testing, linting, and building
  • Code quality tools: ruff for linting and formatting, pre-commit hooks
  • Testing setup with pytest and Hatch for cross-version testing
  • GitHub Actions integration: optional workflows for linting, testing and PyPI publishing
  • Conditional repo setup: if gh is installed, optionally create a public/private GitHub repo
  • Licenses from choosealicense.com
  • Basic README.md with badges and installation instructions

Requirements

  • Python 3.12 or higher
  • sprout
  • Git

Usage

sprout "https://github.com/zigai/python-project-template.git" /path/to/your/project

Generated Project Structure

your-project/
├── your_package/
│   └── __init__.py
├── tests/
│   └── test_your_package.py
├── .github/workflows/          
├── pyproject.toml             
├── README.md                  
├── CONTRIBUTING.md             
├── Justfile                    
├── LICENSE                    
└── .gitignore

Similar Templates

License

MIT License