1.0 KiB
1.0 KiB
{{ cookiecutter.project_name }}
{{ cookiecutter.description }}
Installation
pip install {{ cookiecutter.project_slug }}
Development
This project uses uv for dependency management and the following tools:
Setup
uv sync
Code Quality
-
Ruff: Linting and formatting
uv run ruff check --fix uv run ruff format -
MyPy: Type checking
uv run mypy .
Testing
uv run pytest
Version Management
- bump-my-version: Automated version bumping with git tags
uv run bump-my-version bump patch # {{ cookiecutter.version }} → 0.1.1 uv run bump-my-version bump minor # {{ cookiecutter.version }} → 0.2.0 uv run bump-my-version bump major # {{ cookiecutter.version }} → 1.0.0
Usage
from {{ cookiecutter.package_name }}.core import say_hello
say_hello() # prints: Hello, World!
say_hello("Alice") # prints: Hello, Alice!
License
MIT License - see LICENSE file for details.