# GoodData Python SDK
The `gooddata-sdk` package provides a clean and convenient Python API to interact with [GoodData](https://www.gooddata.com/).
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
* Insights Service
* Compute Service
* Table Service
See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.18.1) for more details.
## Requirements
- GoodData Cloud or GoodData.CN installation
- Python 3.8 or newer
## Installation
Run the following command to install the `gooddata-sdk` package on your system:
pip install gooddata-sdk
## Example
Compute an insight:
```python
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"
insight_id = "customers_trend"
# reads insight from workspace
insight = sdk.visualizations.get_visualization(workspace_id, insight_id)
# triggers computation for the insight. the result will be returned in a tabular form
table = sdk.tables.for_visualization(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)
```
## Bugs & Requests
Please use the [GitHub issue tracker](https://github.com/gooddata/gooddata-python-sdk/issues) to submit bugs
or request features.
## Changelog
See [Github releases](https://github.com/gooddata/gooddata-python-sdk/releases) for released versions
and a list of changes.
Raw data
{
"_id": null,
"home_page": null,
"name": "gooddata-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": null,
"keywords": "gooddata, sdk, api, analytics, headless, business, intelligence, headless-bi, cloud, native, semantic, layer, sql, metrics",
"author": "GoodData",
"author_email": "support@gooddata.com",
"download_url": "https://files.pythonhosted.org/packages/b3/08/e0eef167d5a860066eb9a3554e8f1dd8055b85124c4fe03fdd2fb3a03bbb/gooddata_sdk-1.18.1.tar.gz",
"platform": null,
"description": "# GoodData Python SDK\n\nThe `gooddata-sdk` package provides a clean and convenient Python API to interact with [GoodData](https://www.gooddata.com/).\n\nAt the moment the SDK provides services to inspect and interact with the Semantic Model and consume analytics:\n* Catalog Workspaces Service\n* Catalog Workspace Content Service\n* Catalog Data Source Service\n* Catalog User Service\n* Catalog Permission Service\n* Catalog Organization Service\n* Insights Service\n* Compute Service\n* Table Service\n\nSee [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.18.1) for more details.\n\n## Requirements\n\n- GoodData Cloud or GoodData.CN installation\n- Python 3.8 or newer\n\n## Installation\n\nRun the following command to install the `gooddata-sdk` package on your system:\n\n pip install gooddata-sdk\n\n## Example\n\nCompute an insight:\n```python\nimport gooddata_sdk\n\n# GoodData host in the form of uri\nhost = \"http://localhost:3000\"\n# GoodData user token\ntoken = \"some_user_token\"\nsdk = gooddata_sdk.GoodDataSdk.create(host, token)\n\nworkspace_id = \"demo\"\ninsight_id = \"customers_trend\"\n# reads insight from workspace\ninsight = sdk.visualizations.get_visualization(workspace_id, insight_id)\n# triggers computation for the insight. the result will be returned in a tabular form\ntable = sdk.tables.for_visualization(workspace_id, insight)\n\n# and this is how you can read data row-by-row and do something with it\nfor row in table.read_all():\n print(row)\n```\n\n\n## Bugs & Requests\n\nPlease use the [GitHub issue tracker](https://github.com/gooddata/gooddata-python-sdk/issues) to submit bugs\nor request features.\n\n## Changelog\n\nSee [Github releases](https://github.com/gooddata/gooddata-python-sdk/releases) for released versions\nand a list of changes.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "GoodData Cloud Python SDK",
"version": "1.18.1",
"project_urls": {
"Documentation": "https://www.gooddata.com/docs/python-sdk/1.18.1",
"Source": "https://github.com/gooddata/gooddata-python-sdk"
},
"split_keywords": [
"gooddata",
" sdk",
" api",
" analytics",
" headless",
" business",
" intelligence",
" headless-bi",
" cloud",
" native",
" semantic",
" layer",
" sql",
" metrics"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "115d34d32b6d57facefeed045bff42a20756770c5bcaba25b182edd16ecfa66d",
"md5": "0f9cd8b1913c7b83660a388f278dc76b",
"sha256": "d4959ecc251c6e4790c19a5e9f7e4bbdbb334a15c9f750f5256ec9a087d34880"
},
"downloads": -1,
"filename": "gooddata_sdk-1.18.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0f9cd8b1913c7b83660a388f278dc76b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 138077,
"upload_time": "2024-04-19T08:20:22",
"upload_time_iso_8601": "2024-04-19T08:20:22.309368Z",
"url": "https://files.pythonhosted.org/packages/11/5d/34d32b6d57facefeed045bff42a20756770c5bcaba25b182edd16ecfa66d/gooddata_sdk-1.18.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b308e0eef167d5a860066eb9a3554e8f1dd8055b85124c4fe03fdd2fb3a03bbb",
"md5": "f15d818ecf5cbe98a32355f65247b385",
"sha256": "fe5203b12498d389b2b8583f4059a80611907d6c98834bcab7ed0e783d0cbf11"
},
"downloads": -1,
"filename": "gooddata_sdk-1.18.1.tar.gz",
"has_sig": false,
"md5_digest": "f15d818ecf5cbe98a32355f65247b385",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 101117,
"upload_time": "2024-04-19T08:20:24",
"upload_time_iso_8601": "2024-04-19T08:20:24.676303Z",
"url": "https://files.pythonhosted.org/packages/b3/08/e0eef167d5a860066eb9a3554e8f1dd8055b85124c4fe03fdd2fb3a03bbb/gooddata_sdk-1.18.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 08:20:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gooddata",
"github_project": "gooddata-python-sdk",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gooddata-sdk"
}
JSON
