DP-2433: adding exporting documentation #298

Mara3l · 2023-07-27T06:40:53Z

No description provided.

ghost · 2023-07-27T06:40:58Z

Build succeeded (check pipeline).

ghost · 2023-07-27T06:43:59Z

Build succeeded (check pipeline).

codecov-commenter · 2023-07-27T06:45:03Z

Codecov Report

Merging #298 (fd9d011) into master (e28be3c) will decrease coverage by 0.12%.
Report is 10 commits behind head on master.
The diff coverage is 100.00%.

❗ Current head fd9d011 differs from pull request most recent head ae79bdc. Consider uploading reports for the commit ae79bdc to get more accurate results

❗ Your organization is not using the GitHub App Integration. As a result you may experience degraded service beginning May 15th. Please install the Github App Integration for your organization. Read more.

@@            Coverage Diff             @@
##           master     #298      +/-   ##
==========================================
- Coverage   91.39%   91.27%   -0.12%     
==========================================
  Files          85       85              
  Lines        5622     5664      +42     
==========================================
+ Hits         5138     5170      +32     
- Misses        484      494      +10

Files Changed	Coverage Δ
...ooddata-sdk/gooddata_sdk/catalog/export/request.py	`90.38% <ø> (ø)`
...ooddata-sdk/gooddata_sdk/catalog/export/service.py	`79.74% <100.00%> (+0.25%)`	⬆️

... and 4 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

ghost · 2023-07-27T06:49:04Z

Build succeeded (check pipeline).

hkad98 · 2023-07-28T06:15:36Z

docs/content/en/docs/execution/exports/_index.md

+        insight_id = "revenue",
+        file_format = "CSV",
+        # The flag use_labels ensures that names of columns are according to your model
+        use_labels = True,


Remove this argument. It is not there anymore.

docs/content/en/docs/execution/exports/export_pdf.md

docs/content/en/docs/execution/exports/export_tabular.md

hkad98 · 2023-07-28T06:19:09Z

docs/content/en/docs/execution/exports/export_tabular_by_insight_id.md

+The ID of the GoodData Insight.
+{{< /parameter >}}
+{{< parameter p_name="file_name" p_type="String" >}}
+The name of the PDF file (excluding the file extension). Defaults to Path.cwd()


Not true. First, it is not PDF. Second, it does not default to Path.cwd()

hkad98 · 2023-07-28T06:20:35Z

docs/content/en/docs/execution/exports/export_tabular_by_insight_id.md

+Configuration settings for the export. Defaults to None.
+{{< /parameter >}}
+{{< parameter p_name="store_path" p_type="Union[String, Path]" >}}
+The name of the PDF file (excluding the file extension). Defaults to Path.cwd()


hkad98 · 2023-07-28T06:21:27Z

docs/content/en/docs/execution/exports/export_tabular.md

+The ID of the GoodData Dashboard.
+{{< /parameter >}}
+{{< parameter p_name="file_name" p_type="String" >}}
+The name of the PDF file (excluding the file extension). Defaults to Path.cwd()


hkad98 · 2023-07-28T06:21:32Z

docs/content/en/docs/execution/exports/export_tabular.md

+The name of the PDF file (excluding the file extension). Defaults to Path.cwd()
+{{< /parameter >}}
+{{< parameter p_name="store_path" p_type="Union[String, Path]" >}}
+The name of the PDF file (excluding the file extension). Defaults to Path.cwd()


hkad98 · 2023-07-28T06:22:32Z

docs/content/en/docs/execution/exports/export_pdf.md

+The ID of the GoodData Dashboard.
+{{< /parameter >}}
+{{< parameter p_name="file_name" p_type="String" >}}
+The name of the PDF file (excluding the file extension). Defaults to Path.cwd()


Not true. Does not default to Path.cwd()

hkad98 · 2023-07-28T06:25:11Z

gooddata-sdk/gooddata_sdk/catalog/export/service.py

+    """
+    ExportService provides the ability to export PDF and Tabular data from GoodData Dashboards.
+    Attributes:
+        _entities_api:
+            A reference to the entities_api of GoodDataApiClient instance.
+        _actions_api:
+            A reference to the actions_api of GoodDataApiClient instance.
+    Methods:
+        _get_exported_content:
+            A static method that gets the exported content using the provided `get_func`.
+        _create_export:
+            A static method that creates an export and returns its ID.
+        _dashboard_id_exists:
+            Checks if the given dashboard_id exists in the workspace.
+        _export_common:
+            Common export method for handling the exports of PDF and Tabular.
+        export_pdf:
+            Export a PDF of a GoodData Dashboard.
+        export_tabular:
+            Export Tabular data from a GoodData Dashboard.
+    """


Missing export_tabular_by_insight_id and its documentation.

https://github.com/gooddata/gooddata-python-sdk/pull/298/files/d4ae9dfde8984fe2689b4380eb837a711d4e2e8b#diff-1677d7224ec9ee5fcb82788347dd5058125ffa02c8570f8417b63b86b9dab2fdR277

