PSDK-28 files updated to contain new package

hkad98 · hkad98 · commit cca26b7424c1 · 2022-10-04T15:27:20.000+02:00
diff --git a/.envrc b/.envrc
@@ -6,5 +6,6 @@ source .venv/bin/activate
 export PYTHONPATH="${PYTHONPATH}:${SCRIPT_DIR}/gooddata-afm-client/"
 export PYTHONPATH="${PYTHONPATH}:${SCRIPT_DIR}/gooddata-metadata-client/"
 export PYTHONPATH="${PYTHONPATH}:${SCRIPT_DIR}/gooddata-scan-client/"
+export PYTHONPATH="${PYTHONPATH}:${SCRIPT_DIR}/gooddata-api-client/"
 export PYTHONPATH="${PYTHONPATH}:${SCRIPT_DIR}/gooddata-sdk/"
 export PYTHONPATH="${PYTHONPATH}:${SCRIPT_DIR}/gooddata-pandas/"
diff --git a/.flake8 b/.flake8
@@ -1,6 +1,6 @@
 # (C) 2021 GoodData Corporation
 [flake8]
-exclude = .git,.venv,__pycache__,.tox,build,dist,gooddata-afm-client,gooddata-metadata-client,gooddata-scan-client
+exclude = .git,.venv,__pycache__,.tox,build,dist,gooddata-afm-client,gooddata-metadata-client,gooddata-scan-client,gooddata-api-client
 
 max-line-length = 120
 
diff --git a/.fossa/prepare_and_populate_pipenv.sh b/.fossa/prepare_and_populate_pipenv.sh
@@ -24,18 +24,22 @@ cd ./gooddata-scan-client
 pipenv install --skip-lock -r requirements.txt
 cd ..
 
+cd ./gooddata-api-client
+pipenv install --skip-lock -r requirements.txt
+cd ..
+
 cd ./gooddata-sdk
-pipenv install --skip-lock ../gooddata-afm-client/ ../gooddata-metadata-client/ ../gooddata-scan-client/ \
+pipenv install --skip-lock ../gooddata-afm-client/ ../gooddata-metadata-client/ ../gooddata-scan-client/ ../gooddata-api-client/ \
 -r requirements.txt
 cd ..
 
 cd ./gooddata-fdw
-pipenv install --skip-lock ../gooddata-afm-client/ ../gooddata-metadata-client/ ../gooddata-scan-client/ \
+pipenv install --skip-lock ../gooddata-afm-client/ ../gooddata-metadata-client/ ../gooddata-scan-client/ ../gooddata-api-client/ \
 ../gooddata-sdk/ -r requirements.txt
 cd ..
 
 cd ./gooddata-pandas
-pipenv install --skip-lock ../gooddata-afm-client/ ../gooddata-metadata-client/ ../gooddata-scan-client/ \
+pipenv install --skip-lock ../gooddata-afm-client/ ../gooddata-metadata-client/ ../gooddata-scan-client/ ../gooddata-api-client/ \
 ../gooddata-sdk/ -r requirements.txt
 cd ..
 
diff --git a/.github/workflows/build-release.yaml b/.github/workflows/build-release.yaml
@@ -23,6 +23,7 @@ jobs:
           - gooddata-afm-client
           - gooddata-metadata-client
           - gooddata-scan-client
+          - gooddata-api-client
           - gooddata-pandas
           - gooddata-fdw
           - gooddata-sdk
@@ -74,6 +75,7 @@ jobs:
           - gooddata-afm-client
           - gooddata-metadata-client
           - gooddata-scan-client
+          - gooddata-api-client
           - gooddata-pandas
           - gooddata-fdw
           - gooddata-sdk
diff --git a/.openapi-generator/README.md b/.openapi-generator/README.md
@@ -13,9 +13,7 @@ OpenAPI client generation is orchestrated by script `scripts/generate_client.sh`
 if no such exists or updates existing client code.
 
 Use prepared `make` targets from repository root:
-- `make afm-client`
-- `make metadata-client`
-- `make scan-client`
+- `make api-client`
 
 Predefined targets use `http://gooddata-cn-ce:3000` URL to fetch OpenAPI schema and connect generator container to
 the `gooddata-python-sdk_default` network. It is prepared to be executed against running `docker-compose.yaml`
diff --git a/.sonar.settings b/.sonar.settings
@@ -1,4 +1,4 @@
 # (C) 2021 GoodData Corporation
 sonar.sources=gooddata-sdk,gooddata-fdw,gooddata-pandas
-sonar.exclusions=gooddata-afm-client/**/*,gooddata-metadata-client/**/*,gooddata-scan-client/**/*
+sonar.exclusions=gooddata-afm-client/**/*,gooddata-metadata-client/**/*,gooddata-scan-client/**/*,gooddata-api-client/**/*
 sonar.python.version=3.7, 3.8, 3.9, 3.10
diff --git a/.sonarcloud.properties b/.sonarcloud.properties
@@ -1,4 +1,4 @@
 # (C) 2022 GoodData Corporation
 sonar.sources=gooddata-sdk,gooddata-fdw,gooddata-pandas
