gooddata-sdk 1.68.1.dev1

GoodData Cloud Python SDK

GoodData Python SDK

The gooddata-sdk package provides a clean and convenient Python API to interact with GoodData.

At the moment the SDK provides services to inspect and interact with the Semantic Model and consume analytics:

• Catalog Workspaces Service
• Catalog Workspace Content Service
• Catalog Data Source Service
• Catalog User Service
• Catalog Permission Service
• Catalog Organization Service
• Catalog Appearance Service
• Visualizations Service
• Compute Service
• Table Service

See DOCUMENTATION for more details.

Requirements

• GoodData Cloud or GoodData.CN installation
• Python 3.10 or newer

Installation

Run the following command to install the gooddata-sdk package on your system:

pip install gooddata-sdk

Example

Compute an visualization:

import gooddata_sdk

# GoodData host in the form of uri
host = "http://localhost:3000"
# GoodData user token
token = "some_user_token"
sdk = gooddata_sdk.GoodDataSdk.create(host, token)

workspace_id = "demo"
visualization_id = "customers_trend"
# reads visualization from workspace
visualization = sdk.visualizations.get_visualization(workspace_id, visualization_id)
# triggers computation for the visualization. the result will be returned in a tabular form
table = sdk.tables.for_visualization(workspace_id, visualization)

# and this is how you can read data row-by-row and do something with it
for row in table.read_all():
    print(row)

Bugs & Requests

Please use the GitHub issue tracker to submit bugs or request features.

Changelog

See Github releases for released versions and a list of changes.