gooddata-pipelines 1.52.0__py3-none-any.whl → 1.52.1.dev2__py3-none-any.whl

gooddata_pipelines/__init__.py

@@ -51,6 +51,10 @@ from .provisioning.entities.workspaces.models import (
 )
 from .provisioning.entities.workspaces.workspace import WorkspaceProvisioner
 
+# -------- Generic Provisioning --------
+from .provisioning.generic.config import WorkflowType
+from .provisioning.generic.provision import provision
+
 __all__ = [
     "BackupManager",
     "BackupRestoreConfig",
@@ -79,5 +83,7 @@ __all__ = [
     "CustomFieldDefinition",
     "ColumnDataType",
     "CustomFieldType",
+    "provision",
+    "WorkflowType",
     "__version__",
 ]

gooddata_pipelines/provisioning/generic/__init__.py

@@ -0,0 +1 @@
+# (C) 2025 GoodData Corporation

gooddata_pipelines/provisioning/generic/config.py

@@ -0,0 +1,118 @@
+# (C) 2025 GoodData Corporation
+
+from enum import Enum
+from typing import Type, TypeAlias
+
+import attrs
+
+from gooddata_pipelines.provisioning.entities.users.models.permissions import (
+    PermissionFullLoad,
+    PermissionIncrementalLoad,
+)
+from gooddata_pipelines.provisioning.entities.users.models.user_groups import (
+    UserGroupFullLoad,
+    UserGroupIncrementalLoad,
+)
+from gooddata_pipelines.provisioning.entities.users.models.users import (
+    UserFullLoad,
+    UserIncrementalLoad,
+)
+from gooddata_pipelines.provisioning.entities.users.permissions import (
+    PermissionProvisioner,
+)
+from gooddata_pipelines.provisioning.entities.users.user_groups import (
+    UserGroupProvisioner,
+)
+from gooddata_pipelines.provisioning.entities.users.users import UserProvisioner
+from gooddata_pipelines.provisioning.entities.workspaces.models import (
+    WorkspaceFullLoad,
+    WorkspaceIncrementalLoad,
+)
+from gooddata_pipelines.provisioning.entities.workspaces.workspace import (
+    WorkspaceProvisioner,
+)
+
+ValidationModel: TypeAlias = (
+    PermissionFullLoad
+    | PermissionIncrementalLoad
+    | UserFullLoad
+    | UserIncrementalLoad
+    | UserGroupFullLoad
+    | UserGroupIncrementalLoad
+    | WorkspaceFullLoad
+    | WorkspaceIncrementalLoad
+)
+
+Provisioner: TypeAlias = (
+    PermissionProvisioner
+    | UserProvisioner
+    | UserGroupProvisioner
+    | WorkspaceProvisioner
+)
+
+
+class LoadType(str, Enum):
+    FULL = "full"
+    INCREMENTAL = "incremental"
+
+
+class WorkflowType(str, Enum):
+    WORKSPACE_FULL_LOAD = "workspace_full_load"
+    WORKSPACE_INCREMENTAL_LOAD = "workspace_incremental_load"
+    USER_FULL_LOAD = "user_full_load"
+    USER_INCREMENTAL_LOAD = "user_incremental_load"
+    USER_GROUP_FULL_LOAD = "user_group_full_load"
+    USER_GROUP_INCREMENTAL_LOAD = "user_group_incremental_load"
+    PERMISSION_FULL_LOAD = "permission_full_load"
+    PERMISSION_INCREMENTAL_LOAD = "permission_incremental_load"
+
+
+@attrs.define
+class ProvisioningConfig:
+    validation_model: Type[ValidationModel]
+    provisioner_class: Type[Provisioner]
+    load_type: LoadType
+
+
+PROVISIONING_CONFIG = {
+    WorkflowType.WORKSPACE_FULL_LOAD: ProvisioningConfig(
+        validation_model=WorkspaceFullLoad,
+        provisioner_class=WorkspaceProvisioner,
+        load_type=LoadType.FULL,
+    ),
+    WorkflowType.WORKSPACE_INCREMENTAL_LOAD: ProvisioningConfig(
+        validation_model=WorkspaceIncrementalLoad,
+        provisioner_class=WorkspaceProvisioner,
+        load_type=LoadType.INCREMENTAL,
+    ),
+    WorkflowType.USER_FULL_LOAD: ProvisioningConfig(
+        validation_model=UserFullLoad,
+        provisioner_class=UserProvisioner,
+        load_type=LoadType.FULL,
+    ),
+    WorkflowType.USER_INCREMENTAL_LOAD: ProvisioningConfig(
+        validation_model=UserIncrementalLoad,
+        provisioner_class=UserProvisioner,
+        load_type=LoadType.INCREMENTAL,
+    ),
+    WorkflowType.USER_GROUP_FULL_LOAD: ProvisioningConfig(
+        validation_model=UserGroupFullLoad,
+        provisioner_class=UserGroupProvisioner,
+        load_type=LoadType.FULL,
+    ),
+    WorkflowType.USER_GROUP_INCREMENTAL_LOAD: ProvisioningConfig(
+        validation_model=UserGroupIncrementalLoad,
+        provisioner_class=UserGroupProvisioner,
+        load_type=LoadType.INCREMENTAL,
+    ),
+    WorkflowType.PERMISSION_FULL_LOAD: ProvisioningConfig(
+        validation_model=PermissionFullLoad,
+        provisioner_class=PermissionProvisioner,
+        load_type=LoadType.FULL,
+    ),
+    WorkflowType.PERMISSION_INCREMENTAL_LOAD: ProvisioningConfig(
+        validation_model=PermissionIncrementalLoad,
+        provisioner_class=PermissionProvisioner,
+        load_type=LoadType.INCREMENTAL,
+    ),
+}

gooddata_pipelines/provisioning/generic/provision.py

@@ -0,0 +1,49 @@
+# (C) 2025 GoodData Corporation
+
+from typing import Any
+
+from gooddata_pipelines.logger import LoggerLike
+from gooddata_pipelines.provisioning.generic.config import (
+    PROVISIONING_CONFIG,
+    LoadType,
+    WorkflowType,
+)
+
+
+def provision(
+    data: list[dict[str, Any]],
+    workflow_type: WorkflowType,
+    host: str,
+    token: str,
+    logger: LoggerLike | None = None,
+) -> None:
+    """Generic provisioning function accepting raw data and workflow type.
+
+    The function will validate data based on the selected workflow type and run
+    the corresponding provisioning in full or incremental mode.
+
+    Args:
+        data: List of dictionaries containing the data to be provisioned.
+        workflow_type: The type of workflow to run.
+        host: The host of the GoodData platform.
+        token: The token for the GoodData platform.
+        logger: The logger to use for logging.
+    """
+
+    if workflow_type not in PROVISIONING_CONFIG:
+        raise ValueError(f"Invalid workflow type: {workflow_type}")
+
+    config = PROVISIONING_CONFIG[workflow_type]
+
+    provisioner = config.provisioner_class.create(host, token)
+    validated_data: list = [config.validation_model(**item) for item in data]
+
+    if logger:
+        provisioner.logger.subscribe(logger)
+
+    if config.load_type == LoadType.FULL:
+        provisioner.full_load(validated_data)
+    elif config.load_type == LoadType.INCREMENTAL:
+        provisioner.incremental_load(validated_data)
+    else:
+        raise ValueError(f"Invalid load type: {config.load_type}")

{gooddata_pipelines-1.52.0.dist-info → gooddata_pipelines-1.52.1.dev2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gooddata-pipelines
-Version: 1.52.0
+Version: 1.52.1.dev2
 Summary: GoodData Cloud lifecycle automation pipelines
 Author-email: GoodData <support@gooddata.com>
 License: MIT
@@ -8,7 +8,7 @@ License-File: LICENSE.txt
 Requires-Python: >=3.10
 Requires-Dist: boto3-stubs<2.0.0,>=1.39.3
 Requires-Dist: boto3<2.0.0,>=1.39.3
-Requires-Dist: gooddata-sdk~=1.52.0
+Requires-Dist: gooddata-sdk~=1.52.1.dev2
 Requires-Dist: pydantic<3.0.0,>=2.11.3
 Requires-Dist: requests<3.0.0,>=2.32.3
 Requires-Dist: types-pyyaml<7.0.0,>=6.0.12.20250326
@@ -45,33 +45,37 @@ The provisioning module exposes _Provisioner_ classes reflecting the different e
 
 ```python
 import os
+import logging
+
 from csv import DictReader
 from pathlib import Path
 
 # Import the Entity Provisioner class and corresponding model from gooddata_pipelines library
 from gooddata_pipelines import UserFullLoad, UserProvisioner
-from gooddata_pipelines.logger.logger import LogObserver
-
-# Optionally, subscribe a standard Python logger to the LogObserver
-import logging
-logger = logging.getLogger(__name__)
-LogObserver().subscribe(logger)
 
 # Create the Provisioner instance - you can also create the instance from a GDC yaml profile
 provisioner = UserProvisioner(
     host=os.environ["GDC_HOSTNAME"], token=os.environ["GDC_AUTH_TOKEN"]
 )
 
+# Optional: set up logging and subscribe to logs emitted by the provisioner
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+provisioner.logger.subscribe(logger)
+
 # Load your data from your data source
 source_data_path: Path = Path("path/to/some.csv")
 source_data_reader = DictReader(source_data_path.read_text().splitlines())
 source_data = [row for row in source_data_reader]
 
-# Validate your input data with
+# Validate your input data
 full_load_data: list[UserFullLoad] = UserFullLoad.from_list_of_dicts(
     source_data
 )
+
+# Run the provisioning
 provisioner.full_load(full_load_data)
+
 ```
 
 ## Bugs & Requests
@@ -81,5 +85,5 @@ or request features.
 
 ## Changelog
 
-See  [Github releases](https://github.com/gooddata/gooddata-python-sdk/releases) for released versions
+See [Github releases](https://github.com/gooddata/gooddata-python-sdk/releases) for released versions
 and a list of changes.

{gooddata_pipelines-1.52.0.dist-info → gooddata_pipelines-1.52.1.dev2.dist-info}/RECORD

@@ -1,4 +1,4 @@
-gooddata_pipelines/__init__.py,sha256=UyE19wWfPh2R_5O0KSAS4XLllP3km3iGkDzRQFBd7jQ,2415
+gooddata_pipelines/__init__.py,sha256=dGbyckzT8MrxL5SljSOj2jo5DFXZ2HYn0kBbAe0vO7s,2602
 gooddata_pipelines/_version.py,sha256=Zi8Ht5ofjFeSYGG5USixQtJNB1po6okh0Rez8VyAsFM,200
 gooddata_pipelines/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 gooddata_pipelines/api/__init__.py,sha256=0WaBI2XMdkkZgnUsQ9kqipNzh2l2zamZvUt_qjp8xCk,106
@@ -52,13 +52,16 @@ gooddata_pipelines/provisioning/entities/workspaces/workspace.py,sha256=jngaEKNl
 gooddata_pipelines/provisioning/entities/workspaces/workspace_data_filters.py,sha256=0dNcK7tkp40XulCj7EPoB4zVeyQbRx2Tt4yAfgLrm50,10736
 gooddata_pipelines/provisioning/entities/workspaces/workspace_data_parser.py,sha256=akiN8F9x-6xo7KXLJ40iOlmBImEKqWlGYlN3lpF4jQs,4562
 gooddata_pipelines/provisioning/entities/workspaces/workspace_data_validator.py,sha256=t6RWNsrDpebyOgB4c_ctqrkio72jBHqsXqk-ntBTkA4,7225
+gooddata_pipelines/provisioning/generic/__init__.py,sha256=-BG28PGDbalLyZGQjpFG0pjdIvtf25ut0r8ZwZVbi4s,32
+gooddata_pipelines/provisioning/generic/config.py,sha256=RMIa7UXiXRsodsHwmg_9w74m0WLDnEF6cce0OiDZWpQ,3689
+gooddata_pipelines/provisioning/generic/provision.py,sha256=TgBFbOroG9nHVhHQkqAmpYt2gDiaVkbMNyAVbazCwRg,1541
 gooddata_pipelines/provisioning/utils/__init__.py,sha256=-BG28PGDbalLyZGQjpFG0pjdIvtf25ut0r8ZwZVbi4s,32
 gooddata_pipelines/provisioning/utils/context_objects.py,sha256=HJoeumH_gXwM6X-GO3HkC4w-6RYozz6-aqQOhDnu7no,879
 gooddata_pipelines/provisioning/utils/exceptions.py,sha256=1WnAOlPhqOf0xRcvn70lxAlLb8Oo6m6WCYS4hj9uzDU,3630
 gooddata_pipelines/provisioning/utils/utils.py,sha256=u-nVVp6ykY4MZqRXBoPCKLrFlUunLF-cugF9SpSzL1E,2766
 gooddata_pipelines/utils/__init__.py,sha256=s9TtSjKqo1gSGWOVoGrXaGi1TsbRowjRDYKtjmKy7BY,155
 gooddata_pipelines/utils/rate_limiter.py,sha256=owbcEZhUxlTnE7rRHiWQ8XBC-vML2fVPbt41EeGEM7o,2002
-gooddata_pipelines-1.52.0.dist-info/METADATA,sha256=-v_fmBYAqn4r8jQ-tBiujOS2bnEIaJj1gokj1fuSMxE,3632
-gooddata_pipelines-1.52.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-gooddata_pipelines-1.52.0.dist-info/licenses/LICENSE.txt,sha256=PNC7WXGIo6OKkNoPLRxlVrw6jaLcjSTUsSxy9Xcu9Jo,560365
-gooddata_pipelines-1.52.0.dist-info/RECORD,,
+gooddata_pipelines-1.52.1.dev2.dist-info/METADATA,sha256=5dpZGUdWdq2bmbPPtdaKqnG60Myd7Volzp4WcFAEfNQ,3658
+gooddata_pipelines-1.52.1.dev2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+gooddata_pipelines-1.52.1.dev2.dist-info/licenses/LICENSE.txt,sha256=PNC7WXGIo6OKkNoPLRxlVrw6jaLcjSTUsSxy9Xcu9Jo,560365
+gooddata_pipelines-1.52.1.dev2.dist-info/RECORD,,