Installation¶

Requirements¶

Python 3.11 or later
PyYAML (installed automatically as a dependency)
The phisql package, which supplies the catalog of policy actions — the single source of truth for the available redaction strategies and the entity-type field mappings used by policies. It installs automatically as a dependency.

The phisql catalog dependency¶

phileas depends on the phisql package. The PhiSQL catalog defines every valid policy action (strategy) and the field names each entity type uses in a policy, so phileas reads them from the catalog rather than from hand-coded classes.

phisql installs automatically with phileas; nothing extra is needed.

Install from PyPI¶

pip install phileas-redact

Install in development mode¶

Clone the repository and install with the dev extras to get the testing dependencies:

git clone https://github.com/philterd/phileas-python.git
cd phileas-python
pip install -e ".[dev]"

Verify the installation¶

from phileas.services.filter_service import FilterService
from phileas.policy.policy import Policy

service = FilterService()
policy = Policy.from_dict({
    "name": "test",
    "identifiers": {
        "emailAddress": {
            "emailAddressFilterStrategies": [{"strategy": "REDACT"}]
        }
    }
})
result = service.filter(policy, "ctx", "doc-1", "hello@example.com")
print(result.filtered_text)  # {{{REDACTED-email-address}}}

Building the documentation locally¶

The documentation uses MkDocs. Install MkDocs and serve the docs locally:

pip install mkdocs
mkdocs serve

Then open http://127.0.0.1:8000 in your browser.

To build a static site:

mkdocs build

The output is placed in the site/ directory.