Skip to content

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

# Just the command line tool, in its own environment
uv tool install pydiggs
pydiggs --version

# Or as a dependency of your project (import it from your code)
uv add pydiggs
uv run pydiggs --version    # project commands run through uv run
python -m pip install pydiggs    # into the active environment
pydiggs --version

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)
uv add "pydiggs[server]"
python -m pip install "pydiggs[server]"

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:

python -m pip install "pydiggs[server]==X.Y.Z" -c constraints-X.Y.Z.txt

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.