datamask
Mask sensitive data in a PostgreSQL database (PII/PHI) for development/testing purposes.
Uses native PostgreSQL operations for masking - no data leaves the database.
Installation
pip install datamask
Usage
1. Create a data dictionary
Generate a CSV data dictionary from your database schema:
datadict 'postgresql://<user>:<password>@<host>/<database>' <schema> my_pii_dd.csv
Edit the CSV and set pii to yes for columns that need masking, and pii_type to one of the
available faker types. Run datamask -l to list all available fakers.
2. Mask the data
datamask -d 'postgresql://<user>:<password>@<host>/<database>' -f my_pii_dd.csv
3. Updating the data dictionary
When your schema changes, regenerate the data dictionary using your existing one as a seed:
datadict 'postgresql://<user>:<password>@<host>/<database>' <schema> -i my_existing_dd.csv my_new_pii_dd.csv
Advanced options
Skip specific rows from masking using --keep with a YAML file:
# keep.yaml
schema.table_name:
- pk_value_1
- pk_value_2
Set fixed values for specific rows using --fixed with a YAML file:
# fixed.yaml
schema.table_name:
pk_value:
column_name: "fixed value"
Available fakers
Run datamask -l to see all available faker types. Includes: person_name, person_firstname,
person_familyname, email, address, city, zipcode, phonenumber, business_name,
username, password, url, url_image, inet_addr, text, text_short, filename,
slug, serial, int, tla, user_agent, static_str, null.
Caveats
Never run this against a production database. I'm not responsible for your data.
License
MIT License - Copyright (c) 2021, Fredrik Håård
Metadata
Release files for datamask 3.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| datamask-3.0.0.tar.gz | 8.0 kB | Without provenance | Details for datamask-3.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| datamask-3.0.0-py3-none-any.whl | Python 3 | none | any | Details for datamask-3.0.0-py3-none-any.whl |
Total release size: 17.2 kB
Release files / datamask-3.0.0.tar.gz
| Download URL | datamask-3.0.0.tar.gz |
|---|---|
| Size | 8.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4c322bcb1b56b3e1b1f219bf229e37c5269accbfd532befea354504189bf2ea1
|
|
BLAKE2b-256 checksum How to use checksums |
cd7743a9bf3cfd0940cf584be44f1f26f7864ffd6344a1bc27e76cd9726eb980
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.3 CPython/3.11.6 Linux/6.6.87.2-microsoft-standard-WSL2
|
Release files / datamask-3.0.0-py3-none-any.whl
| Download URL | datamask-3.0.0-py3-none-any.whl |
|---|---|
| Size | 9.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4372caf1c1adc4d58c6b7efb0166bfd033e2b3994dc5153f5d697b5d9a24fcff
|
|
BLAKE2b-256 checksum How to use checksums |
33ed3097f55bc74a1685032aef7bd70b06abb2aebb9ec7e6c80dce65ce0ecbf9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.3 CPython/3.11.6 Linux/6.6.87.2-microsoft-standard-WSL2
|
Security for datamask 3.0.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.