49 lines
1.3 KiB
Markdown
49 lines
1.3 KiB
Markdown
# CLAUDE.md
|
|
|
|
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
|
|
## Project Overview
|
|
|
|
`{{ cookiecutter.project_slug }}` is a Python library for {{ cookiecutter.description.lower() }}.
|
|
|
|
## Development Commands
|
|
|
|
### Setup
|
|
```bash
|
|
uv sync
|
|
```
|
|
|
|
### Code Quality
|
|
- **Linting and formatting**: `uv run ruff check --fix` and `uv run ruff format`
|
|
- **Type checking**: `uv run mypy .`
|
|
- **Combined linting**: `uv run invoke lint`
|
|
|
|
### Testing
|
|
- **Run tests**: `uv run pytest`
|
|
- **Run tests with coverage**: `uv run invoke test`
|
|
|
|
### Maintenance
|
|
- **Clean untracked files**: `uv run invoke clean` (interactive)
|
|
- **Version bumping**: `uv run bump-my-version bump [patch|minor|major]`
|
|
|
|
## Project Structure
|
|
|
|
```
|
|
src/{{ cookiecutter.package_name }}/
|
|
├── __init__.py # Package initialization
|
|
├── core.py # Main functionality
|
|
└── py.typed # Type hints marker
|
|
|
|
examples/
|
|
└── basic_usage.py # Usage examples
|
|
|
|
tests/
|
|
└── test_{{ cookiecutter.package_name }}.py # Test suite
|
|
```
|
|
|
|
## Development Notes
|
|
|
|
- Uses Python {{ cookiecutter.python_version }}+ with modern type hints
|
|
- Configured with ruff for linting/formatting and mypy for type checking
|
|
- Built with uv for dependency management
|
|
- Includes invoke tasks for common operations |