- This repo uses a uniform, reproducible workflow based on uv and pyproject.toml.
- These instructions exist to prevent tool drift (e.g., pip) and OS mismatch.
- Use uv for all environment, dependency, and run commands in this repo.
- Do not recommend or use
pip install ...as the primary workflow. - This repo targets a specific Python version, pinned via uv.
- Commands and guidance must work on Windows, macOS, and Linux.
- If shell-specific commands are unavoidable, provide both:
- PowerShell (Windows)
- bash/zsh (macOS/Linux)
- Install uv using the official method for your OS.
- Keep uv current.
- Pin Python version for this project using uv.
- Sync dependencies (dev + docs) and upgrade.
uv self update
uv python pin 3.15
uv sync --extra dev --extra docs --upgradeRun all commands via uv.
Lint / format:
uv run ruff format .
uv run ruff check .Build documentation:
uv run zensical build- pre-commit runs only on tracked / staged files.
- Developers should
git add -Afiles before expecting hooks to run.