package_name

package_description

Development

Environment Setup

uv venv
uv sync
.venv\Scripts\activate

official installation guide for uv

Development Tools

some short text here

Pre-commit

# Update pre-commit hooks
pre-commit autoupdate 
# Install pre-commit hooks 
pre-commit install
# Run pre-commit hooks on all files without committing
pre-commit run --all-files

Pytest

# Run all tests
pytest
# Run tests in a specific file
pytest path/to/test_file.py
# Run a specific test function
pytest path/to/test_file.py::test_function

Ruff

# Check for linting errors and formatting issues
ruff check .
# Format code
ruff format .
# Fix linting errors automatically (use with caution)
ruff check . --fix

Mypy

# Run type checking
mypy .