Python SDK - Parable

The Python client is parable_web_api_sdk. It covers the endpoints in the Workspace API reference.

Access

Distribution is not public yet, and the Workspace API has no public address. See Availability. Contact your Parable representative for access.

Import and authenticate

Create a client with the Workspace API base URL and your token.

import os

from parable_web_api_sdk import ClientConfig, WebApiSDK

base_url = os.environ["PARABLE_API_URL"]
token = os.environ["PARABLE_API_TOKEN"]

sdk = WebApiSDK(
    ClientConfig(
        base_url=base_url,
        auth_token=token,
    )
)

The client sends Authorization: Bearer ... on every call.

Query Workspace data

Use the Python Flight SQL client alongside the Workspace API SDK when you need table data rather than control-plane resources. The SQL SDK guide shows how to execute a query and read its Arrow result. The SQL primer defines the shared catalog and pool model.

Read

Read the current member, then the Provider connections configured in the Workspace:

me = sdk.users.me()
print(me.name, me.email)

connections = sdk.vendors.tenant_connector_instances()
for connection in connections:
    print(connection.name, connection.connection_status)

Update

Enable a tap. Replace the ID with one from the Workspace. List taps with sdk.tenant_connector_taps.tenant_connector_taps().

from parable_types_web_api import UpdateTenantConnectorTapInput

tap = sdk.tenant_connector_taps.update_tenant_connector_tap(
    "018f2a3b-9c4d-7e5f-8a6b-1c2d3e4f5a6b",
    UpdateTenantConnectorTapInput(enabled=True),
)
print(tap.id, tap.enabled)

Omitted fields are left unchanged. To disable the tap, pass UpdateTenantConnectorTapInput(enabled=False).

Groups in the Workspace API reference are namespaces such as sdk.users and sdk.vendors. Operations are snake_case methods such as me and tenant_connector_instances.

Admin

​Access

​Import and authenticate

​Query Workspace data

​Read

​Update

Access

Import and authenticate

Query Workspace data

Read

Update