Initial commit

This commit is contained in:
Jev
2025-08-11 11:36:10 +02:00
commit 43a36cc733
12 changed files with 481 additions and 0 deletions

View File

@@ -0,0 +1,55 @@
# {{ cookiecutter.project_name }}
{{ cookiecutter.description }}
## Installation
```bash
pip install {{ cookiecutter.project_slug }}
```
## Development
This project uses `uv` for dependency management and the following tools:
### Setup
```bash
uv sync
```
### Code Quality
- **Ruff**: Linting and formatting
```bash
uv run ruff check --fix
uv run ruff format
```
- **MyPy**: Type checking
```bash
uv run mypy .
```
### Testing
```bash
uv run pytest
```
### Version Management
- **bump-my-version**: Automated version bumping with git tags
```bash
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
```python
from {{ cookiecutter.package_name }} import hello
print(hello())
```
## License
MIT License - see LICENSE file for details.