Installation¶
pyDIGGS needs Python 3.11 or later on Windows, macOS or Linux. Its only required dependencies are lxml (XML parsing and validation) and rich (coloured console output for the legacy checks).
Install from PyPI¶
Use the published wheels
The PyPI wheels of lxml bundle a current libxml2. Building lxml against an older system libxml2 can change parser behaviour, so prefer the wheels.
Optional extras¶
Install an extra only for the integration you use:
| Extra | Adds | For |
|---|---|---|
server |
FastAPI, Starlette, Pydantic, uvicorn, python-multipart | the HTTP API (pydiggs serve --http) |
mcp |
the official MCP Python SDK (mcp 2.x), python-multipart |
the MCP server (pydiggs serve --mcp) |
The stdio sidecar (pydiggs serve --stdio) needs no extra, and the
container image already contains the server extra.
Exact, tested dependency versions¶
Every GitHub release has a
constraints-X.Y.Z.txt file listing the dependency versions that release was tested
with. Pass it to pip to reproduce them:
Verify a download¶
Releases are published from GitHub Actions with Trusted Publishing and carry PyPI provenance attestations. The security policy shows how to check a wheel's digest and attestation.
Install from source¶
To work on pyDIGGS itself, clone the repository and sync with uv:
git clone https://github.com/xinp-hub/pydiggs.git
cd pydiggs
uv sync --all-groups
uv run pydiggs --version
See Contributing for the full development workflow.