Installation

Requirements

• Python 3.11+
• uv (recommended) or pip

Install the core

The core has no optional dependency. It is enough for a local pipeline that de-identifies by regex or by known values, with no model and no network.

Install it with uv, or with pip.

uv add piighost

pip install piighost

Extras

Model-based detectors, the middleware, and the optional backends are extras to combine as needed. The full list is in pyproject.toml.

uv add "piighost[gliner2]"     # GLiNER2 NER detector
uv add "piighost[langchain]"   # LangChain/LangGraph middleware
uv add "piighost[all]"         # every extra

pip install "piighost[gliner2]"
pip install "piighost[langchain]"
pip install "piighost[all]"

Extras compose. An encrypted Redis conversation memory installs with piighost[redis,crypto]. Add the argon2 extra for a more resistant key hash.

Check the installation

Print the installed version.

uv run python -c "import piighost; print(piighost.__version__)"

python -c "import piighost; print(piighost.__version__)"

The command prints a version number, such as 2.0.0. An ImportError means the package is not installed in the active environment.

See also

• Quickstart for a first try without a model.
• Contributing to clone the repository, run the tests and the checks.