# python-template

A modern Python project template with comprehensive tooling and documentation ready for GitHub Pages hosting.

## Features

- **Modern Python tooling**: uv, ruff, pytest, pydantic
- **Comprehensive documentation**: Ready-to-use guides for common Python packages
- **GitHub Pages ready**: The `docs/` folder can be directly hosted as a static documentation site
- **Best practices**: Pre-configured with Python coding standards and project structure

## Documentation

The `docs/` folder contains comprehensive documentation that can be hosted directly on GitHub Pages:

1. Go to your repository Settings → Pages
2. Under "Source", select "Deploy from a branch"
3. Choose "main" branch and "/docs" folder
4. Click Save

Your documentation will be available at: `https://[username].github.io/[repository-name]/`

## Project Structure

```
./
├── docs/                   # Documentation (GitHub Pages ready)
├── src/                    # Application code
├── tests/                  # Test files
├── logs/                   # Implementation logs
├── llms/                   # LLM-friendly documentation
├── Makefile               # Task automation
├── pyproject.toml         # Project configuration
├── Python.md              # Python coding standards
└── CLAUDE.md              # AI assistant instructions
```