Python SDK

Mon, 01 Jan 0001 00:00:00 +0000

Use this section to install, configure, and validate the Python SDK for Protegrity Anonymization.

Prerequisites

Ensure one of the following is met:

pip is available in your active Python virtual environment.
A conda environment is activated.

Overview

Use the Python SDK to access the Anonymization service programmatically.

1. Install the Anonymization Python SDK

Install the SDK using pip or conda using the version that matches the deployed Anonymization service.

Using pip:

Python SDK Reference

Mon, 01 Jan 0001 00:00:00 +0000

This section describes the classes and methods available in the Anonymization Python SDK, along with usage examples. For installation steps, refer to the Python SDK Installation section.

ClientConfig

Configuration dataclass for AnonymizationClient.

from anonymization_sdk.config import ClientConfig

config = ClientConfig(
 base_url="<GATEWAY_URL>/pty/anonymization/v3",
 username="anonymization_admin",
 password="StrongPassword123!",
 verify_ssl=True,
)

Attributes:

base_url (str, default "http://localhost:8000") - Base URL of the Anonymization API.
timeout (float, default 30) - Request timeout in seconds.
max_retries (int, default 3) - Retry attempts on connection failure.
verify_ssl (bool, default True) - Set to False for self-signed certificates.
username (str | None, default None) - Username for token-based authentication.
password (str | None, default None) - Password for token-based authentication.
refresh_buffer (int, default 30) - Seconds before token expiry to proactively refresh.
poll_interval (float, default 2.0) - Seconds between async job status polls.
job_timeout (float, default 600) - Maximum seconds to wait for a job.