Setting up the packages

Steps for obtaining and setting up the packages.

Obtaining the package

Navigate to the Protegrity AI Developer Edition repository.
Clone or download the repositories on your local system.
- protegrity-developer-edition: Contains the files to launch the required containers. It also contains the sample applications and files.
```
git clone https://github.com/Protegrity-Developer-Edition/protegrity-developer-edition.git
```
To customize the Python modules, clone and use the source from the protegrity-developer-python repository.
```
git clone https://github.com/Protegrity-Developer-Edition/protegrity-developer-python.git
```
To customize the Java libraries, clone and use the source from the protegrity-developer-java repository.
```
git clone https://github.com/Protegrity-Developer-Edition/protegrity-developer-java.git
```
Verify the files in the package. The list of files in the git package can be obtained from the files list.

Back up the Protegrity AI Developer Edition repository if the Python and configuration files are updated.
Note: The supported entites are updated. For more information about the entites, refer to Supported Entites.
Navigate to the cloned repository location for protegrity-developer-edition.
Run the following command to stop the containers.
```
docker compose down
```
Based on your configuration use the docker-compose down command.
Sync to update the repositories on the local system using the git pull command.
- protegrity-developer-edition: Contains the files to launch the required containers. It also contains the sample applications and files.
- protegrity-developer-python: Contains the source files for customizing and using the Python module.
- protegrity-developer-java: Contains the source files for customizing and using the Java library.
Verify the files in the package. The list of files in the git package can be obtained from the files list.

Setting up Data Discovery, Semantic Guardrail, and Synthetic Data

The containers contain the Data Discovery and Semantic Guardrails components required for identifying sensitive data. It also contains the Synthetic Data component for data generation.

Open a command prompt.
Navigate to the cloned repository location for protegrity-developer-edition.
Run the following command to download and start the containers. The dependent containers are large in size. Based on the network connection, the containers might take time to download and deploy.
To start all the features.
```
docker compose --profile synthetic up -d
```
To start only the Data Discovery and Semantic Guardrails features.
```
docker compose up -d
```
Based on your configuration use the docker-compose up -d command. Ensure that you bring down the containers using docker compose --profile synthetic down or docker compose down before switching between starting all containers or Data Discovery and Semantic Guardrails containers.
Verify that the containers started successfully.
```
docker compose logs
```
Set up the Jupyter notebook for working with the notebooks provided from the cloned repository location for protegrity-developer-edition.
```
pip install -r samples/python/requirements.txt
```

Open a command prompt.
Navigate to the cloned repository location for protegrity-developer-edition.
If the step to stop containers was missed earlier, then use the following commands to identify and remove the AI Developer Edition containers.
```
docker compose down --remove-orphans
```

Delete the docker network resources.

docker network rm -f <network_name_or_id>

For example,

docker network rm -f protegrity-network

Run the following command to download and start the containers. The dependent containers are large in size. Based on the network connection, the containers might take time to download and deploy.
To start all the features.
```
docker compose --profile synthetic up -d
```
To start only the Data Discovery and Semantic Guardrails features.
```
docker compose up -d
```
Based on your configuration use the docker-compose up -d command. Ensure that you bring down the containers using docker compose --profile synthetic down or docker compose down before switching between starting all containers or Data Discovery and Semantic Guardrails containers.
Verify that the containers started successfully.
```
docker compose logs
```
Set up the Jupyter notebook for working with the notebooks provided from the cloned repository location for protegrity-developer-edition.
```
pip install -r samples/python/requirements.txt
```

Installing the protegrity-developer-python module

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

Open a command prompt.
Install the protegrity-developer-python module. It is recommended to install and activate the Python virtual environment before running this command.
```
pip install protegrity-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-developer-python module. It is recommended to install and activate the Python virtual environment before running the command.
```
pip install --upgrade protegrity-developer-python
```
The package is successfully upgraded.

Installing the protegrity-developer-java library

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

Feedback

Was this page helpful?

Last modified : December 11, 2025