Skip to main content

Paradime

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.

Refreshing the catalog

paradime catalog refresh requests a catalog refresh and, by default, waits until every refresh step ends (docs generate, catalog build and any enabled integration syncs such as DataHub or Altimate). It logs one plain line each time a step starts, makes progress, finishes or fails, and exits non-zero if any step fails, so a Bolt command running it fails with the reason in its log:

[catalog refresh]    started, refresh id 8f3c...
[dbt docs generate]  started
[dbt docs generate]  done in 4m12s
[Read dbt artifacts] done in 9s
[Catalog build]      started, Write assets 18,400 / 41,200 assets
[Catalog build]      done in 1m03s
[DataHub push]       FAILED: 401 Unauthorized
[catalog refresh]    FAILED: 1 of 4 steps failed (DataHub push)

If a refresh is already running, the command follows that refresh instead of starting another one.

Option Description
--no-wait Only request the refresh, print its id and exit 0. This is how the command behaved before it waited by default.
--timeout How long to wait, e.g. 90s, 45m, 2h (default 2h). When it expires the command fails and names the steps that had not finished; the refresh itself continues.
--allow-integration-failures Log a failed integration sync (e.g. DataHub, Altimate) as a warning and exit 0. A failed docs generate or catalog build always fails the command.

The command exits 0 only when every step succeeded (or, with --allow-integration-failures, only integration syncs failed). It also fails when the refresh is skipped and nothing is refreshed, e.g. when the workspace has no warehouse connection for its production catalog. A single failed read of the refresh state is retried with backoff and does not fail the command.

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

Metadata

Release files for paradime-io 6.12.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for paradime-io 6.12.0
File Size Uploaded Provenance Actions
paradime_io-6.12.0.tar.gz 322.0 kB With provenance Details for paradime_io-6.12.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for paradime-io 6.12.0
File Interpreter ABI Platform Actions
paradime_io-6.12.0-py3-none-any.whl Python 3 none any Details for paradime_io-6.12.0-py3-none-any.whl

Total release size: 564.0 kB

Release files / paradime_io-6.12.0.tar.gz

Download URL paradime_io-6.12.0.tar.gz
Size 322.0 kB
Tags Source
SHA-256 checksum
How to use checksums
dee014abb5389e530a3c1f14f09d951fd8d98faa094a1176d54bddc50ed56ab5
BLAKE2b-256 checksum
How to use checksums
e0622afe6a7b45ab7cbbb03bab55192b701f3f3c0f2da28f80a58217e85b8e6e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Release files / paradime_io-6.12.0-py3-none-any.whl

Download URL paradime_io-6.12.0-py3-none-any.whl
Size 241.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b0ca350e8d98311526b59b8e12ab8d6f97074074129fe92c9e7eb8104d58f076
BLAKE2b-256 checksum
How to use checksums
eea0c7b319f17d50867dd4e7160d0e003c4cf5e66177501fc98a7e5b76b5b1f4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

Security for paradime-io 6.12.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for paradime_io-6.12.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

6.12.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page