Skip to content

LOCAL_SETUP.md

Latest commit

 

History

History
36 lines (24 loc) · 1.4 KB

LOCAL_SETUP.md

File metadata and controls

36 lines (24 loc) · 1.4 KB

New Project Setup

See README.md for step-by-step details on installing the pii-codex package as an import.

Video Demo of package import and usage:

PII-Codex Video Demo

Note: This video has no sound, it just shows steps taken to install the package and use it in a file.

Local Repo Setup

For those contributing or modifying the source, use the following to set up locally.

Environment Config

You'll need Python (^3.11) and uv configured on your machine. Once those are configured, create a virtual environment and install dependencies.

uv sync

Installing dependencies will vary by usage. For those in need of the PII-Codex integration of the MSFT Presidio Analyzer, it is recommended to install the detections extras:

uv sync --extra detections

As part of the detections extras installation, the download for the en_core_web_lg spaCy model will be enabled on first use of the PresidioPIIAnalyzer(). If more language support is needed, you'll need to download it separately. Reference explosion/spacy-models.

Depending on your setup and need, you may need to add the virtual environment to Jupyter. You may do so with the following command:

make jupyter.attach.venv