collibra-connector 1.0.10rc0__py3-none-any.whl → 1.0.12__py3-none-any.whl

collibra_connector/api/Asset.py

@@ -221,7 +221,7 @@ class Asset(BaseAPI):
         data = {
             "values": values
         }
-        
+
         # Add type_id or type_public_id to the data
         if type_id:
             data["typeId"] = type_id

collibra_connector/api/Base.py

@@ -38,7 +38,7 @@ class BaseAPI:
             timeout=self.__connector.timeout
         )
 
-    def _post(self, url: str, data: dict, headers: dict = None):
+    def _post(self, url: str, data: dict, headers: dict = None, params: dict = None):
         """
         Makes a POST request to the specified URL with the given data.
         :param url: The URL to send the POST request to.
@@ -56,6 +56,7 @@ class BaseAPI:
             auth=self.__connector.auth,
             json=data,
             headers=headers,
+            params=params,
             timeout=self.__connector.timeout
         )
 

collibra_connector/api/Domain.py

@@ -112,7 +112,7 @@ class Domain(BaseAPI):
         if type_public_id is not None:
             params["typePublicId"] = type_public_id
 
-        response = self._get(params=params)
+        response = self._get(url=self.__base_api, params=params)
         return self._handle_response(response)
 
     def add_domain(

collibra_connector/api/Metadata.py

@@ -72,8 +72,8 @@ class Metadata(BaseAPI):
                 for domain in domains_data.get("results", []):
                     metadata["Domain"][domain["name"]] = domain["id"]
                 if (
-                    domains_data.get("offset", 0) + domains_data.get("limit", 0) >=
-                    domains_data.get("total", 0)
+                    domains_data.get("offset", 0) + domains_data.get("limit", 0)
+                    >= domains_data.get("total", 0)
                 ):
                     break
                 domains_params["offset"] += domains_params["limit"]

collibra_connector/api/OutputModule.py

@@ -0,0 +1,48 @@
+import requests
+from typing import Optional, Dict, Any
+from .Base import BaseAPI
+
+
+class OutputModule(BaseAPI):
+    """
+    Output Module API endpoints for Collibra DGC.
+    """
+    def __init__(self, connector):
+        super().__init__(connector)
+        self.__base_api = connector.api + "/outputModule"
+
+    def export_json(
+        self,
+        body: str,
+        validation_enabled: bool = False
+    ) -> Dict[Any, Any]:
+        """
+        Exports results in JSON format, returns the results immediately.
+
+        Performs an Output Module query and exports the returns results immediately in JSON format.
+
+        Please note that the ViewConfig/TableViewConfig's syntax validation is not executed by default.
+        DGC admin console settings may impact the execution of the query (especially in terms of timeout
+        and a limit on the number of results).
+
+        Args:
+            view_config (str): The JSON/YAML representation of ViewConfig/TableViewConfig
+                             that describes the query to be performed.
+            validation_enabled (bool): Determines if the ViewConfig's syntax should be validated
+                                     (True) or not (False). Default value is False for backward
+                                     compatibility reasons but it is strongly advised to always
+                                     enable this validation.
+
+        Returns:
+            Dict[Any, Any]: The exported results in JSON format.
+
+        Raises:
+            requests.exceptions.RequestException: If the API request fails.
+        """
+        endpoint = f"{self.__base_api}/export/json"
+
+        headers = {
+            'Content-Type': 'application/json'
+        }
+
+        return self._post(url=endpoint, data=body, headers=headers).json()

collibra_connector/api/Utils.py

@@ -0,0 +1,103 @@
+import re
+import logging
+from .Base import BaseAPI
+
+logger = logging.getLogger(__name__)
+
+
+class Utils(BaseAPI):
+    def __init__(self, connector):
+        super().__init__(connector)
+        self.__base_api = connector.api
+
+    def get_uuids(self):
+        """
+        Retrieves UUIDs of asset types, relation types, responsibilities, statuses, and attributes from Collibra,
+        returning a dictionary with names as keys and UUIDs as values. Relation type names are used.
+
+        Returns:
+            A dictionary containing dictionaries of named UUIDs for asset types, relation types,
+            responsibilities, statuses, and attributes.
+        """
+        metadata = {
+            "AssetType": {},
+            "Relation": {},
+            "Responsability": {},
+            "Status": {},
+            "Attribute": {},
+            "Community": {},
+            "Domain": {},
+            "DomainType": {},
+        }
+        try:
+            # Get Asset Type UUIDs
+            asset_types_url = f"{self.__base_api}/assetTypes"
+            asset_types_response = self._get(url=asset_types_url)
+            asset_types_data = self._handle_response(asset_types_response)
+            for asset_type in asset_types_data["results"]:
+                metadata["AssetType"][asset_type["name"]] = asset_type["id"]
+
+            # Get Relation Type UUIDs
+            relation_types_url = f"{self.__base_api}/relationTypes"
+            relation_types_response = self._get(url=relation_types_url)
+            relation_types_data = self._handle_response(relation_types_response)
+            for relation_type in relation_types_data["results"]:
+                source_name = re.sub(" ", "", relation_type["sourceType"]["name"])
+                target_name = re.sub(" ", "", relation_type["targetType"]["name"])
+                metadata["Relation"][f"{source_name}_{target_name}"] = relation_type["id"]
+
+            # Get Roles
+            resource_roles_url = f"{self.__base_api}/roles"
+            resource_roles_response = self._get(url=resource_roles_url)
+            resource_roles_data = self._handle_response(resource_roles_response)
+            for resource_role in resource_roles_data["results"]:
+                metadata["Responsability"][resource_role["name"]] = resource_role["id"]
+
+            # Get Status UUIDs
+            statuses_url = f"{self.__base_api}/statuses"
+            statuses_response = self._get(url=statuses_url)
+            statuses_data = self._handle_response(statuses_response)
+            for status in statuses_data["results"]:
+                metadata["Status"][status["name"]] = status["id"]
+
+            # Get Attribute UUIDs
+            attributes_url = f"{self.__base_api}/attributeTypes"
+            attributes_response = self._get(url=attributes_url)
+            attributes_data = self._handle_response(attributes_response)
+            for attribute in attributes_data["results"]:
+                metadata["Attribute"][attribute["name"]] = attribute["id"]
+
+            # Get Community UUIDs
+            communities_url = f"{self.__base_api}/communities"
+            communities_response = self._get(url=communities_url)
+            communities_data = self._handle_response(communities_response)
+            for community in communities_data["results"]:
+                metadata["Community"][community["name"]] = community["id"]
+
+            # Get Domain UUIDs
+            domains_url = f"{self.__base_api}/domains"
+            domains_params = {"limit": 1000, "offset": 0}
+            while True:
+                domains_response = self._get(url=domains_url, params=domains_params)
+                domains_data = self._handle_response(domains_response)
+                for domain in domains_data["results"]:
+                    metadata["Domain"][domain["name"]] = domain["id"]
+                if domains_data.get("offset") + domains_data.get(
+                    "limit"
+                ) >= domains_data.get("total"):
+                    break
+                domains_params["offset"] += domains_params["limit"]
+
+            # Get Domain Type UUIDs
+            domain_types_url = f"{self.__base_api}/domainTypes"
+            domain_types_response = self._get(url=domain_types_url)
+            domain_types_data = self._handle_response(domain_types_response)
+            for domain_type in domain_types_data["results"]:
+                metadata["DomainType"][domain_type["name"]] = domain_type["id"]
+
+            logger.info("Collibra UUIDS fetched successfully")
+            return metadata
+
+        except (KeyError, ValueError, AttributeError) as e:
+            logger.error("Error fetching Collibra UUIDs: %s", e)
+            return None

collibra_connector/api/__init__.py

@@ -1,13 +1,8 @@
 from .Asset import Asset
 from .Base import BaseAPI
 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 .Domain import Domain
 from .Exceptions import (
     CollibraAPIError,
     UnauthorizedError,
@@ -15,3 +10,10 @@ from .Exceptions import (
     NotFoundError,
     ServerError
 )
+from .Metadata import Metadata
+from .OutputModule import OutputModule
+from .Relation import Relation
+from .Responsibility import Responsibility
+from .User import User
+from .Utils import Utils
+from .Workflow import Workflow

collibra_connector/connector.py

@@ -11,7 +11,9 @@ from .api import (
     Workflow,
     Metadata,
     Comment,
-    Relation
+    Relation,
+    OutputModule,
+    Utils
 )
 
 
@@ -22,7 +24,7 @@ class CollibraConnector():
     The authentication is done using HTTP Basic Auth.
     """
 
