collibra-connector 1.1.0__tar.gz → 1.1.2__tar.gz

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: collibra-connector
-Version: 1.1.0
+Version: 1.1.2
 Summary: An UNOFFICIAL standard Python connector for the Collibra Data Governance Center API with full type safety, async support, and enterprise features.
 Author-email: Raul Dalgamonni <rauldalgamonnialonso@gmail.com>
 Project-URL: Homepage, https://github.com/rauldaal/collibra-python-connector

collibra_connector-1.1.2/collibra_connector/api/UserGroup.py

@@ -0,0 +1,95 @@
+import uuid
+from .Base import BaseAPI
+
+
+class UserGroup(BaseAPI):
+    def __init__(self, connector):
+        super().__init__(connector)
+        self.__base_api = connector.api + "/userGroups"
+
+    def find_user_groups(
+        self,
+        count_limit: int = -1,
+        include_everyone: bool = None,
+        limit: int = 0,
+        name: str = None,
+        name_match_mode: str = "ANYWHERE",
+        offset: int = 0,
+        user_id: str = None
+    ):
+        """
+        Find user groups matching the given search criteria.
+
+        Returns user groups matching the given search criteria. Only parameters that are specified
+        in this request and have not null values are used for filtering. All other parameters are
+        ignored. By default a result containing 1000 user groups is returned.
+
+        :param count_limit: Limit the number of elements that will be counted. -1 counts everything,
+                            0 skips count. Default: -1
+        :param include_everyone: Indicates if we should include the everyone group or not.
+        :param limit: Maximum number of results to retrieve (0 = default limit, max 1000). Default: 0
+        :param name: The name of the user group.
+        :param name_match_mode: The match mode used to compare name. If the match mode is EXACT
+                                the search is case-sensitive, otherwise case-insensitive.
+                                Allowed values: START, END, ANYWHERE, EXACT. Default: ANYWHERE
+        :param offset: First result to retrieve (0-based). Default: 0
+        :param user_id: The ID of the user who should belong to searched user groups.
+        :return: Search results with user groups matching the criteria.
+        """
+        # Validate count_limit
+        if not isinstance(count_limit, int):
+            raise ValueError("count_limit must be an integer")
+
+        # Validate include_everyone
+        if include_everyone is not None and not isinstance(include_everyone, bool):
+            raise ValueError("include_everyone must be a boolean")
+
+        # Validate limit
+        if not isinstance(limit, int) or limit < 0:
+            raise ValueError("limit must be a non-negative integer")
+        if limit > 1000:
+            raise ValueError("limit cannot exceed 1000")
+
+        # Validate name
+        if name is not None and not isinstance(name, str):
+            raise ValueError("name must be a string")
+
+        # Validate name_match_mode
+        valid_match_modes = ["START", "END", "ANYWHERE", "EXACT"]
+        if name_match_mode not in valid_match_modes:
+            raise ValueError(f"Invalid name_match_mode: {name_match_mode}. "
+                             f"Allowed values: {valid_match_modes}")
+
+        # Validate offset
+        if not isinstance(offset, int) or offset < 0:
+            raise ValueError("offset must be a non-negative integer")
+
+        # Validate user_id if provided
+        if user_id is not None:
+            if not isinstance(user_id, str):
+                raise ValueError("user_id must be a string")
+            try:
+                uuid.UUID(user_id)
+            except ValueError as exc:
+                raise ValueError("user_id must be a valid UUID") from exc
+
+        # Build parameters
+        params = {
+            "countLimit": count_limit,
+            "limit": limit,
+            "nameMatchMode": name_match_mode,
+            "offset": offset
+        }
+
+        # Add optional parameters
+        if include_everyone is not None:
+            params["includeEveryone"] = include_everyone
+
+        if name is not None:
+            params["name"] = name
+
+        if user_id is not None:
+            params["userId"] = user_id
+
+        response = self._get(url=self.__base_api, params=params)
+        return self._handle_response(response)

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/collibra_connector/api/Workflow.py

