push to pre-release branch (#20) (#21)

Co-authored-by: protegrity-gheuser <protegrity.gheuser@protegrity.com>
Co-authored-by: protegrity-gheuser <protegrity-gheuser@protegrity.com>

Author: 3 people

CHANGELOG.md

@@ -2,7 +2,84 @@
 
 All notable changes to the Protegrity Developer Edition Python project will be documented in this file.
 
-## [1.0.0] - Current Release
+## [1.1.0] - 2025-12-15
+
+### 🎉 Major New Features
+
+#### Semantic Guardrails v1.1.0 SDK Support
+- **Enhanced Risk Scoring**: Updated SDK to support Semantic Guardrails v1.1.0 with improved risk assessment capabilities
+- **Vertical-Specific Models**: Added support for Finance and Healthcare industry-specific models
+- **Multi-turn Conversation Support**: Enhanced PII scanning and risk scoring across conversation history
+- **Improved API Interface**: Streamlined SDK interface for semantic guardrail operations
+
+#### Data Discovery Enhancements
+- **Harmonized Classifications**: Support for categorized "harmonized" entity classifications
+- **Entity Mapping Updates**: Updated entity-to-data-element mapping to align with Data Discovery v1.1.1
+- **Improved Accuracy**: Enhanced classification accuracy and confidence scoring
+- **Overlapping Labels**: Fixed ordering logic for overlapping classification labels 
+
+#### Conda Package Support (NEW)
+- **Conda Recipe**: Added `conda-recipe/` directory with complete build configuration
+- **Cross-Platform Distribution**: Support for conda package distribution across platforms
+- **Meta.yaml Configuration**: Comprehensive conda package metadata and dependencies
+
+### 🏗️ Architecture & Structure Changes
+
+#### Repository Structure Enhancements
+- **Conda Recipe Directory**: New `conda-recipe/` with build scripts and metadata
+- **Enhanced Test Structure**: Improved test organization and expected outputs
+- **Configuration Updates**: Removed hardcoded endpoint URLs from `mapping_config.json`
+
+#### SDK Interface Improvements
+- **Cleaner APIs**: Simplified method signatures for semantic guardrail operations
+- **Better Error Handling**: Enhanced error messages and exception handling
+- **Type Hints**: Improved type annotations for better IDE support
+
+### 🔧 Enhanced Configuration & Service Features
+
+#### Configuration Updates
+- **Dynamic Endpoint Configuration**: Removed hardcoded `endpoint_url` from mapping configuration
+- **Flexible Mapping**: Enhanced entity mapping configuration options
+- **Environment-Based Config**: Better support for environment-specific configurations
+
+#### Testing Improvements
+- **Updated Test Outputs**: Refreshed expected test outputs to match Data Discovery 1.1.1 entity names and patterns
+- **Semantic Guardrails Unit Tests**: Updated unit tests for v1.1.0 compatibility
+- **Better Test Coverage**: Expanded test scenarios for new features
+
+### 📚 Documentation & Developer Experience
+
+#### README Enhancements
+- **"Why This Matters" Section**: Added context about the importance of data protection
+- **Improved Examples**: More comprehensive code examples and use cases
+- **Better Prerequisites**: Clearer setup instructions and dependency documentation
+
+#### Developer Guidance
+- **Conda Installation**: New installation method via conda packages
+- **API Documentation**: Enhanced inline documentation and docstrings
+- **Migration Notes**: Guidance for upgrading from 1.0.0 to 1.1.0
+
+### 🔄 Dependencies
+- **Updated Requirements**: Refreshed `requirements.txt` with compatible versions
+- **Conda Dependencies**: Added conda-specific dependency management
+- **Python Version**: Maintained Python 3.12.11+ requirement
+
+### 🔐 Security
+- **Dependency Updates**: Updated to latest secure versions of dependencies
+- **Vulnerability Fixes**: Applied security patches as needed
+
+### ⚠️ Breaking Changes
+- **Configuration Schema**: Removed `endpoint_url` from `mapping_config.json` - endpoints are now dynamically determined
+- **Entity Mapping**: Updated entity names and patterns to match Data Discovery 1.1.1 - may require configuration updates for custom mappings
+
+### 📦 Distribution
+- **PyPI Package**: Available as `protegrity-developer-python` v1.1.0
+- **Conda Package**: New distribution channel via conda (coming soon)
+- **Wheel Distribution**: Pre-built wheel available for quick installation
+
+---
+
+## [1.0.0] - 2025-09-30
 
 ### 🎉 Major New Features
 
@@ -93,15 +170,11 @@ All notable changes to the Protegrity Developer Edition Python project will be d
 
 ---
 
-## [Previous Release] - README1.md Baseline
+## [Previous Release] - README.md Baseline
 
 ### Features (Baseline)
 - Basic Find and Redact functionality
 - Single module structure (`protegrity_developer_python`)
 - Python 3.9.23 support
 - Basic configuration options
 - Simple repository structure
-
----
-
-*Note: This changelog reflects the transition from the previous single-module approach to the current dual-module architecture with enhanced protection capabilities.*

README.md

@@ -1,12 +1,14 @@
 <div align="center">
 
 # Protegrity Developer Edition Python
-[![Version](https://img.shields.io/badge/version-1.0.0-green.svg?style=flat)](https://github.com/Protegrity-Developer-Edition/protegrity-developer-python/releases)
+[![Version](https://img.shields.io/badge/version-1.1.0-green.svg?style=flat)](https://github.com/Protegrity-Developer-Edition/protegrity-developer-python/releases)
 [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat)](https://github.com/Protegrity-Developer-Edition/protegrity-developer-python/blob/main/LICENSE)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg?style=flat)](https://www.python.org/downloads/)
 [![Linux](https://img.shields.io/badge/Linux-FCC624?style=flat&logo=linux&logoColor=black)](https://www.linux.org/)
 [![Windows](https://img.shields.io/badge/Windows-0078D6?style=flat&logo=windows&logoColor=white)](https://www.microsoft.com/windows/)
 [![macOS](https://img.shields.io/badge/mac%20os-000000?style=flat&logo=macos&logoColor=F0F0F0)](https://www.apple.com/macos/)
+[![PyPI 1.1.0](https://img.shields.io/pypi/v/protegrity-developer-python.svg)](https://pypi.org/project/protegrity-developer-python/)
+[![Anaconda 1.1.0](https://anaconda.org/protegrity/protegrity-developer-python/badges/version.svg?style=flat)](https://anaconda.org/protegrity/protegrity-developer-python)
 [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Protegrity-Developer-Edition/protegrity-developer-python)
 </div>
 
@@ -18,6 +20,7 @@ Customize, compile, and use the module as per your requirement.
 ## Table of Contents
 
 1. [Overview](#overview)
+    - [Why This Matters](#why-this-matters)
 2. [Repository Structure](#repository-structure)
 3. [Features](#features)
     - [Protegrity Developer Python](#Protegrity-Developer-Python)
@@ -44,6 +47,17 @@ This repository contains two powerful modules designed to handle different aspec
 - **protegrity_developer_python** - Focuses on data discovery, classification, and redaction of Personally Identifiable Information (PII) in unstructured text
 - **appython** - Provides comprehensive data protection and unprotection capabilities for structured data
 
+#### Why This Matters
+
+Sensitive data shows up in more places than you'd expect — logs, payloads, prompts, training sets, and unstructured text. This Python module gives you tools to find and protect that data using tokenization, masking, and discovery — whether it's in an AI pipeline or a local script. No infrastructure, no UI, just code.
+
+- **Developer-first experience:** Open APIs, sample apps, and modular design make it easy to embed data discovery and protection into any Python project. 
+
+- **Accelerate innovation:** Prototype and validate data discovery and protection strategies in a lightweight, containerized sandbox. 
+
+- **Enable responsible AI:** Protect sensitive information in training data, prompts, and outputs for GenAI and machine learning workflows. 
+
+- **Simplify compliance:** Meet regulatory requirements for data privacy with built-in detection and protection capabilities.
 
 ## Repository Structure
 
@@ -63,6 +77,7 @@ This repository contains two powerful modules designed to handle different aspec
 │   └── protegrity_developer_python
 │       ├── __init__.py
 │       ├── securefind.py
+│       ├── scan.py
 │       └── utils
 └── tests
     ├── e2e
@@ -77,7 +92,8 @@ This repository contains two powerful modules designed to handle different aspec
         │   ├── bulk
         │   ├── mock
         │   └── single
-        └── find_and_secure
+        ├── find_and_secure     
+        └── semantic_guardrail
 
 ```
 
@@ -91,6 +107,7 @@ This repository contains two powerful modules designed to handle different aspec
 | **Find and Protect**   | Classifies and protects Personally Identifiable Information (PII) in unstructured text using Protegrity protection policies.        |
 | **Find and Unprotect** | Restores original Personally Identifiable Information (PII) data from its protected form.                                           |
 | **Cross-Platform Support** | Compatible with **Linux**, **Windows**, and **MacOS**.                                   |
+| **Semantic Guardrail Support** | Scan conversations for PII and risk using Semantic Guardrail API.                     |
 
 ### Application Protector Python
 
@@ -162,8 +179,8 @@ For setup instructions, please refer to the documentation [here](https://github.
 import protegrity_developer_python
 
 protegrity_developer_python.configure(
-    endpoint_url="http://localhost:8580/pty/data-discovery/v1.0/classify",
-    named_entity_map={"PERSON": "NAME", "SOCIAL_SECURITY_NUMBER": "SSN"},
+    endpoint_url="http://localhost:8580/pty/data-discovery/v1.1/classify",
+    named_entity_map={"PERSON": "NAME", "SOCIAL_SECURITY_ID": "SSN"},
     masking_char="#",
     classification_score_threshold=0.6,
     method="redact",
@@ -182,8 +199,8 @@ print(output_text)
 import protegrity_developer_python
 
 protegrity_developer_python.configure(
-    endpoint_url="http://localhost:8580/pty/data-discovery/v1.0/classify",
-    named_entity_map={"PERSON": "NAME", "SOCIAL_SECURITY_NUMBER": "SSN"},
+    endpoint_url="http://localhost:8580/pty/data-discovery/v1.1/classify",
+    named_entity_map={"PERSON": "NAME", "SOCIAL_SECURITY_ID": "SSN"},
     masking_char="#",
     classification_score_threshold=0.6,
     method="redact",
@@ -202,8 +219,8 @@ print(output_text)
 import protegrity_developer_python
 
 protegrity_developer_python.configure(
-    endpoint_url="http://localhost:8580/pty/data-discovery/v1.0/classify",
-    named_entity_map={"PERSON": "NAME", "SOCIAL_SECURITY_NUMBER": "SSN"},
+    endpoint_url="http://localhost:8580/pty/data-discovery/v1.1/classify",
+    named_entity_map={"PERSON": "NAME", "SOCIAL_SECURITY_ID": "SSN"},
     masking_char="#",
     classification_score_threshold=0.6,
     method="redact",
@@ -212,7 +229,7 @@ protegrity_developer_python.configure(
 )
 
 #Pass the output received from find and protect
-input_text = "[PERSON]7ro8 lfU'I[/PERSON] SSN is [SOCIAL_SECURITY_NUMBER]616-16-2210[/SOCIAL_SECURITY_NUMBER]."
+input_text = "[PERSON]7ro8 lfU'I[/PERSON] SSN is [SOCIAL_SECURITY_ID]616-16-2210[/SOCIAL_SECURITY_ID]."
 output_text = protegrity_developer_python.find_and_unprotect(input_text)
 print(output_text)
 ```
@@ -266,6 +283,9 @@ print("Unprotected Data:%s "%unprotected_data)
 
 - [Protegrity Developer Edition documentation](http://developer.docs.protegrity.com/)
 - For API reference and tutorials, visit [Developer Portal](https://www.protegrity.com/developers)
+- For more information about Data Discovery, refer to the [Data Discovery documentation]( https://docs.protegrity.com/data-discovery/1.1.1/docs/).
+- For more information about Semantic Guardrails, refer to the [Semantic Guardrails documentation]( https://docs.protegrity.com/sem_guardrail/1.1.0/docs/).
+- For more information about Application Protector Python, refer to the [Application Protector Python documentation]( https://docs.protegrity.com/10.0/protectors/application_protector/ap_python/).
 
 ## Sample Use Case
 

conda-recipe/bld.bat

@@ -0,0 +1,3 @@
+REM Install the package using pip
+%PYTHON% -m pip install . -vv
+if errorlevel 1 exit 1

conda-recipe/build.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+# Install the package using pip
+$PYTHON -m pip install . -vv

conda-recipe/meta.yaml

@@ -0,0 +1,53 @@
+{% set name = "protegrity-developer-python" %}
+{% set version = "1.1.0" %}
+
+package:
+  name: {{ name|lower }}
+  version: {{ version }}
+
+source:
+  # Building from local source
+  path: ..
+
+build:
+  number: 0
+  noarch: python
+
+requirements:
+  host:
+    - python >=3.12.11
+    - pip
+    - setuptools >=61.0
+  run:
+    - python >=3.12.11
+    - requests
+
+test:
+  imports:
+    - protegrity_developer_python
+    - appython
+  commands:
+    - pip check
+  requires:
+    - pip
+
+about:
+  home: https://www.protegrity.com/developers
+  license: MIT
+  license_family: MIT
+  license_file: LICENSE
+  summary: Python module for integrating Protegrity's Data Discovery and Protection APIs into GenAI and traditional applications
+  description: |
+    This repository contains two powerful modules designed to handle different aspects of data protection:
+    
+    - protegrity_developer_python - Focuses on data discovery, classification, and redaction of 
+      Personally Identifiable Information (PII) in unstructured text
+    - appython - Provides comprehensive data protection and unprotection capabilities for structured data
+    
+    Part of the Protegrity Developer Edition suite for integrating Protegrity's APIs into applications.
+  doc_url: http://developer.docs.protegrity.com
+  dev_url: https://github.com/Protegrity-Developer-Edition/protegrity-developer-python
+
+extra:
+  recipe-maintainers:
+    - Protegrity

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "protegrity-developer-python"
-version = "1.0.0"
+version = "1.1.0"
 description = "Python module for integrating Protegrity's Data Discovery and Protection APIs into GenAI and traditional applications."
 authors = [{ name = "Protegrity", email="info@protegrity.com" }]
 requires-python = ">=3.12.11"

requirements.txt

@@ -12,4 +12,5 @@ attrs==25.3.0
 requests==2.32.4
 python-dotenv==1.1.1
 pytest-html==4.1.1
-pytest-metadata==3.1.1
+pytest-metadata==3.1.1
+pydantic==2.12.4

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = protegrity-developer-python
-version = 1.0.0
+version = 1.1.0
 author = Protegrity
 author_email = info@protegrity.com
 license = MIT

src/appython/protector.py

@@ -78,7 +78,7 @@ def get_version(self):
             protector.get_version()
 
         """
-        return "1.0.0"
+        return "1.1.0"
 
     def get_version_ex(self):
         """Returns the extended version of the AP Python in use.
@@ -97,7 +97,7 @@ def get_version_ex(self):
             protector.get_version_ex()
 
         """
-        return "SDK Version: 1.0.0, Core Version: 1.0.0"
+        return "SDK Version: 1.1.0, Core Version: 1.1.0"
 
     def terminate(self):
         return True

src/protegrity_developer_python/scan.py

@@ -0,0 +1,37 @@
+"""
+Module for scanning conversations for security risks using semantic guardrails
+"""
+
+from protegrity_developer_python.utils.logger import get_logger
+
+
+from protegrity_developer_python.utils.semantic_guardrails import (
+    MessageRiskRequest,
+    scan_messages,
+    MessageBatchRiskResponse,
+    MessageBatchRiskRequest,
+)
+
+logger = get_logger()
+
+
+def scan_conversation_messages(
+    messages: list[MessageRiskRequest],
+) -> MessageBatchRiskResponse:
+    """
+            Scan a batch of conversation messages for security risks using the Semantic Guardrails API.
+            A risk assessment is executed on messages to ensure they are within the boundaries of expected topics and content.
+    s
+            Args:
+                messages (list[MessageRiskRequest]): List of messages to scan.
+
+            Returns:
+                MessageBatchRiskResponse: Risk assessment for the batch of messages.
+    """
+    try:
+        request = MessageBatchRiskRequest(messages=messages)
+        response = scan_messages(request)
+        return response
+    except Exception as e:
+        logger.error(f"Failed to scan conversation messages: {e}")
+        raise