gooddata-sdk 1.22.1.dev3__tar.gz → 1.23.1.dev1__tar.gz

{gooddata_sdk-1.22.1.dev3/gooddata_sdk.egg-info → gooddata_sdk-1.23.1.dev1}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-sdk
-Version: 1.22.1.dev3
+Version: 1.23.1.dev1
 Summary: GoodData Cloud Python SDK
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.22.1.dev3
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.23.1.dev1
 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
@@ -23,7 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-api-client~=1.22.1.dev3
+Requires-Dist: gooddata-api-client~=1.23.1.dev1
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: attrs<=23.2.0,>=21.4.0
@@ -47,7 +47,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.22.1.dev3) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.23.1.dev1) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/README.md

@@ -13,7 +13,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.22.1.dev3) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.23.1.dev1) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/__init__.py

@@ -56,6 +56,7 @@ from gooddata_sdk.catalog.depends_on import CatalogDependsOn, CatalogDependsOnDa
 from gooddata_sdk.catalog.entity import (
     AttrCatalogEntity,
     BasicCredentials,
+    KeyPairCredentials,
     TokenCredentialsFromEnvVar,
     TokenCredentialsFromFile,
 )

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/catalog/data_source/declarative_model/data_source.py

@@ -97,8 +97,6 @@ class CatalogDeclarativeDataSource(Base):
     type: str = attr.field(validator=value_in_allowed)
     url: Optional[str] = None
     schema: str
-    enable_caching: Optional[bool] = None
-    cache_path: Optional[List[str]] = None
     cache_strategy: Optional[str] = None
     username: Optional[str] = None
     parameters: Optional[List[CatalogParameter]] = None
@@ -109,6 +107,8 @@ class CatalogDeclarativeDataSource(Base):
         self,
         password: Optional[str] = None,
         token: Optional[str] = None,
+        private_key: Optional[str] = None,
+        private_key_passphrase: Optional[str] = None,
     ) -> TestDefinitionRequest:
         kwargs: dict[str, Any] = {"schema": self.schema}
         if password is not None:
@@ -117,6 +117,10 @@ class CatalogDeclarativeDataSource(Base):
             kwargs["token"] = token
         if self.username is not None:
             kwargs["username"] = self.username
+        if private_key is not None:
+            kwargs["private_key"] = private_key
+        if private_key_passphrase is not None:
+            kwargs["private_key_passphrase"] = private_key
         return TestDefinitionRequest(type=self.type, url=self.url, **kwargs)
 
     @staticmethod
@@ -129,12 +133,22 @@ class CatalogDeclarativeDataSource(Base):
         create_directory(data_source_folder)
         return data_source_folder
 
-    def to_api(self, password: Optional[str] = None, token: Optional[str] = None) -> DeclarativeDataSource:
+    def to_api(
+        self,
+        password: Optional[str] = None,
+        token: Optional[str] = None,
+        private_key: Optional[str] = None,
+        private_key_passphrase: Optional[str] = None,
+    ) -> DeclarativeDataSource:
         dictionary = self._get_snake_dict()
         if password is not None:
             dictionary["password"] = password
         if token is not None:
             dictionary["token"] = token
+        if private_key is not None:
+            dictionary["private_key"] = private_key
+        if private_key_passphrase is not None:
+            dictionary["private_key_passphrase"] = private_key_passphrase
         return self.client_class().from_dict(dictionary)
 
     def store_to_disk(self, data_sources_folder: Path) -> None:

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/catalog/data_source/entity_model/data_source.py

@@ -13,7 +13,13 @@ from gooddata_api_client.model.json_api_data_source_patch_attributes import Json
 from gooddata_api_client.model.json_api_data_source_patch_document import JsonApiDataSourcePatchDocument
 
 from gooddata_sdk.catalog.base import Base, value_in_allowed
