paradime-io 6.2.0

Paradime - Python SDK

Paradime - Python SDK

Installation

pip install paradime-io

SDK Usage

Generate your API credentials from Paradime workspace settings.

You can authenticate with a bearer token (recommended) — either a workspace-level token (prdm_wsp_...) or a company-level token (prdm_cmp_..., requires workspace_uid to select which workspace requests target). Pass it as api_secret; the SDK detects the token type automatically from its prefix and api_key is not needed:

from paradime import Paradime

paradime = Paradime(
    api_endpoint="API_ENDPOINT",
    api_secret="API_TOKEN",  # e.g. prdm_wsp_... or prdm_cmp_...
    # workspace_uid="WORKSPACE_UID",  # required when using a company-level (prdm_cmp_) token
)

# Use the paradime client to interact with the API

Or with the legacy API key + secret pair:

from paradime import Paradime

paradime = Paradime(
    api_endpoint="API_ENDPOINT", 
    api_key="API_KEY", 
    api_secret="API_SECRET",
)

# Use the paradime client to interact with the API

CLI Usage

For the full specification of the CLI, run:

paradime --help

Generate your API credentials from Paradime workspace settings. Then set the environment variables.

Using a bearer token (recommended):

export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"
export PARADIME_API_SECRET="YOUR_API_TOKEN" # e.g. prdm_wsp_... or prdm_cmp_...
export PARADIME_WORKSPACE_UID="YOUR_WORKSPACE_UID" # required when using a company-level (prdm_cmp_) token

Or using the legacy API key + secret pair:

export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"
export PARADIME_API_KEY="YOUR_API_KEY"
export PARADIME_API_SECRET="YOUR_API_SECRET

Alternatively, run paradime login to be prompted for either set of credentials, which will be stored locally.

Examples

Find usage examples here to get started with the Paradime Python SDK.

Telemetry

Each API call sends X-PYTHON-VERSION (e.g. 3.11.5) and X-PARADIME-RUNTIME (e.g. github-actions, airflow, paradime-bolt, local) to help Paradime understand how the SDK is being used. Only the presence of well-known CI/platform environment variables is checked — no values are ever transmitted.

To opt out:

export PARADIME_DISABLE_TELEMETRY=true