https://github.com/kylemclaren/scrub
A Python package to scrub PII
https://github.com/kylemclaren/scrub
pii python sanitization
Last synced: 9 months ago
JSON representation
A Python package to scrub PII
- Host: GitHub
- URL: https://github.com/kylemclaren/scrub
- Owner: kylemclaren
- License: mit
- Created: 2023-04-05T10:04:09.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2023-04-21T10:11:26.000Z (almost 3 years ago)
- Last Synced: 2025-05-26T20:16:01.014Z (10 months ago)
- Topics: pii, python, sanitization
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 24
- Watchers: 2
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
🫧 scrub 🫧
**scrub** is a lightweight, extensible Python package designed to remove Personally Identifiable Information (PII) from any text input. It leverages advanced Machine Learning algorithms to detect PII and provides multiple levels of scrubbing to ensure optimal anonymization of sensitive information. safeguarding user privacy.
## Installation
Install the latest version of scrub from [PyPI](https://pypi.org/project/scrubadubdub/):
```bash
pip install scrubadubdub
```
## Key Features
- Advanced PII detection using Machine Learning algorithms.
- Support for a wide range of PII types (names, email addresses, phone numbers, etc.).
- Customizable detection threshold and levels of sanitization.
- Extensible architecture to allow for the addition of new PII types and algorithms.
## Basic Usage
```python
from scrubadubdub import Scrub
scrubber = Scrub()
input_text = "My name is John Doe and my email address is john.doe@email.com, and my phone number is 123-456-7890"
scrubbed_text = scrubber.scrub(input_text)
print(scrubbed_text)
```
```txt
My name is [REDACTED-NAME] and my email address is [REDACTED-EMAIL], and my phone number is [REDACTED-PHONE]
```
## License
scrub is licensed under the MIT License. See [LICENSE](./LICENSE) for more details.