Obtaining the packages

Downloading the packages.

The following packages are available for download:

  • protegrity-ai-developer-edition: Contains Docker Compose files, sample applications, and configuration templates.
  • protegrity-ai-developer-python: Contains the source files for customizing and using the Python module.
  • protegrity-ai-developer-java: Contains the source files for customizing and using the Java library.

Cloning the repositories

Sync the repositories to download the packages onto your local system. You can use the git clone command to clone the repositories.

  1. Navigate to the Protegrity AI Developer Edition repository.

  2. Clone or download protegrity-ai-developer-edition for testing the features.

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

  3. Clone or download protegrity-ai-developer-python for customizing the Python module.

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

  4. Clone or download protegrity-ai-developer-java for customizing the Java library.

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

  5. Verify the files in the package. The list of files in the git package can be obtained from the files list.

  1. Back up the Protegrity AI Developer Edition repository if the Python and configuration files are updated.

    Note: The supported entities are updated. For more information about the entities, refer to Supported Entities.

  2. Navigate to the cloned repository location for protegrity-ai-developer-edition.

  3. Run the following command to stop the containers.

    docker compose down

    Based on your configuration use the docker-compose down command.

  4. Sync to update the repositories on the local system using the git pull command.

  5. Verify the files in the package. The list of files in the git package can be obtained from the files list.

Setting up feature containers

After downloading the common packages, set up the containers for the features you want to use. Refer to the setup instructions in each feature section:

Setting up Jupyter notebook

Set up the Jupyter notebook for working with the notebooks provided from the cloned repository location for protegrity-ai-developer-edition. Ensure that the Python virtual environment is activated before running this command.

pip install -r shared/requirements.txt

Last modified : July 08, 2026