pyredact-mv 1.0.0

A professional CLI tool to detect and de-identify PII from CSV files.

PyRedact 🛡️

A professional, installable command-line tool to detect and de-identify Personally Identifiable Information (PII) from various file types.

Features

• Multi-Format Support: Scans .csv, .pdf, and .txt files.
• Comprehensive PII Detection: Detects a wide range of global and Indian-specific PII types.
• Flexible Input: Scan a single file or an entire directory of .csv files.
• Selective Scanning: Choose to scan for all PII types or only for specific ones.
• Professional CLI: A user-friendly interface with a startup banner, progress bars, a self-documenting --help menu, and clear error messages.
• Secure and Robust: Handles permission errors and various text encodings automatically.

---

Installation

It is highly recommended to create a dedicated folder and use a virtual environment for a clean and stable experience.

1. Create a Project Folder and Open a Terminal:

   mkdir My-PII-Scans
   cd My-PII-Scans
   

2. Create and Activate a Virtual Environment:

   python -m venv venv
   .\venv\Scripts\Activate.ps1
   

3. Install pyredact from PyPI:

   pip install pyredact
   

   (Note: To install a testing version, use the command pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pyredact)

---

Usage Guide

Once installed, use the pyredact command from your terminal.

Getting Help

To see a full list of all available commands and options, run:

pyredact --help

Example Scenarios

• Scan a single PDF file and save to the default output/ folder:

  pyredact --input C:\Users\YourName\Documents\report.pdf
  

• Scan all .csv files in a specific directory:

  pyredact --input-dir path/to/your/folder_with_csvs
  

• Scan a file for only Emails and PAN Cards:

  pyredact --input data.csv --types "EMAIL,PAN_CARD"
  

• Scan a file and save the results to a custom folder:

  pyredact --input data.txt --output C:/My_Secure_Results
  

• Scan a file with detailed, line-by-line logging:

  pyredact --input sensitive_data.csv --verbose
  

• Scan a file and overwrite any existing output without asking for confirmation:

  pyredact --input sensitive_data.csv --force