Skip to main content

scrubadub

Remove personally identifiable information from free text. Sometimes we have additional metadata about the people we wish to anonymize. Other times we don’t. This package makes it easy to seamlessly scrub personal information from free text, without compromising the privacy of the people we are trying to protect.

scrubadub currently supports removing:

  • Names

  • Email addresses

  • Addresses/Postal codes (US, GB, CA)

  • Credit card numbers

  • Dates of birth

  • URLs

  • Phone numbers

  • Username and password combinations

  • Skype/twitter usernames

  • Social security numbers (US and GB national insurance numbers)

  • Tax numbers (GB)

  • Driving licence numbers (GB)

Build Status Version Downloads Test Coverage Documentation Status

Quick start

Getting started with scrubadub is as easy as pip install scrubadub and incorporating it into your python scripts like this:

>>> import scrubadub

# My cat may be more tech-savvy than most, but he doesn't want other people to know it.
>>> text = "My cat can be contacted on example@example.com, or 1800 555-5555"

# Replaces the phone number and email addresse with anonymous IDs.
>>> scrubadub.clean(text)
'My cat can be contacted on {{EMAIL}}, or {{PHONE}}'

There are many ways to tailor the behavior of scrubadub using different Detectors and PostProcessors. Scrubadub is highly configurable and supports localisation for different languages and regions.

Installation

To install scrubadub using pip, simply type:

pip install scrubadub

There are several other packages that can optionally be installed to enable extra detectors. These scrubadub_address, scrubadub_spacy and scrubadub_stanford, see the relevant documentation (address detector documentation and name detector documentation) for more info on these as they require additional dependencies. This package requires at least python 3.6. For python 2.7 or 3.5 support use v1.2.2 which is the last version with support for these versions.

New maintainers

LeapBeyond are excited to be supporting scrubadub with ongoing maintenance and development. Thanks to all of the contributors who made this package a success, but especially @deanmalmgren, IDEO and Datascope.

Release files for scrubadub 2.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scrubadub 2.0.1
File Size Uploaded
scrubadub-2.0.1.tar.gz 46.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scrubadub 2.0.1
File Interpreter ABI Platform
scrubadub-2.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 111.8 kB

Release files / scrubadub-2.0.1.tar.gz

Download URL scrubadub-2.0.1.tar.gz
Size 46.6 kB
Tags Source
SHA-256 checksum
How to use checksums
52a1fb8aa9bc0226043e02c3ec22d450bd4ebeede9e7e8db2def7c89b37c5aad
BLAKE2b-256 checksum
How to use checksums
6f24f56c1b27689eff1809791b37660a9b1687ddfb157c0e380114245d67af1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release files / scrubadub-2.0.1-py3-none-any.whl

Download URL scrubadub-2.0.1-py3-none-any.whl
Size 65.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
44b9004998a03aff4c6b5d9073a52895081742f994470083a7be610b373e62b7
BLAKE2b-256 checksum
How to use checksums
f4c504b959566c85914b17327e40d25b0535b0209a5a5216006443b769bebe25
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Release history Release notifications | RSS feed

This release

2.0.1 This release

2 release files

2.0.0

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2.0

1 release file

1.1.1

1 release file

1.1.0

1 release file

1.0.3

1 release file

1.0.2

1.0.1

1 release file

1.0.0

1 release file

0.1.0

1 release file

0.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page