Skip to content

Commit 5204412

Browse files
committed
doc: cleanup readme
- simplify - just guide user to the template - NOTE: the template repo does not yet exist JIRA: CQ-894 risk: low
1 parent d48908e commit 5204412

File tree

1 file changed

+11
-40
lines changed

1 file changed

+11
-40
lines changed

gooddata-flexconnect/README.md

Lines changed: 11 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -13,49 +13,20 @@ from database technologies.
1313
and from then on can be used during report computation.
1414

1515

16-
## Getting Started using the FlexConnect Template
16+
## Getting Started using the FlexConnect
1717

18-
The easiest way to get started writing FlexConnect functions is to use [the template repository](https://github.com/gooddata/gooddata-flexconnect-template).
19-
It provides a simple example of a FlexConnect function that can be used as a starting point for your own FlexConnect functions with all the necessary infrastructure in place.
20-
It also has a README that explains how to get started with the template and some general tips on how to write FlexConnect functions.
18+
The easiest and recommended way to get started with FlexConnect is to use [the template repository](https://github.com/gooddata/gooddata-flexconnect-template).
2119

22-
## Getting started using the FlexConnect package directly
20+
The template repository is set up with project infrastructure and boilerplate related to testing, packaging and
21+
running your FlexConnect functions. You can start building your own data source in under a minute.
2322

24-
Install the package alongside the gooddata-flight-server using pip:
23+
The template repository comes with documentation which will guide you through all important steps and facets
24+
of building production-ready FlexConnect functions.
2525

26-
```bash
27-
pip install gooddata-flight-server gooddata-flexconnect
28-
```
29-
30-
Next, update the GoodData Flight Server configuration to load the FlexConnect functions.
31-
32-
```toml
33-
[flexconnect]
34-
35-
# specify one or more modules that contain your FlexConnect function implementations
36-
#
37-
functions = [
38-
"flexconnect.your_function"
39-
]
40-
```
41-
42-
Then when running the GoodData Flight Server, use the `--methods-provider` option to load the FlexConnect.
43-
For example:
44-
45-
```bash
46-
#!/bin/bash
47-
48-
SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )"
49-
SERVER_CMD="${SCRIPT_DIR}/.venv/bin/gooddata-flight-server"
50-
51-
export PYTHONPATH="${SCRIPT_DIR}/src"
52-
export CONFIG_ENV="${1:-dev}"
26+
If you are eager to get started, here is a short snippet to a new FlexConnect project:
5327

54-
$SERVER_CMD start \
55-
--methods-provider gooddata_flexconnect \
56-
--config \
57-
config/${CONFIG_ENV}.server.toml \
58-
config/flexconnect.config.toml \
59-
--logging-config config/default.logging.ini \
60-
--dev-log
28+
```shell
29+
git clone git@github.com:gooddata/gooddata-flexconnect-template.git my-flexconnect
30+
cd my-flexconnect
31+
rm -rf .git && git init && git add . && git commit -m "Initial commit"
6132
```

0 commit comments

Comments
 (0)