Getting Started¶

This guide will help you set up your development environment and get started with the project.

Prerequisites¶

Python 3.13+
uv package manager

Installation¶

1. Clone the Repository¶

git clone https://github.com/YOUR_USERNAME/fastapi-tools.git
cd fastapi-tools

2. Install Dependencies¶

# Install all dependencies (including dev tools)
uv sync --group dev

# Or install specific groups
uv sync --group test    # Testing only
uv sync --group lint    # Linting only
uv sync --group docs    # Documentation only

3. Verify Installation¶

# Run tests
uv run pytest

# Check code style
uv run ruff check .

# Type checking
uv run pyright

Development Workflow¶

Running Tests¶

uv run pytest
uv run pytest -v              # Verbose output
uv run pytest tests/config/   # Run specific test directory

Code Quality¶

# Lint and format
uv run ruff check .
uv run ruff format .

# Type checking
uv run pyright

Pre-commit Hooks¶

Pre-commit hooks are configured to run automatically on each commit:

# Install hooks (first time only)
uv run pre-commit install

# Run manually on all files
uv run pre-commit run --all-files

Environment Configuration¶

The project expects environment variables to be stored in ~/cred/fastapi_tools/.env.

Security

Never commit .env files or secrets to the repository.

Building Documentation¶

# Install docs dependencies
uv sync --group docs

# Start local server with hot reload
uv run mkdocs serve

# Build static site
uv run mkdocs build

Renaming the Project¶

Use the included renaming utility to customize the project for your needs:

uv run rename-project

See the meta README for detailed instructions.