@@ -10,15 +10,26 @@ class Workflow(BaseAPI):
     def start_workflow_instance(
         self,
         workflow_definition_id: str,
-        asset_id: str = None,
+        business_item_ids: list[str] = None,
+        business_item_type: str = None,
+        form_properties: dict[str, str] = None,
+        guest_user_id: str = None,
+        send_notification: bool = False,
         return_all: bool = False
     ):
         """
-        Start a workflow instance.
-        :param workflow_definition_id: The ID of the workflow definition.
-        :param asset_id: Optional asset ID to associate with the workflow.
+        Start multiple workflow instances based on the provided request.
+
+        :param workflow_definition_id: The ID of the workflow definition (required).
+        :param business_item_ids: The list of IDs for the business items (optional).
+        :param business_item_type: The resource type of the passed in business items.
+                                   Allowed values: ASSET, DOMAIN, COMMUNITY, GLOBAL, USER (optional).
+        :param form_properties: The properties of the workflow as a dictionary (optional).
+        :param guest_user_id: The ID of the guest user starting the workflow (optional).
+        :param send_notification: Whether a mail notification on starting the workflows should be sent.
+                                 This notification is only used in the asynchronous api version (optional).
         :param return_all: Whether to return all workflow data or just the ID.
-        :return: Workflow instance ID or full response data.
+        :return: Workflow instance ID or full response data (array of workflow instances).
         """
         if not workflow_definition_id:
             raise ValueError("workflow_definition_id is required")
@@ -32,21 +43,44 @@ class Workflow(BaseAPI):
 
         data = {
             "workflowDefinitionId": workflow_definition_id,
-            "sendNotification": True
+            "sendNotification": send_notification
         }
 
-        if asset_id:
-            if not isinstance(asset_id, str):
-                raise ValueError("asset_id must be a string")
+        if business_item_ids is not None:
+            if not isinstance(business_item_ids, list):
+                raise ValueError("business_item_ids must be a list")
+            if not all(isinstance(item_id, str) for item_id in business_item_ids):
+                raise ValueError("All business_item_ids must be strings")
+            for item_id in business_item_ids:
+                try:
+                    uuid.UUID(item_id)
+                except ValueError as exc:
+                    raise ValueError(f"business_item_id '{item_id}' must be a valid UUID") from exc
+            data["businessItemIds"] = business_item_ids
+
+        if business_item_type is not None:
+            if not isinstance(business_item_type, str):
+                raise ValueError("business_item_type must be a string")
+            valid_types = ["ASSET", "DOMAIN", "COMMUNITY", "GLOBAL", "USER"]
+            if business_item_type not in valid_types:
+                raise ValueError(f"business_item_type must be one of: {', '.join(valid_types)}")
+            data["businessItemType"] = business_item_type
+
+        if form_properties is not None:
+            if not isinstance(form_properties, dict):
+                raise ValueError("form_properties must be a dictionary")
+            if not all(isinstance(k, str) and isinstance(v, str) for k, v in form_properties.items()):
+                raise ValueError("All form_properties keys and values must be strings")
+            data["formProperties"] = form_properties
+
+        if guest_user_id is not None:
+            if not isinstance(guest_user_id, str):
+                raise ValueError("guest_user_id must be a string")
             try:
-                uuid.UUID(asset_id)
+                uuid.UUID(guest_user_id)
             except ValueError as exc:
-                raise ValueError("asset_id must be a valid UUID") from exc
-
-            data.update({
-                "businessItemIds": [asset_id],
-                "businessItemType": "ASSET",
-            })
+                raise ValueError("guest_user_id must be a valid UUID") from exc
+            data["guestUserId"] = guest_user_id
 
         response = self._post(url=f"{self.__base_api}/workflowInstances", data=data)
         result = self._handle_response(response)

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/collibra_connector/api/__init__.py

@@ -1,29 +1,31 @@
 from .Asset import Asset
 from .Attribute import Attribute
+from .Comment import Comment
 from .Community import Community
 from .Domain import Domain
