The gooddata-sdk package provides a clean and convenient Python API to interact with GoodData.CN.
At the moment the SDK provides services to inspect and interact with the Semantic Model and consume analytics:
- Catalog Service
- Insights Service
- Compute Service
- Table Service
See DOCUMENTATION for more details.
-
GoodData.CN installation; either running on your cloud infrastructure or the free Community Edition running on your workstation
-
Python 3.7 or newer
Run the following command to install the gooddata-sdk package on your system:
pip install gooddata-sdk
Compute an insight:
import gooddata_sdk
# GoodData.CN host in the form of uri eg. "http://localhost:3000"
host = "http://localhost:3000"
# GoodData.CN user token
token = "some_user_token"
sdk = gooddata_sdk.GoodDataSdk.create(host, token)
workspace_id = "demo"
insight_id = "customers_trend"
# reads insight from workspace
insight = sdk.insights.get_insight(workspace_id, insight_id)
# triggers computation for the insight. the result will be returned in a tabular form
table = sdk.tables.for_insight(workspace_id, insight)
# and this is how you can read data row-by-row and do something with it
for row in table.read_all():
print(row)Please use the GitHub issue tracker to submit bugs or request features.
See Github releases for released versions and a list of changes.