-sonar.exclusions=gooddata-afm-client/**/*,gooddata-metadata-client/**/*,gooddata-scan-client/**/*
+sonar.exclusions=gooddata-afm-client/**/*,gooddata-metadata-client/**/*,gooddata-scan-client/**/*,gooddata-api-client/**/*
 sonar.python.version=3.7, 3.8, 3.9, 3.10
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -7,4 +7,4 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 -----------------------
 
-This repository includes source code for gooddata-sdk, gooddata-fdw, gooddata-pandas, gooddata-scan-client, gooddata-metadata-client, and gooddata-afm-client, each of which is licensed under the MIT license above. For additional licensing information related to open source packages included in each of these projects, please see the OSS LICENSES directory.
+This repository includes source code for gooddata-sdk, gooddata-fdw, gooddata-pandas, gooddata-scan-client, gooddata-metadata-client, gooddata-afm-client, and gooddata-api-client, each of which is licensed under the MIT license above. For additional licensing information related to open source packages included in each of these projects, please see the OSS LICENSES directory.
diff --git a/README.md b/README.md
@@ -9,9 +9,9 @@ This repository contains Python packages useful for integration with [GoodData.C
 
 ## Available packages
 
-### GoodData API Clients
+### GoodData API Client
 
-API clients are generated directly from the GoodData.CN OpenAPI specifications and allow you to call any API from
+API client is generated directly from the GoodData.CN OpenAPI specifications and allow you to call any API from
 Python. Learn more about the clients in their [dedicated readme](./clients_README.md).
 
 ### GoodData Python SDK
diff --git a/clients_README.md b/clients_README.md
@@ -1,6 +1,6 @@
 # Generated API Clients
 
-The generated clients provide Python classes that you can use to call GoodData.CN REST APIs. The clients contain
+The generated client provide Python classes that you can use to call GoodData.CN REST APIs. The client contains
 models for API requests and responses and controllers to actually call the APIs.
 
 We recommend using the gooddata_sdk package where possible because:
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -8,6 +8,7 @@ pre-commit~=2.14.0
 -r ./gooddata-afm-client/requirements.txt
 -r ./gooddata-metadata-client/requirements.txt
 -r ./gooddata-scan-client/requirements.txt
+-r ./gooddata-api-client/requirements.txt
 -r ./gooddata-sdk/requirements.txt
 -r ./gooddata-pandas/requirements.txt
 -r ./gooddata-fdw/requirements.txt
diff --git a/gooddata-fdw/docs/requirements.txt b/gooddata-fdw/docs/requirements.txt
@@ -3,8 +3,6 @@ pallets-sphinx-themes
 sphinx-rtd-theme
 # Dependencies to the other projects in the repository
 # CWD_TO_ROOT_RELATIVE defines path to root of repository - it can differ for tox and readthedocs builds
--e${CWD_TO_ROOT_RELATIVE}/gooddata-metadata-client
--e${CWD_TO_ROOT_RELATIVE}/gooddata-afm-client
--e${CWD_TO_ROOT_RELATIVE}/gooddata-scan-client
+-e${CWD_TO_ROOT_RELATIVE}/gooddata-api-client
 -e${CWD_TO_ROOT_RELATIVE}/gooddata-sdk
 -e${CWD_TO_ROOT_RELATIVE}/gooddata-fdw
diff --git a/gooddata-fdw/mypy.ini b/gooddata-fdw/mypy.ini
@@ -15,5 +15,8 @@ ignore_missing_imports = True
 [mypy-gooddata_scan_client.*]
 ignore_missing_imports = True
 
+[mypy-gooddata_api_client.*]
+ignore_missing_imports = True
+
 [mypy-multicorn.*]
 ignore_missing_imports = True
diff --git a/gooddata-fdw/tox.ini b/gooddata-fdw/tox.ini
@@ -5,9 +5,7 @@ envlist = py310, py39, py38, py37
 [testenv]
 deps =
     -r{toxinidir}/test-requirements.txt
-    -e../gooddata-metadata-client
-    -e../gooddata-afm-client
-    -e../gooddata-scan-client
+    -e../gooddata-api-client
     -e../gooddata-sdk
     -e../tests-support
 setenv=
@@ -20,10 +18,9 @@ basepython = python3.10
 skip_install = true
 deps =
     -r{toxinidir}/type-requirements.txt
-    -e../gooddata-metadata-client
-    -e../gooddata-afm-client
-    -e../gooddata-scan-client
+    -e../gooddata-api-client
     -e../gooddata-sdk
+    -e../tests-support
 commands =
     mypy gooddata_fdw
 
diff --git a/gooddata-pandas/docs/requirements.txt b/gooddata-pandas/docs/requirements.txt
@@ -3,8 +3,6 @@ pallets-sphinx-themes
 sphinx-rtd-theme
 # Dependencies to the other projects in the repository
 # CWD_TO_ROOT_RELATIVE defines path to root of repository - it can differ for tox and readthedocs builds
--e${CWD_TO_ROOT_RELATIVE}/gooddata-metadata-client
--e${CWD_TO_ROOT_RELATIVE}/gooddata-afm-client
--e${CWD_TO_ROOT_RELATIVE}/gooddata-scan-client
+-e${CWD_TO_ROOT_RELATIVE}/gooddata-api-client
 -e${CWD_TO_ROOT_RELATIVE}/gooddata-sdk
 -e${CWD_TO_ROOT_RELATIVE}/gooddata-pandas
diff --git a/gooddata-pandas/mypy.ini b/gooddata-pandas/mypy.ini
@@ -15,5 +15,8 @@ ignore_missing_imports = True
 [mypy-gooddata_scan_client.*]
 ignore_missing_imports = True
 
+[mypy-gooddata_api_client.*]
+ignore_missing_imports = True
+
 [mypy-pandas.*]
 ignore_missing_imports = True
diff --git a/gooddata-pandas/tox.ini b/gooddata-pandas/tox.ini
@@ -5,9 +5,7 @@ envlist = py310, py39, py38, py37
 [testenv]
 deps =
     -r{toxinidir}/test-requirements.txt
-    -e../gooddata-metadata-client
-    -e../gooddata-afm-client
-    -e../gooddata-scan-client
+    -e../gooddata-api-client
     -e../gooddata-sdk
     -e../tests-support
 setenv=
@@ -20,9 +18,7 @@ basepython = python3.10
 skip_install = true
 deps =
     -r{toxinidir}/type-requirements.txt
-    -e../gooddata-metadata-client
-    -e../gooddata-afm-client
-    -e../gooddata-scan-client
+    -e../gooddata-api-client
     -e../gooddata-sdk
 commands =
     mypy gooddata_pandas
diff --git a/gooddata-sdk/docs/requirements.txt b/gooddata-sdk/docs/requirements.txt
@@ -3,7 +3,5 @@ pallets-sphinx-themes
 sphinx-rtd-theme
 # Dependencies to the other projects in the repository
 # CWD_TO_ROOT_RELATIVE defines path to root of repository - it can differ for tox and readthedocs builds
--e${CWD_TO_ROOT_RELATIVE}/gooddata-metadata-client
--e${CWD_TO_ROOT_RELATIVE}/gooddata-afm-client
--e${CWD_TO_ROOT_RELATIVE}/gooddata-scan-client
+-e${CWD_TO_ROOT_RELATIVE}/gooddata-api-client
 -e${CWD_TO_ROOT_RELATIVE}/gooddata-sdk
diff --git a/gooddata-sdk/mypy.ini b/gooddata-sdk/mypy.ini
@@ -15,5 +15,8 @@ ignore_missing_imports = True
 [mypy-gooddata_scan_client.*]
 ignore_missing_imports = True
 
+[mypy-gooddata_api_client.*]
+ignore_missing_imports = True
+
 [mypy-urllib3.*]
 ignore_missing_imports = True
diff --git a/gooddata-sdk/tox.ini b/gooddata-sdk/tox.ini
@@ -5,10 +5,8 @@ envlist = py310, py39, py38, py37
 [testenv]
 deps =
     -r{toxinidir}/test-requirements.txt
-    -e../gooddata-metadata-client
-    -e../gooddata-afm-client
-    -e../gooddata-scan-client
-    ../tests-support
+    -e../gooddata-api-client
+    -e../tests-support
 setenv=
     PYTHONDONTWRITEBYTECODE=1
 commands =
@@ -19,9 +17,7 @@ basepython = python3.10
 skip_install = true
 deps =
     -r{toxinidir}/type-requirements.txt
-    -e../gooddata-metadata-client
-    -e../gooddata-afm-client
-    -e../gooddata-scan-client
+    -e../gooddata-api-client
 commands =
     mypy gooddata_sdk
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -2,19 +2,20 @@
 [tool.black]
 line-length = 120
 # intentionally ignore the generated clients
-extend-exclude = '(gooddata-afm-client|gooddata-metadata-client|gooddata-scan-client|.*\.snapshot\..*)'
+extend-exclude = '(gooddata-afm-client|gooddata-metadata-client|gooddata-scan-client|gooddata-api-client|.*\.snapshot\..*)'
 
 [tool.isort]
 # make isort setup compatible with black
 profile = "black"
 multi_line_output = 3
 include_trailing_comma = true
 line_length = 120
-skip_glob = ["*/gooddata-afm-client/*","*/gooddata-metadata-client/*","*/gooddata-scan-client/*", "*/.snapshot/*"]
+skip_glob = ["*/gooddata-afm-client/*","*/gooddata-metadata-client/*","*/gooddata-scan-client/*","*/gooddata-api-client/*","*/.snapshot/*"]
 src_paths = [
     "gooddata-afm-client",
     "gooddata-metadata-client",
     "gooddata-scan-client",
+    "gooddata-api-client",
     "gooddata-sdk",
     "gooddata-fdw",
     "gooddata-pandas"
