---
icon: lucide/download
---

# Installation

## Requirements

- Python 3.11+
- [uv](https://docs.astral.sh/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"

    ```bash
    uv add piighost
    ```

=== "pip"

    ```bash
    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"

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

=== "pip"

    ```bash
    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"

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

=== "pip"

    ```bash
    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](quickstart.md) for a first try without a model.
- [Contributing](../community/contributing.md) to clone the repository, run the tests and the checks.