-from .User import User
-from .Responsibility import Responsibility
-from .Workflow import Workflow
 from .Metadata import Metadata
-from .Comment import Comment
-from .Relation import Relation
 from .OutputModule import OutputModule
-from .Utils import Utils
+from .Relation import Relation
+from .Responsibility import Responsibility
 from .Search import Search
+from .User import User
+from .UserGroup import UserGroup
+from .Utils import Utils
+from .Workflow import Workflow
 
 __all__ = [
     "Asset",
     "Attribute",
+    "Comment",
     "Community",
     "Domain",
-    "User",
-    "Responsibility",
-    "Workflow",
     "Metadata",
-    "Comment",
-    "Relation",
     "OutputModule",
+    "Relation",
+    "Responsibility",
+    "Search",
+    "User",
+    "UserGroup",
     "Utils",
-    "Search"
-]
+    "Workflow",
+]

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/collibra_connector/connector.py

@@ -16,17 +16,18 @@ from requests.auth import HTTPBasicAuth
 from .api import (
     Asset,
     Attribute,
+    Comment,
     Community,
     Domain,
-    User,
-    Responsibility,
-    Workflow,
     Metadata,
-    Comment,
-    Relation,
     OutputModule,
+    Relation,
+    Responsibility,
+    Search,
+    User,
+    UserGroup,
     Utils,
-    Search
+    Workflow,
 )
 
 if TYPE_CHECKING:
@@ -85,7 +86,7 @@ class CollibraConnector:
     ) -> None:
         """
         Initialize the CollibraConnector with API URL and authentication credentials.
-        
+
         Credentials can be provided as arguments or via environment variables:
         COLLIBRA_URL, COLLIBRA_USERNAME, COLLIBRA_PASSWORD.
 
@@ -130,18 +131,19 @@ class CollibraConnector:
         # Initialize all API classes
         self.asset: Asset = Asset(self)
         self.attribute: Attribute = Attribute(self)
+        self.comment: Comment = Comment(self)
         self.community: Community = Community(self)
         self.domain: Domain = Domain(self)
-        self.user: User = User(self)
         self.responsibility: Responsibility = Responsibility(self)
-        self.workflow: Workflow = Workflow(self)
         self.metadata: Metadata = Metadata(self)
-        self.comment: Comment = Comment(self)
-        self.relation: Relation = Relation(self)
         self.output_module: OutputModule = OutputModule(self)
-        self.utils: Utils = Utils(self)
+        self.relation: Relation = Relation(self)
         self.search: Search = Search(self)
-        
+        self.user: User = User(self)
+        self.user_group: UserGroup = UserGroup(self)
+        self.utils: Utils = Utils(self)
+        self.workflow: Workflow = Workflow(self)
+
         # Initialize Logger without basicConfig
         self.logger: logging.Logger = logging.getLogger(__name__)
         self.logger.addHandler(logging.NullHandler())

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/collibra_connector.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: collibra-connector
-Version: 1.1.0
+Version: 1.1.2
 Summary: An UNOFFICIAL standard Python connector for the Collibra Data Governance Center API with full type safety, async support, and enterprise features.
 Author-email: Raul Dalgamonni <rauldalgamonnialonso@gmail.com>
 Project-URL: Homepage, https://github.com/rauldaal/collibra-python-connector

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/collibra_connector.egg-info/SOURCES.txt

@@ -30,6 +30,7 @@ collibra_connector/api/Relation.py
 collibra_connector/api/Responsibility.py
 collibra_connector/api/Search.py
 collibra_connector/api/User.py
+collibra_connector/api/UserGroup.py
 collibra_connector/api/Utils.py
 collibra_connector/api/Workflow.py
 collibra_connector/api/__init__.py

{collibra_connector-1.1.0 → collibra_connector-1.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "collibra-connector"
-version = "1.1.0"
+version = "1.1.2"
 authors = [
   { name="Raul Dalgamonni", email="rauldalgamonnialonso@gmail.com"},
 ]