Metadata-Version: 2.1
Name: pii-transform
Version: 0.7.0
Summary: Transform recognized PII instances in a document
Home-page: https://github.com/piisa/pii-transform
Download-URL: https://github.com/piisa/pii-transform/tarball/v0.7.0
Author: Paulo Villegas
Author-email: paulo.vllgs@gmail.com
License: Apache
Keywords: PIISA, PII
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: e2e
License-File: LICENSE

# pii-transform



This package takes a source document, a collection of detected PII instances,
and transforms the document by replacing the PII instances in the document
with a different representation.

The type of substitution done is defined by transformation policies.

Note: `pii-transform` does **not** implement or use Transformer models for PII
purposes (for the extraction of PII instances using Transformer models, see
pii-extract-plg-transformers or pii-extract-plg-presidio).


## Command-line script

The package provides a console script: `pii-transform` loads a source document
& a collection of already-detected PII, and produces a transformed document
following the specified policies.


## API

The same functionality provided by the command-line script can also be
accessed via a Python API


## End-to-end workflow

The end-to-end scripts and APIs have been migrated; they are now in the
`pii-process` package. That one is also the module to use to process generic
documents, since this package supports only the PIISA Source Document
format, which contains the document written as a YAML file.



