Skip to content

Latest commit

 

History

History
21 lines (17 loc) · 1001 Bytes

File metadata and controls

21 lines (17 loc) · 1001 Bytes

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Build/Lint/Test Commands

  • Run all tests: pytest
  • Run a single test: pytest tests/path/to/test_file.py::test_function_name -v
  • Format code: ruff format
  • Lint code: ruff check --fix
  • Type check: mypy --exclude tests/test_package src tests

Code Style Guidelines

  • Formatting: Follow Google style convention. Use ruff for formatting
  • Imports: Use isort order (enforced by ruff)
  • Types: Strict typing is required. All functions must have type annotations
  • Naming: Use snake_case for variables, functions, methods; PascalCase for classes
  • Docstrings: Google-style docstrings required for public APIs
  • Error Handling: Use appropriate exception types; include context in error messages
  • Testing: Write tests with pytest; maintain high coverage

Respect existing code patterns when modifying files. Run linting before committing changes.