Building the Python module

The protegrity-developer-python repository is part of the Protegrity 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 be built and used, only if you intend to change the source and default behavior.

💡Note: Ensure that the Protegrity Developer Edition is running before installing this module. For setup instructions, please refer to the installation steps.

Prerequisites

• Git
• Python >= 3.9.23
• pip
• Python Virtual Environment
• Uninstall the protegrity_developer_python module from the Python virtual environmentif it is already installed.

  pip uninstall protegrity_developer_python
  

Build the protegrity-developer-python module

1. Clone the repository.

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

2. Navigate to the protegrity-developer-python directory in the cloned location.
3. Optional: Update the Python source file /src/protegrity_developer_python/securefind.py as required.
4. Activate the Python virtual environment.
5. Install the dependencies.

   pip install -r requirements.txt
   

6. 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.