collibra-connector 1.0.6__tar.gz → 1.0.9__tar.gz

{collibra_connector-1.0.6 → collibra_connector-1.0.9}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: collibra-connector
-Version: 1.0.6
-Summary: A standard Python connector for the Collibra Data Governance Center API.
+Version: 1.0.9
+Summary: An UNOFICIAL 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
 Project-URL: Bug Tracker, https://github.com/rauldaal/collibra-python-connector

collibra_connector-1.0.9/collibra_connector/__init__.py

@@ -0,0 +1,39 @@
+#
+#
+#                           ███
+#                     ██    ███   ███
+#                    ████         ███
+#              ███   ████   ██    ███   ████
+#              ███   ████   ███   ███   ████
+#                           ███   ███
+#                           ███   ███
+#          ██████████████   ███   ███   ████████
+#           ███████████      █    ███    ██████
+#
+#         ███  █████████████   ████████████   ███
+#         ███  █████████████   ████████████   ███
+#
+#           ██████           █     █████████████
+#          ███████   ████   ███   ██████████████
+#                    ████   ███
+#                    ████   ███
+#              ███   ████   ███   ███   ████
+#               ██   ████   ██    ███    ██
+#                    ████         ███
+#                     ██    ███   ███
+#                            █
+#
+#
+"""
+
+Collibra Connector Library
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Uses the Collibra API to connect and interact with Collibra's data governance platform.
+This library provides a simple interface to handle connection and URLs
+
+"""
+
+from .connector import CollibraConnector
+
+__version__ = "0.1.0"

collibra_connector-1.0.9/collibra_connector/api/Asset.py

@@ -0,0 +1,102 @@
+import uuid
+from .Base import BaseAPI
+
+
+class Asset(BaseAPI):
+    def __init__(self, connector):
+        super().__init__(connector)
+        self.__base_api = connector.api + "/assets"
+
+    def _get(self, url: str = None, params: dict = None, headers: dict = None):
+        """
+        Makes a GET request to the asset API.
+        :param url: The URL to send the GET request to.
+        :param params: Optional parameters to include in the GET request.
+        :param headers: Optional headers to include in the GET request.
+        :return: The response from the GET request.
+        """
+        return super()._get(self.__base_api if not url else url, params, headers)
+
+    def _post(self, url: str, data: dict):
+        """
+        Makes a POST request to the asset API.
+        :param url: The URL to send the POST request to.
+        :param data: The data to send in the POST request.
+        :return: The response from the POST request.
+        """
+        return super()._post(url, data)
+
+    def _handle_response(self, response):
+        return super()._handle_response(response)
+
+    def _uuid_validation(self, id):
+        return super()._uuid_validation(id)
+
+    def get_asset(self, asset_id):
+        """
+        Retrieves an asset by its ID.
+        :param asset_id: The ID of the asset to retrieve.
+        :return: Asset details.
+        """
+        response = self._get(url=f"{self.__base_api}/{asset_id}")
+        return self._handle_response(response)
+
+    def add_asset(
+        self,
+        name: str,
+        domain_id: str,
+        display_name: str = None,
+        type_id: str = None,
+        id: str = None,
+        status_id: str = None,
+        excluded_from_auto_hyperlink: bool = False,
+        type_public_id: str = None,
+    ):
+        """
+        Adds a new asset.
+        :param name: The name of the asset.
+        :param domain_id: The ID of the domain to which the asset belongs.
+        :param display_name: Optional display name for the asset.
+        :param type_id: Optional type ID for the asset.
+        :param id: Optional ID for the asset.
+        :param status_id: Optional status ID for the asset.
+        :param excluded_from_auto_hyperlink: Whether the asset is excluded from auto hyperlinking.
+        :param type_public_id: Optional public ID for the asset type.
+        :return: Details of the created asset.
+        """
+        # Parameter type validation
+        if not name or not domain_id:
+            raise ValueError("Name and domain_id are required parameters.")
+        if not isinstance(excluded_from_auto_hyperlink, bool):
+            raise ValueError("excluded_from_auto_hyperlink must be a boolean value.")
+        if type_id and not isinstance(type_id, str):
+            raise ValueError("type_id must be a string if provided.")
+        if id and not isinstance(id, str):
+            raise ValueError("id must be a string if provided.")
+        if status_id and not isinstance(status_id, str):
+            raise ValueError("status_id must be a string if provided.")
+        if type_public_id and not isinstance(type_public_id, str):
+            raise ValueError("type_public_id must be a string if provided.")
+
+        # Check Ids are UUIDS
+        if id and self._uuid_validation(id) is False:
+            raise ValueError("id must be a valid UUID.")
+        if domain_id and self._uuid_validation(domain_id) is False:
+            raise ValueError("domain_id must be a valid UUID.")
+        if type_id and self._uuid_validation(type_id) is False:
+            raise ValueError("type_id must be a valid UUID.")
+        if status_id and self._uuid_validation(status_id) is False:
+            raise ValueError("status_id must be a valid UUID.")
+
+        data = {
+            "name": name,
+            "domainId": domain_id,
+            "displayName": display_name,
+            "typeId": type_id,
+            "id": id,
+            "statusId": status_id,
+            "excludedFromAutoHyperlink": excluded_from_auto_hyperlink,
+            "typePublicId": type_public_id
+        }
+        response = self._post(url=self.__base_api, data=data)
+        return self._handle_response(response)

