**Note: this repository is obsolete. It has been superseded by pii-extract-base(https://github.com/piisa/pii-extract-base) and pii-extract-plg-regex(https://github.com/piisa/pii-extract-plg-regex)**
-----------------------
# Pii Extractor
This repository builds a Python package that performs PII detection for text
data i.e. extraction of PII (Personally Identifiable Information aka Personal
Data) items existing in the text.
The PII Tasks in the package are structured by language & country, since many
of the PII elements are language- and/or -country dependent.
## Requirements
The package
* needs at least Python 3.8
* needs the pii-data base package
* uses the python-stdnum package to validate identifiers, and needs the
## 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/bigscience` (it will be
created if it does not exist)
## Contributing
To add a new PII processing task, please see the contributing instructions.
Raw data
{
"_id": null,
"home_page": "https://github.com/piisa/pii-extract",
"name": "pii-extract",
"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/3e/36/eed05c0abe2d3cb813df13acfaeaf966d35bb86cf48604d137e6155f3c0e/pii-extract-0.0.2.tar.gz",
"platform": null,
"description": "\n**Note: this repository is obsolete. It has been superseded by pii-extract-base(https://github.com/piisa/pii-extract-base) and pii-extract-plg-regex(https://github.com/piisa/pii-extract-plg-regex)**\n\n-----------------------\n\n# Pii Extractor\n\nThis repository builds a Python package that performs PII detection for text\ndata i.e. extraction of PII (Personally Identifiable Information aka Personal\nData) items existing in the text.\n\nThe PII Tasks in the package are structured by language & country, since many\nof the PII elements are language- and/or -country dependent.\n\n## Requirements\n\nThe package \n * needs at least Python 3.8\n * needs the pii-data base package\n * uses the python-stdnum package to validate identifiers, and needs the \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/bigscience` (it will be\n created if it does not exist)\n\n\n## Contributing\n\nTo add a new PII processing task, please see the contributing instructions.\n\n\n",
"bugtrack_url": null,
"license": "Apache",
"summary": "Extraction of PII from text chunks",
"version": "0.0.2",
"split_keywords": [
"piisa",
" pii"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e36eed05c0abe2d3cb813df13acfaeaf966d35bb86cf48604d137e6155f3c0e",
"md5": "27f1acdc9c3e63f45760e9ce7cbed8b4",
"sha256": "b870c2c53e20f8902658f305c4f57293d83a535d02542d6d9e9eced078bd0dbd"
},
"downloads": -1,
"filename": "pii-extract-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "27f1acdc9c3e63f45760e9ce7cbed8b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 26607,
"upload_time": "2023-01-08T16:22:28",
"upload_time_iso_8601": "2023-01-08T16:22:28.596242Z",
"url": "https://files.pythonhosted.org/packages/3e/36/eed05c0abe2d3cb813df13acfaeaf966d35bb86cf48604d137e6155f3c0e/pii-extract-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-08 16:22:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "piisa",
"github_project": "pii-extract",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "pii-extract"
}
JSON
