Paradime - Python SDK

5.1.0 · active · verified Thu Apr 16

The `paradime-io` library provides the official Python SDK and CLI for interacting with the Paradime platform. Paradime positions itself as an 'operating system for analytics,' designed to streamline analytics engineering workflows by unifying data exploration, dbt™ model building, scheduling, and data lineage in a single environment. It enables users to code, run, and manage data pipelines for analytics and AI. The library is actively maintained, with a current version of 5.1.0, and a regular release cadence based on its extensive release history.

Common errors

```
ModuleNotFoundError: No module named 'paradime'
```
cause The `paradime-io` package is not installed in the current Python environment, or the environment is not activated.

fix Run `pip install paradime-io` to install the package. If using a virtual environment, ensure it is activated before running your script.
```
paradime.exceptions.AuthenticationError: Invalid API credentials provided
```
cause The `api_endpoint`, `api_key`, or `api_secret` provided to the `Paradime` client are incorrect, expired, or missing, preventing successful authentication with the Paradime API.

fix Double-check your API credentials in your Paradime workspace settings. Ensure they are correctly passed to the `Paradime` constructor, or that the `PARADIME_API_ENDPOINT`, `PARADIME_API_KEY`, and `PARADIME_API_SECRET` environment variables are correctly set and accessible to your application.

Warnings

gotcha API Key and Secret must be obtained from your Paradime workspace settings. Hardcoding them directly in your codebase is discouraged for security reasons.
Fix: Generate `api_key`, `api_secret`, and `api_endpoint` from your Paradime workspace settings. Use environment variables to store them securely: `export PARADIME_API_ENDPOINT="YOUR_API_ENDPOINT"`, `export PARADIME_API_KEY="YOUR_API_KEY"`, `export PARADIME_API_SECRET="YOUR_API_SECRET"`.
gotcha When running Python scripts within Paradime's Bolt scheduler using Poetry for dependency management, `poetry install` must be the first command in your schedule.
Fix: Ensure your Bolt schedule configuration includes `poetry install` as the initial step to set up the execution environment correctly.
gotcha The Paradime client currently targets Python >=3.11. Using older Python versions will lead to installation or runtime errors.
Fix: Ensure your environment is running Python 3.11 or newer. Upgrade your Python installation if necessary.

Install

pip install paradime-io Install with pip

Imports

Paradime
```
from paradime import Paradime
```
The main client class for interacting with the Paradime API.

Quickstart

Initialize the Paradime client using API credentials. It is highly recommended to store `PARADIME_API_ENDPOINT`, `PARADIME_API_KEY`, and `PARADIME_API_SECRET` as environment variables. These can be generated within your Paradime workspace settings.

import os
from paradime import Paradime

# Retrieve API credentials from environment variables for security
api_endpoint = os.environ.get("PARADIME_API_ENDPOINT", "https://api.paradime.io") # Default API endpoint
api_key = os.environ.get("PARADIME_API_KEY", "")
api_secret = os.environ.get("PARADIME_API_SECRET", "")

if not api_key or not api_secret:
    print("Warning: PARADIME_API_KEY or PARADIME_API_SECRET not set as environment variables.")
    print("Please generate your API key, secret, and endpoint from Paradime workspace settings.")
    print("Falling back to placeholder values. This will likely result in authentication errors.")

paradime = Paradime(
    api_endpoint=api_endpoint,
    api_key=api_key,
    api_secret=api_secret,
)

# Example: List available dbt jobs (requires appropriate permissions)
# try:
#     jobs = paradime.dbt_jobs.list_jobs()
#     print(f"Found {len(jobs.data)} dbt jobs.")
#     for job in jobs.data:
#         print(f"  - Job ID: {job.id}, Name: {job.name}")
# except Exception as e:
#     print(f"Error interacting with Paradime API: {e}")

view raw JSON →