collibra_connector-1.0.9/collibra_connector/api/Base.py

@@ -0,0 +1,83 @@
+import re
+import requests
+from .Exceptions import (
+    UnauthorizedError,
+    ForbiddenError,
+    NotFoundError,
+    ServerError
+)
+
+
+class BaseAPI:
+    def __init__(self, connector):
+        self.__connector = connector
+        self.__base_api = connector.api
+        self.__header = {
+            "Content-Type": "application/json",
+            "Accept": "application/json"
+        }
+        self.__params = None
+
+    def _get(self, url: str = None, params: dict = None, headers: dict = None):
+        """
+        Makes a GET request to the specified URL.
+        :param url: The URL to send the GET request to.
+        :param params: Optional parameters to include in the GET request.
+        :param headers: Optional headers to include in the GET request.
+        :return: The response from the GET request.
+        """
+        url = self.__base_api if not url else url
+        headers = self.__header if not headers else headers
+        params = self.__params if not params else params
+        return requests.get(
+            url,
+            auth=self.__connector.auth,
+            params=params,
+            headers=headers
+        )
+
+    def _post(self, url: str, data: dict, headers: dict = None):
+        """
+        Makes a POST request to the specified URL with the given data.
+        :param url: The URL to send the POST request to.
+        :param data: The data to send in the POST request.
+        :return: The response from the POST request.
+        """
+        url = self.__base_api if not url else url
+        headers = self.__header if not headers else headers
+        if not isinstance(data, dict):
+            raise ValueError("Data must be a dictionary")
+        if not data:
+            raise ValueError("Data cannot be empty")
+        return requests.post(
+            url,
+            auth=self.__connector.auth,
+            json=data,
+            headers=headers
+        )
+
+    def _handle_response(self, response):
+        """
+        Handles the response from the API.
+        :param response: The response object from the API request.
+        :return: The JSON content of the response if successful, otherwise raises an error.
+        """
+        if response.status_code == 200 or response.status_code == 201:
+            return response.json()
+        elif response.status_code == 401:
+            raise UnauthorizedError("Unauthorized access - invalid credentials" + response.text)
+        elif response.status_code == 403:
+            raise ForbiddenError("Forbidden access - insufficient permissions" + response.text)
+        elif response.status_code == 404:
+            raise NotFoundError("The specified resource was not found" + response.text)
+        elif response.status_code >= 500:
+            raise ServerError("Internal server error - something went wrong on the server" + response.text)
+
+    def _uuid_validation(self, id: str):
+        """
+        Validates if the provided ID is a valid UUID.
+        :param id: The ID to validate.
+        :return: True if the ID is a valid UUID, otherwise raises ValueError.
+        """
+        pattern = re.compile(r"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$")
+        return bool(pattern.match(id))

collibra_connector-1.0.9/collibra_connector/api/Exceptions.py

