Setting up Data Protection Features

Installation instructions for the Data Protection features.

1: Building the Python Module
2: Building the Java Libraries

Prerequisites

Ensure that the following prerequisites are met before running these examples for tokenizing data:

Python, pip, Java, and Maven are installed. For more information, refer to Setting Up AI Developer Edition.
Credentials to access AI Developer Edition API Service are obtained by registering for free. For more information, refer to Obtaining access to the AI Developer Edition API Service.
Required modules and libraries are installed. For more information, refer to Installing the Python module and Installing the Java library.
For shell samples: Bash version greater than or equal to 5.1.8 and curl version greater than or equal to 7.76.1.
Verify that the AI Developer Edition Service is running. The service availability can be monitored on the status page, refer to AI Developer Edition System Status.

Note: The Java samples provided in this section are for Linux or macOS. For Windows, use <filename>.bat.

Installation

Steps to install the required modules and libraries for the Data Protection feature are provided below.

Installing the protegrity-ai-developer-python module

The module has built-in functions to find, redact, mask, and protect data.

Open a command prompt.
Install the protegrity-ai-developer-python module. It is recommended to install and activate the Python virtual environment before running this command.
```
pip install protegrity-ai-developer-python
```
The installation completes and the success message is displayed. To compile and install the Python module from source, refer to Building the Python module.

Open a command prompt.
Upgrade the protegrity-ai-developer-python module. It is recommended to install and activate the Python virtual environment before running the command.
```
pip install --upgrade protegrity-ai-developer-python
```
The package is successfully upgraded.

Installing the protegrity-ai-developer-java library

When you run the Java samples for the first time, Maven automatically pulls the protegrity-ai-developer-java library from Maven Central as a dependency. This ensures that all required classes and resources are available without manual download.

1 - Building the Python Module

Compiling and building the Python module.

The protegrity-ai-developer-python repository is part of the Protegrity AI Developer Edition suite. This repository provides the Python module for integrating Protegrity’s Data Discovery and Protection APIs into GenAI and traditional applications. Customize, compile, and use the module as per your requirement.

Note: This module should only be built and used if the source and default behavior are to be changed. Ensure that the Protegrity AI Developer Edition is set up before installing this module.
For setup instructions, refer to installation steps.

Prerequisites

Git is installed for cloning the repository.
Python v3.11 and above is installed for compiling the module.
For installing packages: pip
Python Virtual Environment is set up for installing the module and its dependencies.
Uninstall the protegrity_developer_python module from the Python virtual environment if it is already installed.
```
pip uninstall protegrity_developer_python
```

Build the protegrity-ai-developer-python module

Clone the repository.

git clone https://github.com/Protegrity-AI-Developer-Edition/protegrity-ai-developer-python.git

Navigate to the protegrity-ai-developer-python directory in the cloned location.
Optional: Update the files in the Python source directory as required.
Activate the Python virtual environment.
Install the dependencies.
```
pip install -r requirements.txt
```
Build and install the Python module by running the following command from the root directory of the repository.
```
pip install .
```
The installation completes and the success message is displayed.

2 - Building the Java Libraries

Compiling and building the Java libraries.

The protegrity-ai-developer-java repository is part of the Protegrity AI Developer Edition suite. This repository provides the Java library for integrating Protegrity’s Data Discovery and Protection APIs into GenAI and traditional applications. Customize, compile, and use the Java library as per your requirement.

Note: This module should only be built and used if the source and default behavior are to be changed. Ensure that the Protegrity AI Developer Edition is set up before installing the Java library.
For setup instructions, refer to installation steps.

Prerequisites

Git is installed for cloning the repository.
Java 11 or later is installed for compiling the library.
Maven 3.6 or later is installed or use the included Maven wrapper.

Build and test the protegrity-ai-developer-java library

Clone the repository.

git clone https://github.com/Protegrity-AI-Developer-Edition/protegrity-ai-developer-java.git

Navigate to the protegrity-ai-developer-java directory in the cloned location.
Optional: Update the files in the Java source directory as required.
Build the project using Maven wrapper. It is recommended to use this method.
```
./mvnw clean install
```
OR Build the project using system Maven.
```
mvn clean install
```
The build completes and the success message is displayed. This creates:
- application-protector-java/target/ApplicationProtectorJava-1.1.0.jar (fat JAR with dependencies)
- protegrity-ai-developer-edition/target/ProtegrityDeveloperJava-1.1.0.jar (fat JAR with dependencies)
- Maven artifacts in your local repository (.m2/repository)