# Pii Extract Base
This repository builds a Python package providing a base library for PII
detection for Source Documents i.e. extraction of PII (Personally Identifiable
Information aka Personal Data) items existing in the document.
The package itself does **not** implement any PII Detection tasks, it only
provides the base infrastructure for the process. Detection tasks must be
supplied externally.
## Requirements
The package needs
* at least Python 3.8
* the pii-data base package
* one or more pii-extract plugins (to actually do real detection work)
## Usage
The package can be used:
* As an API, in two flavors: function-based API and object-based API
* As a command-line tool
For details, see the usage document.
## Building
The provided Makefile can be used to process the package:
* `make pkg` will build the Python package, creating a file that can be
installed with `pip`
* `make unit` will launch all unit tests (using pytest, so pytest must be
available)
* `make install` will install the package in a Python virtualenv. The
virtualenv will be chosen as, in this order:
- the one defined in the `VENV` environment variable, if it is defined
- if there is a virtualenv activated in the shell, it will be used
- otherwise, a default is chosen as `/opt/venv/pii` (it will be
created if it does not exist)
Raw data
{
"_id": null,
"home_page": "https://github.com/piisa/pii-extract-base",
"name": "pii-extract-base",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "PIISA, PII",
"author": "Paulo Villegas",
"author_email": "paulo.vllgs@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/78/dd/ab5ddf307eb112d547b9a71090d92f6f5d4902a2d25cf4353367499acb2d/pii-extract-base-0.7.0.tar.gz",
"platform": null,
"description": "# Pii Extract Base\n\n\nThis repository builds a Python package providing a base library for PII \ndetection for Source Documents i.e. extraction of PII (Personally Identifiable\nInformation aka Personal Data) items existing in the document.\n\nThe package itself does **not** implement any PII Detection tasks, it only\nprovides the base infrastructure for the process. Detection tasks must be\nsupplied externally.\n\n\n## Requirements\n\nThe package needs\n * at least Python 3.8\n * the pii-data base package\n * one or more pii-extract plugins (to actually do real detection work)\n\n## Usage\n\nThe package can be used:\n * As an API, in two flavors: function-based API and object-based API\n * As a command-line tool\n\nFor details, see the usage document.\n\n\n## Building\n\nThe provided Makefile can be used to process the package:\n * `make pkg` will build the Python package, creating a file that can be\n installed with `pip`\n * `make unit` will launch all unit tests (using pytest, so pytest must be\n available)\n * `make install` will install the package in a Python virtualenv. The\n virtualenv will be chosen as, in this order:\n - the one defined in the `VENV` environment variable, if it is defined\n - if there is a virtualenv activated in the shell, it will be used\n - otherwise, a default is chosen as `/opt/venv/pii` (it will be\n created if it does not exist)\n\n\n\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "Extraction of PII from text chunks",
"version": "0.7.0",
"project_urls": {
"Download": "https://github.com/piisa/pii-extract-base/tarball/v0.7.0",
"Homepage": "https://github.com/piisa/pii-extract-base"
},
"split_keywords": [
"piisa",
" pii"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "78ddab5ddf307eb112d547b9a71090d92f6f5d4902a2d25cf4353367499acb2d",
"md5": "d2bcd9d24d49018e251c04a7fee8f9d8",
"sha256": "e2f74859d3f1159981db69a4f8a60663f82ee576de5a98cd0025a80cda7e7947"
},
"downloads": -1,
"filename": "pii-extract-base-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "d2bcd9d24d49018e251c04a7fee8f9d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 33512,
"upload_time": "2024-01-07T21:06:56",
"upload_time_iso_8601": "2024-01-07T21:06:56.058038Z",
"url": "https://files.pythonhosted.org/packages/78/dd/ab5ddf307eb112d547b9a71090d92f6f5d4902a2d25cf4353367499acb2d/pii-extract-base-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-07 21:06:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "piisa",
"github_project": "pii-extract-base",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "pii-extract-base"
}
JSON
