# 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
* Visualizations Service
* Compute Service
* Table Service
See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.0) for more details.
## Requirements
- GoodData Cloud or GoodData.CN installation
- Python 3.9 or newer
## Installation
Run the following command to install the `gooddata-sdk` package on your system:
pip install gooddata-sdk
## Example
Compute an visualization:
```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"
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](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.9.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/89/59/c763fd13da5f017efb7df3a921fcefdce449e63179317cb91980571ffb9f/gooddata_sdk-1.31.0.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* Visualizations Service\n* Compute Service\n* Table Service\n\nSee [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.31.0) for more details.\n\n## Requirements\n\n- GoodData Cloud or GoodData.CN installation\n- Python 3.9 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 visualization:\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\"\nvisualization_id = \"customers_trend\"\n# reads visualization from workspace\nvisualization = sdk.visualizations.get_visualization(workspace_id, visualization_id)\n# triggers computation for the visualization. the result will be returned in a tabular form\ntable = sdk.tables.for_visualization(workspace_id, visualization)\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.31.0",
"project_urls": {
"Documentation": "https://www.gooddata.com/docs/python-sdk/1.31.0",
"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": "ecc1d6e342355d1fa52975d477c36b001b7b060a19fd30e92bfdfc16c7ab5b41",
"md5": "8b4fad91e6d68d7acb33ae9a07ca15a2",
"sha256": "febf58871611e1a836b2b4faba13f8cfdba843d13c30ee3283810b79e786db1a"
},
"downloads": -1,
"filename": "gooddata_sdk-1.31.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b4fad91e6d68d7acb33ae9a07ca15a2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9.0",
"size": 162194,
"upload_time": "2024-11-14T15:17:57",
"upload_time_iso_8601": "2024-11-14T15:17:57.213914Z",
"url": "https://files.pythonhosted.org/packages/ec/c1/d6e342355d1fa52975d477c36b001b7b060a19fd30e92bfdfc16c7ab5b41/gooddata_sdk-1.31.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8959c763fd13da5f017efb7df3a921fcefdce449e63179317cb91980571ffb9f",
"md5": "23e12ef062396e0b3db6fb447a5e96f6",
"sha256": "797ed4a63161b28aad01c2181c6ef83c651047efc26b4585f8f6502e29ae2f48"
},
"downloads": -1,
"filename": "gooddata_sdk-1.31.0.tar.gz",
"has_sig": false,
"md5_digest": "23e12ef062396e0b3db6fb447a5e96f6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9.0",
"size": 120357,
"upload_time": "2024-11-14T15:18:07",
"upload_time_iso_8601": "2024-11-14T15:18:07.469837Z",
"url": "https://files.pythonhosted.org/packages/89/59/c763fd13da5f017efb7df3a921fcefdce449e63179317cb91980571ffb9f/gooddata_sdk-1.31.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-14 15:18:07",
"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
