Metadata-Version: 2.4
Name: gooddata-flexconnect
Version: 1.40.1.dev6
Summary: Build your own data source for GoodData Cloud and GoodData Cloud Native.
Author: GoodData
Author-email: support@gooddata.com
License: MIT
Project-URL: Documentation, https://gooddata-flexconnect.readthedocs.io/en/v1.40.1.dev6
Project-URL: Source, https://github.com/gooddata/gooddata-python-sdk
Keywords: gooddata,flight,rpc,flight rpc,custom functions,analytics,headless,business,intelligence,headless-bi,cloud,native,semantic,layer,sql,metrics
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development
Classifier: Typing :: Typed
Requires-Python: >=3.9.0
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: dynaconf<4.0.0,>=3.1.11
Requires-Dist: gooddata-flight-server~=1.40.1.dev6
Requires-Dist: gooddata-sdk~=1.40.1.dev6
Requires-Dist: orjson<4.0.0,>=3.9.15
Requires-Dist: pyarrow>=16.1.0
Requires-Dist: structlog<25.0.0,>=24.0.0
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# GoodData FlexConnect

GoodData FlexConnect allows you to build your own data source for GoodData Cloud or Cloud Native.

FlexConnect works with a concept similar to 'table functions' that you may already know
from database technologies.

-  To build your own data source, you implement one or more FlexConnect functions. The
   functions compute and return tabular data - how they do it is completely up to you.
-  The functions are hosted and invoked inside a FlexConnect server (which is included in this package).
-  A running FlexConnect server can be added as a data source to your GoodData Cloud or GoodData Cloud Native.
-  The functions available on FlexConnect server will be mapped to data sets within GoodData's Semantic Model
   and from then on can be used during report computation.


## Getting Started using the FlexConnect

The easiest and recommended way to get started with FlexConnect is to use [the template repository](https://github.com/gooddata/gooddata-flexconnect-template).

The template repository is set up with project infrastructure and boilerplate related to testing, packaging and
running your FlexConnect functions. You can start building your own data source in under a minute.

The template also comes with extensive documentation which will guide you through all important steps and facets
of building production-ready FlexConnect functions.

If you are eager to get started, here is a short snippet to bootstrap a new FlexConnect project:

```shell
git clone https://github.com/gooddata/gooddata-flexconnect-template.git my-flexconnect
cd my-flexconnect
rm -rf .git && git init && git add . && git commit -m "Initial commit"
```