-    def __init__(self, api: str, username: str, password: str, timeout: int = 30):
+    def __init__(self, api: str, username: str, password: str, timeout: int = 30, **kwargs):
         """
         Initializes the CollibraConnector with API URL and authentication credentials.
         :param api: The API URL for Collibra.
@@ -44,6 +46,12 @@ class CollibraConnector():
         self.metadata = Metadata(self)
         self.comment = Comment(self)
         self.relation = Relation(self)
+        self.output_module = OutputModule(self)
+        self.utils = Utils(self)
+
+        self.uuids = {}
+        if kwargs.get('uuids'):
+            self.uuids = self.utils.get_uuids()
 
         logging.basicConfig(level=logging.INFO)
         self.logger = logging.getLogger(__name__)

{collibra_connector-1.0.10rc0.dist-info → collibra_connector-1.0.12.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: collibra-connector
-Version: 1.0.10rc0
+Version: 1.0.12
 Summary: An UNOFFICIAL standard Python connector for the Collibra Data Governance Center API.
 Author-email: Raül Dalgamonni <rauldalgamonnialonso@gmail.com>
 Project-URL: Homepage, https://github.com/rauldaal/collibra-python-connector

collibra_connector-1.0.12.dist-info/RECORD

@@ -0,0 +1,21 @@
+collibra_connector/__init__.py,sha256=vzF9epFfmdnFjOcr_qZhvfiN9Z0cIBB48xldnvIiKjo,1694
+collibra_connector/connector.py,sha256=uBOFEAVIE-v6Zkb9-SwFCFcaeJESStOOFZdI2iy20gw,2449
+collibra_connector/api/Asset.py,sha256=aPhnsRxzdGGFtaytpLueDgMrELMpIs4cuOJoc2DR-p4,17927
+collibra_connector/api/Base.py,sha256=2gHpieP8N_PK-R63zUv38Wpdfqdw9tHcH59hlXUZOWM,5929
+collibra_connector/api/Comment.py,sha256=4ZzXiKj3pDOw_JRhfrUj-gcF8nZVdW_z7X2jJnq7LcU,4994
+collibra_connector/api/Community.py,sha256=kM4j0LGYCXQygOZ4zHuu10JzJzvXtbUDz9litzKeKUI,12132
+collibra_connector/api/Domain.py,sha256=U0i103g1WceCn9qAFUWDLgeXrtOvfBqX3vMCn4sQqRE,13012
+collibra_connector/api/Exceptions.py,sha256=lX8yU3BnlOiWWifIBKlZdXVZaTI5pvtbrffyDtEUtoc,429
+collibra_connector/api/Metadata.py,sha256=4uzb4vnZuMOg_ISCEnCfmAEVbsIcuD4FvupDlcxrfT4,5213
+collibra_connector/api/OutputModule.py,sha256=97TzIbeoC5V63x5fi5fEcGfviUydwKwJC3NobLuNF5w,1791
+collibra_connector/api/Relation.py,sha256=Hw0PlAQrU2Zv-RAbvHZhZpZb2_m6uDWngx2ySwo_mv0,8079
+collibra_connector/api/Responsibility.py,sha256=PJu1Pe1u8mKzgpGGjzHtZNfRTfpgWWbaQn5bSifZOMo,14123
+collibra_connector/api/User.py,sha256=nPl8q6l-H8hq2sR7gLelXq09jl3QRWFzI_WU3OUIHhQ,7755
+collibra_connector/api/Utils.py,sha256=F8ZWrW8urzDX8QfiL16kWRnBYGRiLqeKUbYXlQpXNiM,4674
+collibra_connector/api/Workflow.py,sha256=rsD9mPut69eEy35TNGf2mUKTrgWUmoakgnsXa85XzNY,10417
+collibra_connector/api/__init__.py,sha256=yBJcKzcRraE-UYbBviisbdvQ1asFBnud5Vo1oJcCv_w,491
+collibra_connector-1.0.12.dist-info/licenses/LICENSE,sha256=6KmWWtAu_q58gerPlrnkgsmGM2l8j6Wc_VL0y4S_ip4,1079
+collibra_connector-1.0.12.dist-info/METADATA,sha256=blUOj_pN5Pm-6kJw3YLTWegVLRldgHbj4AAGMp_TNhk,4081
+collibra_connector-1.0.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+collibra_connector-1.0.12.dist-info/top_level.txt,sha256=Vs-kR64zf__ebL2j3_AEx7rhO6xkwgmHUFRzxlQPgTQ,19
+collibra_connector-1.0.12.dist-info/RECORD,,

collibra_connector-1.0.10rc0.dist-info/RECORD

@@ -1,19 +0,0 @@
-collibra_connector/__init__.py,sha256=vzF9epFfmdnFjOcr_qZhvfiN9Z0cIBB48xldnvIiKjo,1694
-collibra_connector/connector.py,sha256=oNN8WCI1TI6ffSEfl6_SX7SdrznwA5UeN7U13m-O_hU,2224
-collibra_connector/api/Asset.py,sha256=uGv5S0jPJ8gTeZCh4AcmttLKW0gXk8yeROM3MdeCD6w,17935
-collibra_connector/api/Base.py,sha256=8sYTPrIlHZP8smfYKl2rWSL63aKqHrtFca_M6gEOVns,5881
-collibra_connector/api/Comment.py,sha256=4ZzXiKj3pDOw_JRhfrUj-gcF8nZVdW_z7X2jJnq7LcU,4994
-collibra_connector/api/Community.py,sha256=kM4j0LGYCXQygOZ4zHuu10JzJzvXtbUDz9litzKeKUI,12132
-collibra_connector/api/Domain.py,sha256=tNqqNiATjiAiPe_lfWebO_8vxtmr3fFds8sd-hy_eD4,12991
-collibra_connector/api/Exceptions.py,sha256=lX8yU3BnlOiWWifIBKlZdXVZaTI5pvtbrffyDtEUtoc,429
-collibra_connector/api/Metadata.py,sha256=lOVXu0pcHSZNhInb4nR4q7lBB1MwtRuoL4Qb-2sr8aI,5213
-collibra_connector/api/Relation.py,sha256=Hw0PlAQrU2Zv-RAbvHZhZpZb2_m6uDWngx2ySwo_mv0,8079
-collibra_connector/api/Responsibility.py,sha256=PJu1Pe1u8mKzgpGGjzHtZNfRTfpgWWbaQn5bSifZOMo,14123
-collibra_connector/api/User.py,sha256=nPl8q6l-H8hq2sR7gLelXq09jl3QRWFzI_WU3OUIHhQ,7755
-collibra_connector/api/Workflow.py,sha256=rsD9mPut69eEy35TNGf2mUKTrgWUmoakgnsXa85XzNY,10417
-collibra_connector/api/__init__.py,sha256=WTeTeK4LS2fQXcNyAg3yKjlf2jTbLnaOusNRZItQPWM,427
-collibra_connector-1.0.10rc0.dist-info/licenses/LICENSE,sha256=6KmWWtAu_q58gerPlrnkgsmGM2l8j6Wc_VL0y4S_ip4,1079
-collibra_connector-1.0.10rc0.dist-info/METADATA,sha256=NU4lLlGO1ao73yx8YiJZYbeaJ1Cy3aZyL4omFpy7kzI,4084
-collibra_connector-1.0.10rc0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-collibra_connector-1.0.10rc0.dist-info/top_level.txt,sha256=Vs-kR64zf__ebL2j3_AEx7rhO6xkwgmHUFRzxlQPgTQ,19
-collibra_connector-1.0.10rc0.dist-info/RECORD,,