-from gooddata_sdk.catalog.entity import BasicCredentials, Credentials, TokenCredentials, TokenCredentialsFromFile
+from gooddata_sdk.catalog.entity import (
+    BasicCredentials,
+    Credentials,
+    KeyPairCredentials,
+    TokenCredentials,
+    TokenCredentialsFromFile,
+)
 
 U = TypeVar("U", bound="CatalogDataSourceBase")
 
@@ -29,11 +35,10 @@ class CatalogDataSourceBase(Base):
         BasicCredentials,
         TokenCredentials,
         TokenCredentialsFromFile,
+        KeyPairCredentials,
     ]
     _DELIMITER: ClassVar[str] = "&"
     _ATTRIBUTES: ClassVar[List[str]] = [
-        "enable_caching",
-        "cache_path",
         "cache_strategy",
         "url",
         "parameters",
@@ -47,8 +52,6 @@ class CatalogDataSourceBase(Base):
     type: str = attr.field()
     schema: str
     url: Optional[str] = None
-    enable_caching: Optional[bool] = None
-    cache_path: Optional[List[str]] = None
     cache_strategy: Optional[str] = None
     parameters: Optional[List[Dict[str, str]]] = None
     decoded_parameters: Optional[List[Dict[str, str]]] = None
@@ -91,8 +94,6 @@ class CatalogDataSourceBase(Base):
             and self.name == other.name
             and self.type == other.type
             and self.schema == other.schema
-            and self.enable_caching == other.enable_caching
-            and self.cache_path == other.cache_path
             and self.parameters == other.parameters
         )
 

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/catalog/entity.py

@@ -118,6 +118,8 @@ class Credentials(Base):
     TOKEN_KEY: ClassVar[str] = "token"
     USER_KEY: ClassVar[str] = "username"
     PASSWORD_KEY: ClassVar[str] = "password"
+    PRIVATE_KEY: ClassVar[str] = "private_key"
+    PRIVATE_KEY_PASSPHRASE: ClassVar[str] = "private_key_passphrase"
 
     def to_api_args(self) -> dict[str, Any]:
         return attr.asdict(self)
@@ -228,3 +230,24 @@ class BasicCredentials(Credentials):
             # You have to fill it to keep it or update it
             password="",
         )
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class KeyPairCredentials(Credentials):
+    username: str
+    private_key: str = attr.field(repr=lambda value: "***")
+    private_key_passphrase: Optional[str] = attr.field(repr=lambda value: "***", default=None)
+
+    @classmethod
+    def is_part_of_api(cls, entity: dict[str, Any]) -> bool:
+        return cls.USER_KEY in entity and cls.PRIVATE_KEY in entity
+
+    @classmethod
+    def from_api(cls, attributes: dict[str, Any]) -> KeyPairCredentials:
+        # Credentials are not returned for security reasons
+        return cls(
+            username=attributes[cls.USER_KEY],
+            # Private key is not returned from API (security)
+            # You have to fill it to keep it or update it
+            private_key="",
+        )

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/catalog/export/service.py

@@ -1,11 +1,11 @@
 # (C) 2023 GoodData Corporation
 import time
 from pathlib import Path
-from typing import Callable, Optional, Tuple, Union
+from typing import Any, Callable, Dict, Optional, Tuple, Union
 
 from gooddata_api_client.exceptions import NotFoundException
-from gooddata_api_client.model.pdf_export_request import PdfExportRequest
 from gooddata_api_client.model.tabular_export_request import TabularExportRequest
