Metadata-Version: 2.1
Name: gooddata-sdk
Version: 1.0.1a2
Summary: GoodData.CN Python SDK
Author: GoodData
Author-email: support@gooddata.com
License: MIT
Project-URL: Documentation, https://gooddata-sdk.readthedocs.io
Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
Keywords: gooddata,sdk,api,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.7.0
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# GoodData Python SDK

The `gooddata-sdk` package provides a clean and convenient Python API to interact with [GoodData.CN](https://www.gooddata.com/developers/cloud-native/).

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](https://gooddata-sdk.readthedocs.io) for more details.

## Requirements

-  GoodData.CN installation; either running on your cloud
   infrastructure or the free Community Edition running on your workstation

-  Python 3.7 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.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)
```


## 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.