I mean the documentation in the context of service.py.

ExportService docstring

ghost · 2023-07-28T08:00:10Z

Build succeeded (check pipeline).

ghost · 2023-07-28T08:47:06Z

Build succeeded (check pipeline).

ghost · 2023-07-30T21:22:11Z

Build succeeded (check pipeline).

ghost · 2023-07-30T21:24:24Z

Build succeeded (check pipeline).

yenkins · 2023-07-31T06:16:00Z

Sonar scan result

More detail, see in https://sonarqube-gate.intgdc.com/dashboard?id=gooddata-python-sdk-gate-PR298

To scan for vulnerabilities in dependencies and run unit tests (to get coverage report in sonar) please comment your PR with 'extended check sonar'.

ghost · 2023-07-31T06:16:30Z

Build succeeded (gate pipeline).

https://checklist.intgdc.com/job/compliance/job/gooddata-python-sdk-fossa-scanning-zuul/114/ : FAILURE in 1m 15s (non-voting)
https://checklist.intgdc.com/job/compliance/job/gooddata-python-sdk-sonarqube-scan-zuul-gate/264/ : SUCCESS in 49s
https://checklist.intgdc.com/job/compliance/job/gooddata-python-sdk-merge-compliance-check/267/ : SUCCESS in 11s

Mara3l requested review from lupko, pcerny, jaceksan and hkad98 as code owners July 27, 2023 06:40

Mara3l force-pushed the DP-2433-exporting branch from efca507 to 63ee17b Compare July 27, 2023 06:43

Mara3l force-pushed the DP-2433-exporting branch from 63ee17b to d4ae9df Compare July 27, 2023 06:48

hkad98 reviewed Jul 28, 2023

View reviewed changes

docs/content/en/docs/execution/exports/export_pdf.md Show resolved Hide resolved

hkad98 reviewed Jul 28, 2023

View reviewed changes

docs/content/en/docs/execution/exports/export_pdf.md Show resolved Hide resolved

hkad98 reviewed Jul 28, 2023

View reviewed changes

docs/content/en/docs/execution/exports/export_tabular.md Show resolved Hide resolved

hkad98 reviewed Jul 28, 2023

View reviewed changes

docs/content/en/docs/execution/exports/export_tabular.md Show resolved Hide resolved

hkad98 reviewed Jul 28, 2023

View reviewed changes

Mara3l force-pushed the DP-2433-exporting branch from 62db571 to 9419815 Compare July 28, 2023 08:47

DP-2433: adding exporting documentation

ae79bdc

Mara3l force-pushed the DP-2433-exporting branch from fd9d011 to ae79bdc Compare July 30, 2023 21:24

hkad98 approved these changes Jul 31, 2023

View reviewed changes

hkad98 added the merge label Jul 31, 2023

ghost removed the merge label Jul 31, 2023

ghost merged commit 2e47533 into gooddata:master Jul 31, 2023
8 checks passed

Mara3l deleted the DP-2433-exporting branch August 30, 2023 06:22

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DP-2433: adding exporting documentation #298

DP-2433: adding exporting documentation #298

Mara3l commented Jul 27, 2023

ghost commented Jul 27, 2023

ghost commented Jul 27, 2023

codecov-commenter commented Jul 27, 2023 •

edited

Loading

ghost commented Jul 27, 2023

hkad98 Jul 28, 2023

Mara3l Jul 28, 2023

hkad98 Jul 28, 2023 •

edited

Loading

hkad98 Jul 28, 2023

hkad98 Jul 28, 2023

hkad98 Jul 28, 2023

hkad98 Jul 28, 2023

hkad98 Jul 28, 2023 •

edited

Loading

Mara3l Jul 28, 2023

hkad98 Jul 28, 2023

Mara3l Jul 28, 2023

ghost commented Jul 28, 2023

ghost commented Jul 28, 2023

ghost commented Jul 30, 2023

ghost commented Jul 30, 2023

yenkins commented Jul 31, 2023

ghost commented Jul 31, 2023

DP-2433: adding exporting documentation #298

DP-2433: adding exporting documentation #298

Conversation

Mara3l commented Jul 27, 2023

ghost commented Jul 27, 2023

ghost commented Jul 27, 2023

codecov-commenter commented Jul 27, 2023 • edited Loading

Codecov Report

ghost commented Jul 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hkad98 Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hkad98 Jul 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Jul 28, 2023

ghost commented Jul 28, 2023

ghost commented Jul 30, 2023

ghost commented Jul 30, 2023

yenkins commented Jul 31, 2023

Sonar scan result

ghost commented Jul 31, 2023

codecov-commenter commented Jul 27, 2023 •

edited

Loading

hkad98 Jul 28, 2023 •

edited

Loading

hkad98 Jul 28, 2023 •

edited

Loading