v1.0.1

Added json data masking

v1.0.0

Release Notes for PII Masking Tool

Version 1.0.0 (2024-10-10)

Initial Release

• Overview: Introduced a tool for masking Personally Identifiable Information (PII) such as phone numbers, email addresses, and IP addresses in text documents.

Features

• Mask Class:
  • mask_text: Method to mask PII in a given text string using regex patterns and SpaCy's Named Entity Recognition.
  • mask_nlp: Utilizes SpaCy to identify and mask entities in the text.
  • mask_file: Method to read a text file, apply PII masking, and return the masked content.

Usage Examples

• Text Masking:

  • Demonstrated how to create an instance of the Mask class and use mask_text to mask PII in a string.

• File Masking:

  • Provided an example of using the mask_file method to read and mask PII from a text file.

Installation

• Instructions for installing required libraries, including SpaCy and the English language model.

Documentation

• Comprehensive README with details on installation, usage, and examples for both methods.

Future Releases

• Plans for enhancements, including support for additional PII types and improved masking algorithms.