How to work on ezxl locally

Use this guide to create a contributor-ready workspace with the current lint, typing, test, and packaging tooling.

🔧 Prerequisites

• A cloned EzXl repository
• uv installed locally
• Python 3.11 or later

📝 Steps

1. Sync the workspace with all contributor extras.

   pipuv

   pip install -e ".[dev,test,docs]"
   

   uv sync --extra dev --extra test --extra docs
   

2. Install the git hooks managed by pre-commit.

   pipuv

   pre-commit install
   

   uv run pre-commit install
   

3. Run the formatter and linter.

   pipuv

   ruff format .
   ruff check .
   

   uv run ruff format .
   uv run ruff check .
   

4. Run both configured type checkers.

   pipuv

   ty check
   pyright src/
   

   uv run ty check
   uv run pyright src/
   

5. Enforce the import-layer contract.

   pipuv

   lint-imports
   

   uv run lint-imports
   

6. Build the distributable artifacts.

   pipuv

   python -m build
   twine check dist/*
   

   uv build
   uv run twine check dist/*
   

Variations

If you only need the fast code-quality loop during feature work:

pipuv

ruff check . --fix
ty check

uv run ruff check . --fix
uv run ty check

EzXl centralizes runtime-only pywintypes members in compatibility helpers so that ty and pyright can type-check the COM boundary without scattered local workarounds.

If you need to bump the release version:

pipuv

python .scripts/dev/update_version.py 1.2.0

uv run python .scripts/dev/update_version.py 1.2.0

✅ Result

You have a local workspace aligned with the repository tooling, including formatting, linting, type checking, import contract validation, packaging, and installed git hooks.