Protegrity Developer Edition – pty-discover

Welcome to the pty-discover repository, part of the Protegrity Developer Edition suite. This repository provides a self-contained experimentation platform for discovering and protecting sensitive data using Protegrity’s Data Discovery and Protection APIs.

🚀 Overview

This repository enables developers to:

• Rapidly set up a local environment using Docker Compose.
• Experiment with unstructured text classification and PII redaction.
• Integrate Protegrity APIs into GenAI and traditional applications.
• Use sample applications and data to understand integration workflows.

📦 Repository Structure

.
├── Jenkinsfile
├── README.md
├── docker-compose.yml
└── samples
    ├── config.json
    ├── requirements.txt
    ├── sample-data
    │   └── sample-find-redact.txt
    └── sample.py

🧰 Features

• Data Discovery: REST-based classification of unstructured text using Presidio.
• Data Protection: Integration with mock REST Container for redaction/masking.
• Sample App: Demonstrates how to use the SDK to find and redact PII.
• Cross-platform: Works on Linux, Windows, and MacOS.

🛠️ Getting Started

Prerequisites

• Docker & Docker Compose
• Git

Setup Instructions

git clone https://github.com/protegrity/pty-discover.git cd pty-discover docker compose up

Run Sample

python samples/sample.py

This will read sample-find-redact.txt, classify and redact PII, and write the output to output.txt.

📄 Configuration

Edit samples/config.json to customize:

• API endpoint
• Named entity mappings
• Redaction method (redact or mask)
• Classification score threshold

📚 Documentation

• Full documentation is available at https://docs.protegrity.com
• For API reference and tutorials, visit the Developer Portal at https://www.protegrity.com/developer

🧪 Sample Use Case

Use this repo to build GenAI applications like chatbots that:

• Detect PII in prompts using the classifier
• Redact or mask sensitive data before processing

🧱 Architecture

• Presidio Classifier: Detects PII in unstructured text
• Python Module: Provides easy integration for developers

📢 Community & Support

• Join the discussion on https://github.com/protegrity/pty-discover/discussions
• Anonymous downloads supported; registration required for participation.

📜 License

See ./LICENSE for terms and conditions.