diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 3 insertions, 3 deletions
@@ -10,7 +10,7 @@ ## Overview -A Python library designed to detect and remove Personally Identifiable Information (PII) from data formats such as CSV, JSON and Parquet formats. +A Python library designed to detect and remove Personally Identifiable Information (PII) from CSV files stored in an AWS S3 bucket. ## Minimum Viable Product (MVP) @@ -18,7 +18,7 @@ The MVP covers: 1. Reading a JSON string containing the S3 location of the CSV file and the names of the fields that are required to be obfuscated 2. Ingesting the CSV file containing data records (with a primary key) from an AWS S3 bucket 3. Obfuscating chosen PII fields (e.g. `name`, `email_address`) by replacing their values with an obfuscated string (`***`) -4. Producing an output CSV file (or a byte-stream) that maintains the original structure but with sensitive fields changed +4. Returning the obfuscated data as a byte-stream that maintains the original structure but with sensitive fields changed This meets the requirements under the General Data Protection Regulation [(GDPR)](https://ico.org.uk/media/for-organisations/guide-to-data-protection/guide-to-the-general-data-protection-regulation-gdpr-1-1.pdf) to ensure that all data containing information that can be used to identify an individual should be anonymised. @@ -34,7 +34,7 @@ This meets the requirements under the General Data Protection Regulation [(GDPR) 1. Clone the repository: ```bash -git clone --recurse-submodules https://github.com/ajschofield/gdpr-obfuscator.git +git clone https://github.com/ajschofield/gdpr-obfuscator.git cd gdpr-obfuscator ``` |