+from gooddata_api_client.model.visual_export_request import VisualExportRequest
 
 from gooddata_sdk.catalog.catalog_service_base import CatalogServiceBase
 from gooddata_sdk.catalog.export.request import (
@@ -106,7 +106,7 @@ class ExportService(CatalogServiceBase):
 
     @staticmethod
     def _create_export(
-        workspace_id: str, request: Union[PdfExportRequest, TabularExportRequest], create_func: Callable
+        workspace_id: str, request: Union[VisualExportRequest, TabularExportRequest], create_func: Callable
     ) -> str:
         """
         Creates an export of the requested type (PDF or Tabular) in the specified Workspace.
@@ -145,7 +145,7 @@ class ExportService(CatalogServiceBase):
     def _export_common(
         self,
         workspace_id: str,
-        request: Union[PdfExportRequest, TabularExportRequest],
+        request: Union[VisualExportRequest, TabularExportRequest],
         file_path: Path,
         create_func: Callable,
         get_func: Callable,
@@ -189,6 +189,7 @@ class ExportService(CatalogServiceBase):
         timeout: float = 60.0,
         retry: float = 0.2,
         max_retry: float = 5.0,
+        metadata: Optional[Dict[str, Any]] = None,
     ) -> None:
         """
         Export a PDF of the specified GoodData Dashboard and save it to the specified file path.
@@ -200,18 +201,25 @@ class ExportService(CatalogServiceBase):
             file_name (str):
                 The name of the PDF file (excluding the file extension).
             store_path (Union[str, Path], optional):
-                The path to save the exported PDF. Defaults to the current directory.
+                The path to save the exported PDF.
+                Defaults to the current directory.
             timeout (float, optional):
-                The maximum amount of time (in seconds) to wait for the server to process the export. Defaults to 60.0.
+                The maximum amount of time (in seconds) to wait for the server to process the export.
+                Defaults to 60.0.
             retry (float, optional):
-                Initial wait time (in seconds) before retrying to get the exported content. Defaults to 0.2.
+                Initial wait time (in seconds) before retrying to get the exported content.
+                Defaults to 0.2.
             max_retry (float, optional):
-                The maximum retry wait time (in seconds). Defaults to 5.0.
+                The maximum retry wait time (in seconds).
+                Defaults to 5.0.
+            metadata (Dict[str, Any]):
+                Specify the metadata for the export.
+                Specific metadata can override filtering.
         """
         if not self._dashboard_id_exists(workspace_id, dashboard_id):
             raise ValueError(f"Dashboard id '{dashboard_id}' does not exist for workspace '{workspace_id}'.")
         store_path = store_path if isinstance(store_path, Path) else Path(store_path)
-        request = PdfExportRequest(dashboard_id=dashboard_id, file_name=file_name)
+        request = VisualExportRequest(dashboard_id=dashboard_id, file_name=file_name, metadata=metadata)
         file_path = store_path / f"{file_name}.pdf"
         create_func = self._actions_api.create_pdf_export
         get_func = self._actions_api.get_exported_file

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/catalog/workspace/content_service.py

@@ -374,8 +374,9 @@ class CatalogWorkspaceContentService(CatalogServiceBase):
         """
         if exclude is None:
             exclude = []
-        return CatalogDeclarativeAnalytics.from_api(
-            self._layout_api.get_analytics_model(workspace_id=workspace_id, exclude=exclude)
+        return CatalogDeclarativeAnalytics.from_dict(
+            self._layout_api.get_analytics_model(workspace_id=workspace_id, exclude=exclude).to_dict(camel_case=False),
+            camel_case=False,
         )
 
     def put_declarative_analytics_model(self, workspace_id: str, analytics_model: CatalogDeclarativeAnalytics) -> None:

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/catalog/workspace/service.py

@@ -239,7 +239,9 @@ class CatalogWorkspaceService(CatalogServiceBase):
         """
         if exclude is None:
             exclude = []
-        return CatalogDeclarativeWorkspaces.from_api(self._layout_api.get_workspaces_layout(exclude=exclude))
+        return CatalogDeclarativeWorkspaces.from_dict(
+            self._layout_api.get_workspaces_layout(exclude=exclude).to_dict(camel_case=False), camel_case=False
+        )
 
     def put_declarative_workspaces(self, workspace: CatalogDeclarativeWorkspaces) -> None:
         """Set layout of all workspaces and their hierarchy. Parameter is in declarative form.
@@ -313,8 +315,9 @@ class CatalogWorkspaceService(CatalogServiceBase):
         """
         if exclude is None:
             exclude = []
-        return CatalogDeclarativeWorkspaceModel.from_api(
-            self._layout_api.get_workspace_layout(workspace_id=workspace_id, exclude=exclude)
+        return CatalogDeclarativeWorkspaceModel.from_dict(
+            self._layout_api.get_workspace_layout(workspace_id=workspace_id, exclude=exclude).to_dict(camel_case=False),
+            camel_case=False,
         )
 
     def put_declarative_workspace(

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/compute/model/execution.py

@@ -33,7 +33,7 @@ class TotalDefinition:
     """total's local identifier"""
 
     aggregation: str
-    """aggregation function; case insensitive; one of SUM, MIN, MAX, MED, AVG"""
+    """aggregation function; case insensitive; one of SUM, MIN, MAX, MED, AVG, NAT"""
 
     metric_local_id: str
     """local identifier of the measure to calculate total for"""

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk/table.py

@@ -38,7 +38,7 @@ from gooddata_sdk.visualization import (
 logger = logging.getLogger(__name__)
 
 _MEASURE_GROUP_IDENTIFIER = "measureGroup"
-_TOTAL_ORDER = ["SUM", "MAX", "MIN", "AVG", "MED"]
+_TOTAL_ORDER = ["SUM", "MAX", "MIN", "AVG", "MED", "NAT"]
 
 _TABLE_ROW_BATCH_SIZE = 512
 """

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1/gooddata_sdk.egg-info}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.1
 Name: gooddata-sdk
-Version: 1.22.1.dev3
+Version: 1.23.1.dev1
 Summary: GoodData Cloud Python SDK
 Author: GoodData
 Author-email: support@gooddata.com
 License: MIT
-Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.22.1.dev3
+Project-URL: Documentation, https://www.gooddata.com/docs/python-sdk/1.23.1.dev1
 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
@@ -23,7 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.8.0
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-Requires-Dist: gooddata-api-client~=1.22.1.dev3
+Requires-Dist: gooddata-api-client~=1.23.1.dev1
 Requires-Dist: python-dateutil>=2.5.3
 Requires-Dist: pyyaml>=5.1
 Requires-Dist: attrs<=23.2.0,>=21.4.0
@@ -47,7 +47,7 @@ At the moment the SDK provides services to inspect and interact with the Semanti
 * Compute Service
 * Table Service
 
-See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.22.1.dev3) for more details.
+See [DOCUMENTATION](https://www.gooddata.com/docs/python-sdk/1.23.1.dev1) for more details.
 
 ## Requirements
 

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/gooddata_sdk.egg-info/requires.txt

@@ -1,4 +1,4 @@
-gooddata-api-client~=1.22.1.dev3
+gooddata-api-client~=1.23.1.dev1
 python-dateutil>=2.5.3
 pyyaml>=5.1
 attrs<=23.2.0,>=21.4.0

{gooddata_sdk-1.22.1.dev3 → gooddata_sdk-1.23.1.dev1}/setup.py

@@ -7,7 +7,7 @@ this_directory = Path(__file__).parent
 long_description = (this_directory / "README.md").read_text(encoding="utf-8")
 
 REQUIRES = [
-    "gooddata-api-client~=1.22.1.dev3",
+    "gooddata-api-client~=1.23.1.dev1",
     "python-dateutil>=2.5.3",
     "pyyaml>=5.1",
     "attrs>=21.4.0,<=23.2.0",
@@ -22,7 +22,7 @@ setup(
     description="GoodData Cloud Python SDK",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version="1.22.1.dev3",
+    version="1.23.1.dev1",
     author="GoodData",
     author_email="support@gooddata.com",
     license="MIT",
@@ -36,7 +36,7 @@ setup(
         "bin/gdc",
     ],
     project_urls={
-        "Documentation": "https://www.gooddata.com/docs/python-sdk/1.22.1.dev3",
+        "Documentation": "https://www.gooddata.com/docs/python-sdk/1.23.1.dev1",
         "Source": "https://github.com/gooddata/gooddata-python-sdk",
     },
     classifiers=[