campus-api-schema

Common specification for the Campus API Schema

Development Tooling

This project uses the following development tools:

• pytest: Testing framework
• pyright: Static type checker
• ruff: Fast Python linter and formatter

Git Hooks

• pre-commit: Automatically runs ruff format to auto-format code
• pre-push: Runs ruff check to lint code before pushing

Installation

poetry install --with dev

Running Tools

# Format code
poetry run ruff format .

# Lint code
poetry run ruff check .

# Run type checking
poetry run pyright

# Run tests
poetry run pytest