@@ -0,0 +1,24 @@
+
+class CollibraAPIError(Exception):
+    """Base exception for Collibra API errors"""
+    pass
+
+
+class UnauthorizedError(CollibraAPIError):
+    """Raised when authentication fails"""
+    pass
+
+
+class ForbiddenError(CollibraAPIError):
+    """Raised when access is forbidden"""
+    pass
+
+
+class NotFoundError(CollibraAPIError):
+    """Raised when resource is not found"""
+    pass
+
+
+class ServerError(CollibraAPIError):
+    """Raised when server returns 5xx errors"""
+    pass

collibra_connector-1.0.9/collibra_connector/api/__init__.py

@@ -0,0 +1,2 @@
+from .Asset import Asset
+from .Base import BaseAPI

{collibra_connector-1.0.6 → collibra_connector-1.0.9}/collibra_connector/connector.py

@@ -4,6 +4,7 @@ from requests.auth import HTTPBasicAuth
 
 from .api import Asset
 
+
 class CollibraConnector():
     """
     This class is used to connect to the Collibra API.
@@ -35,7 +36,7 @@ class CollibraConnector():
         """Test the connection to Collibra API"""
         try:
             response = requests.get(
-                f"{self.__api}/info",
+                f"{self.__api}/auth/sessions/current",
                 auth=self.__auth,
                 timeout=self.__timeout
             )
@@ -54,4 +55,4 @@ class CollibraConnector():
 
     @property
     def base_url(self):
-        return self.__base_url
+        return self.__base_url

{collibra_connector-1.0.6 → collibra_connector-1.0.9}/collibra_connector.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: collibra-connector
-Version: 1.0.6
-Summary: A standard Python connector for the Collibra Data Governance Center API.
+Version: 1.0.9
+Summary: An UNOFICIAL 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
 Project-URL: Bug Tracker, https://github.com/rauldaal/collibra-python-connector

{collibra_connector-1.0.6 → collibra_connector-1.0.9}/collibra_connector.egg-info/SOURCES.txt

@@ -7,4 +7,8 @@ collibra_connector.egg-info/PKG-INFO
 collibra_connector.egg-info/SOURCES.txt
 collibra_connector.egg-info/dependency_links.txt
 collibra_connector.egg-info/requires.txt
-collibra_connector.egg-info/top_level.txt
+collibra_connector.egg-info/top_level.txt
+collibra_connector/api/Asset.py
+collibra_connector/api/Base.py
+collibra_connector/api/Exceptions.py
+collibra_connector/api/__init__.py

{collibra_connector-1.0.6 → collibra_connector-1.0.9}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "collibra-connector"
-version = "1.0.6"
+version = "1.0.9"
 authors = [
   { name="Raül Dalgamonni", email="rauldalgamonnialonso@gmail.com"},
 ]
-description = "A standard Python connector for the Collibra Data Governance Center API."
+description = "An UNOFICIAL standard Python connector for the Collibra Data Governance Center API."
 readme = "README.md"
 requires-python = ">=3.8"
 classifiers = [
@@ -28,4 +28,4 @@ build-backend = "setuptools.build_meta"
 
 [tool.setuptools.packages.find]
 where = ["."]
-include = ["collibra_connector"]
+include = ["collibra_connector", "collibra_connector.api"]

collibra_connector-1.0.6/collibra_connector/__init__.py

@@ -1,39 +0,0 @@
-#
-#
-#                           ███                   
-#                     ██    ███   ███             
-#                    ████         ███             
-#              ███   ████   ██    ███   ████      
-#              ███   ████   ███   ███   ████      
-#                           ███   ███             
-#                           ███   ███             
-#          ██████████████   ███   ███   ████████  
-#           ███████████      █    ███    ██████   
-#
-#         ███  █████████████   ████████████   ███ 
-#         ███  █████████████   ████████████   ███ 
-#
-#           ██████           █     █████████████ 
-#          ███████   ████   ███   ██████████████  
-#                    ████   ███                   
-#                    ████   ███                   
-#              ███   ████   ███   ███   ████      
-#               ██   ████   ██    ███    ██       
-#                    ████         ███             
-#                     ██    ███   ███             
-#                            █                
-#
-#
-"""
-
-Collibra Connector Library
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Uses the Collibra API to connect and interact with Collibra's data governance platform.
-This library provides a simple interface to handle connection and URLs
-
-"""
-
-from .connector import CollibraConnector
-
-__version__ = "0.1.0"