Setting up the packages

Steps for obtaining and setting up the pacakges.

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
```
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.
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.
Verify the files in the package. The list of files in the git package can be obtained from the files list.

The containers contain the Data Discovery and Semantic Guardrail components required for identifying sensitive data.

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.
```
docker compose up -d
```
Based on your configuration use the docker-compose up -d command.
Verify that the containers started successfully.
```
docker compose logs
```

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
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.
```
docker compose up -d
```
Based on your configuration use the docker-compose up -d command.
Verify that the containers started successfully.
```
docker compose logs
```

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.

Was this page helpful?

Last modified : November 28, 2025