pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev2__py3-none-any.whl

pyegeria/gov_engine.py

@@ -1,573 +0,0 @@
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-
- Governance Engine functions.  These functions initiate and manage Governance Actions and Processes
-"""
-
-import sys
-import json
-from datetime import datetime
-from ._client import Client
-from ._globals import enable_ssl_check, is_debug
-from requests import Response
-
-
-from .exceptions import (
-    OMAGCommonErrorCode,
-    EgeriaException,
-    InvalidParameterException,
-    OMAGServerInstanceErrorCode,
-    PropertyServerException,
-    UserNotAuthorizedException
-    )
-
-
-
-def body_slimmer(body:dict)-> dict:
-    """ body_slimmer is a little function to remove unused keys from a dict
-
-    Parameters
-    ----------
-    body : the dictionary that you want to slim
-
-    Returns
-    -------
-    dict:
-        a slimmed body
-    """
-    slimmed = {key: value for key, value in body.items() if value}
-    return slimmed
-
-
-class GovEng(Client):
-    """
-       Client to initiate and manage governance actions and processes.
-
-       Attributes:
-           server_name: str
-                Name of the server to configure.
-           platform_url : str
-               URL of the server platform to connect to
-           user_id : str
-               The identity of the user calling the method - this sets a default optionally used by the methods
-               when the user doesn't pass the user_id on a method call.
-           user_pwd: str = None
-                The password associated with the user
-           verify_flag: bool = enable_ssl_check
-                Set true for SSL verification to be enabled, false for disabled. Default behaviour set by the
-                enable_ssl_check attribute from _globals.py
-
-       Methods:
-           __init__(self,
-                    platform_url: str,
-                    end_user_id: str,
-                    )
-            Initializes the connection - throwing an exception if there is a problem
-
-       """
-
-
-
-    def __init__(
-            self,
-            server_name: str,
-            platform_url: str,
-            user_id: str,
-            user_pwd: str = None,
-            verify_flag: bool = enable_ssl_check,
-    ):
-        self.admin_command_root: str
-        Client.__init__(self, server_name, platform_url, user_id,
-                        user_pwd, verify_flag)
-        self.engine_command_root = (
-                self.platform_url
-                + "/servers/" + server_name
-                + "/open-metadata/framework-services/governance-engine/open-governance-service/users/"
-                + user_id
-        )
-        # self.engine_info_root = (
-        #         self.platform_url
-        #         + "/servers/" + server_name
-        #         + "/open-metadata/framework-services/governance-engine/users/"
-        #         + user_id
-        # )
-
-    def get_engine_actions(self, start_from: str = 0, page_size: str = 0) -> [dict]:
-        """ Get engine actions associated deployed on the server.
-
-        Args:
-            start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
-            page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
-
-        Returns:
-            List[str]: A list of JSON representations of governance action processes matching the provided name.
-
-        Raises:
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-            this exception is raised with details from the response content.
-
-        Note:
-            Pagination of 0 defaults to server default.
-
-        """
-        url = (self.engine_command_root + "/engine-actions?startFrom=" +
-               str(start_from) + "&pageSize=" + str(page_size))
-        response = self.make_request("GET", url)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElements = response.json().get('elements')
-            return governanceActionElements
-        else:
-            raise InvalidParameterException(response.content)
-
-    def get_engine_action(self, engine_action_guid: str) -> str:
-        """ Return the governance action associated with the supplied guid
-
-        Parameters
-        ----------
-        engine_action_guid : str
-            The unique identifier of the engine action to retrieve.
-        Returns
-        -------
-        JSON string of the governance action associated with the guid
-
-        Raises
-        ------
-        InvalidParameterException
-        PropertyServerException
-        UserNotAuthorizedException
-        """
-
-        url = self.engine_command_root + "/engine-actions/" + engine_action_guid
-        response = self.make_request("GET", url)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElement = response.json().get('element')
-            return (governanceActionElement)
-        else:
-            raise InvalidParameterException(response.content)
-
-    def get_active_engine_actions(self, start_from:int = 0, page_size:int = 0) -> [str]:
-        """ Get active governance actions associated on the server.
-
-        Args:
-            start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
-            page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
-
-        Returns:
-            List[str]: A list of JSON representations of governance action processes matching the provided name.
-
-        Raises:
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-            this exception is raised with details from the response content.
-
-        Note:
-            Pagination of 0 defaults to server default.
-        """
-        url = (self.engine_command_root + "/engine-actions/active?startFrom=" +
-              str(start_from) + "&pageSize=" + str(page_size))
-
-        response = self.make_request("GET", url)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElements = response.json().get('elements')
-            return governanceActionElements
-        else:
-            raise InvalidParameterException(response.content)
-
-    def get_engine_actions_by_name(self, name: str, startFrom: int = 0, pageSize: int = 0) -> str:
-        """ Retrieve engine actions matching the name string.
-        Args:
-            name (str): The qualified name or display name of the governance action to get.
-            start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
-            page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
-
-        Returns:
-            List[str]: A list of JSON representations of governance action processes matching the provided name.
-
-        Raises:
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-            this exception is raised with details from the response content.
-
-        Note:
-            Pagination of 0 defaults to server default.
-
-        """
-        url = (self.engine_command_root + "/engine-actions/by-name?startFrom=" +
-               str(startFrom) + "&pageSize=" + str(pageSize))
-        body = {
-            "class": "NameRequestBody",
-            "name": name
-        }
-        response = self.make_request("POST", url, body)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElements = response.json().get('elements')
-            return governanceActionElements
-        else:
-            raise InvalidParameterException(response.content)
-
-    def find_engine_actions(self, search_string:str, startFrom: int=0, pageSize:int=0) -> [str]:
-        """ Search for engine actions matching the search string.
-
-        Args:
-            search_string (str): The search string to query for.
-            start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
-            page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
-
-        Returns:
-            List[str]: A list of JSON representations of governance action processes matching the provided name.
-
-        Raises:
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-            this exception is raised with details from the response content.
-
-        Note:
-            Pagination of 0 defaults to server default.
-       """
-        url = (self.engine_command_root + "/engine-actions/by-search-string?startFrom=" +
-              str(startFrom) + "&pageSize=" + str(pageSize))
-        body = {
-            "class": "SearchStringRequestBody",
-            "searchString": search_string
-        }
-        response = self.make_request("POST", url, body)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElements = response.json().get('elements')
-            return governanceActionElements
-        else:
-            raise InvalidParameterException(response.content)
-
-
-
-    def get_governance_action_process_by_guid(self, gov_process_guid: str)->str:
-        """
-            Retrieves information about a governance action process based on its GUID.
-
-            Args:
-                gov_process_guid (str): The GUID (Globally Unique Identifier) of the governance action process.
-
-            Returns:
-                str: The JSON representation of the governance action process element.
-
-            Raises:
-                InvalidParameterException: If the API response indicates an error (non-200 status code),
-                this exception is raised with details from the response content.
-                PropertyServerException: If the API response indicates a server side error.
-                UserNotAuthorizedException:
-
-            Note:
-                This method assumes that the provided GUID is valid and corresponds to an existing
-                governance action process in the system.
-
-            """
-        url = self.engine_command_root + "/governance-action-processes/" + gov_process_guid
-        response = self.make_request("GET", url)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElement = response.json().get('element')
-            return(governanceActionElement)
-        else:
-            raise InvalidParameterException(response.content)
-
-    def get_governance_action_processes_by_name(self, name:str, start_from: int=0, page_size: int=0) -> [str]:
-        """
-        Retrieves governance action processes based on their name only (no wildcards).
-
-        Args:
-            name (str): The qualified name or display name of the governance action to get.
-            start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
-            page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
-
-        Returns:
-            List[str]: A list of JSON representations of governance action processes matching the provided name.
-
-        Raises:
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-            this exception is raised with details from the response content.
-
-        Note:
-            Pagination of 0 defaults to server default.
-
-        """
-        url =   (self.engine_command_root + "/governance-action-processes/by-name?startFrom=" + str(start_from)
-                + "&pageSize=" + str(page_size))
-        body = {
-            "class"         : "NameRequestBody",
-            "name"          : name
-        }
-        response = self.make_request("POST", url, body)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElements = response.json().get('elements')
-            return governanceActionElements
-        else:
-            raise InvalidParameterException(response.content)
-
-    def find_governance_action_processes(self, search_string: str, start_from: int = 0, page_size: int = 0) -> [str]:
-        ''' Return governance action processes that match the search string (with regex).
-
-        Args:
-            search_string (str): The search string to query for.
-            start_from (int, optional): The index to start retrieving processes from. Defaults to 0.
-            page_size (int, optional): The number of processes to retrieve per page. Defaults to 0 (no pagination).
-
-        Returns:
-            List[str]: A list of JSON representations of governance action processes matching the provided name.
-
-        Raises:
-            InvalidParameterException: If the API response indicates an error (non-200 status code),
-            this exception is raised with details from the response content.
-
-        Note:
-            Pagination of 0 defaults to server default.
-
-        '''
-        url = (self.engine_command_root + "/governance-action-processes/by-search-string?startFrom=" + str(start_from)
-               + "&pageSize=" + str(page_size))
-        body = {
-            "class": "SearchStringRequestBody",
-            "searchString": search_string
-        }
-        response = self.make_request("POST", url, body)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            governanceActionElements = response.json().get('elements')
-            return governanceActionElements
-        else:
-            raise InvalidParameterException(response.content)
-
-    def initiate_governance_action_process(self, qualified_name: str, request_source_guids: [str],
-                                    action_targets: [str], start_time: datetime, request_parameters: dict,
-                                    orig_service_name: str, orig_engine_name: str
-                                    ) -> str:
-        """ initiate_gov_action_process
-
-        This method starts a governance action process using the supplied parameters.
-
-        Parameters
-        ----------
-        qualified_name: str
-            - unique name for the governance process
-        request_source_guids: [str]
-            - request source elements for the resulting governance action service
-        action_targets: [str]
-            -list of action target names to GUIDs for the resulting governance action service
-        start_time: datetime
-            - time to start the process
-        request_parameters: [str]
-            - parameters passed into the process
-        orig_service_name: str
-            - unique name of the requesting governance service (if initiated by a governance engine)
-        orig_engine_name: str
-            - optional unique name of the governance engine (if initiated by a governance engine).
-
-        Returns
-        -------
-        Unique id (guid) of the newly started governance engine process
-
-        Raises
-        ------
-        InvalidParameterException
-        PropertyServerException
-        UserNotAuthorizedException
-
-        """
-        url = self.engine_command_root + "/governance-action-processes/initiate"
-        body = {
-            "class"                     :"GovernanceActionProcessRequestBody",
-            "processQualifiedName"      : qualified_name,
-            "requestSourceGUIDs"        : request_source_guids,
-            "actionTargets"             : action_targets,
-            "startTime"                 : int(start_time.timestamp() * 1000),
-            "requestParameters"         : request_parameters,
-            "originatorServiceName"     : orig_service_name,
-            "originatorEngineName"      : orig_engine_name
-        }
-        new_body = body_slimmer(body)
-        response = self.make_request("POST", url, new_body)
-
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            return response.json().get('guid')
-        else:
-            raise InvalidParameterException(response.content)
-
-
-    def initiate_engine_action (self, qualified_name: str, domain_identifier: int, display_name: str,
-                             description: str, request_source_guids: str, action_targets: str,
-                             received_guards: [str], start_time: datetime, gov_engine_name: str,
-                             request_type: str, request_parameters: dict, process_name: str,
-                             request_src_name: str= None, originator_svc_name: str= None,
-                             originator_eng_name: str = None) -> str:
-        """
-            Initiates an engine action with the specified parameters.
-
-            Args:
-                qualified_name (str): The qualified name of the governance action.
-                domain_identifier (int): The domain identifier for the governance action.
-                display_name (str): The display name of the governance action.
-                description (str): The description of the governance action.
-                request_source_guids (str): GUIDs of the sources initiating the request.
-                action_targets (str): Targets of the governance action.
-                received_guards (List[str]): List of guards received for the action.
-                start_time (datetime): The start time for the governance action.
-                gov_engine_name (str): The name of the governance engine associated with the action.
-                request_type (str): The type of the governance action request.
-                request_parameters (dict): Additional parameters for the governance action.
-                process_name (str): The name of the associated governance action process.
-                request_src_name (str, optional): The name of the request source. Defaults to None.
-                originator_svc_name (str, optional): The name of the originator service. Defaults to None.
-                originator_eng_name (str, optional): The name of the originator engine. Defaults to None.
-
-            Returns:
-                str: The GUID (Globally Unique Identifier) of the initiated governance action.
-
-            Raises:
-                InvalidParameterException: If the API response indicates an error (non-200 status code),
-                this exception is raised with details from the response content.
-
-            Note:
-                The `start_time` parameter should be a `datetime` object representing the start time of the governance action.
-
-
-            """
-        url = self.engine_command_root + ("/governance-engines/" + gov_engine_name +
-                                          "/engine-actions/initiate")
-
-        body = {
-            "class"                     : "GovernanceActionRequestBody",
-            "qualifiedName"             : qualified_name + str(int(start_time.timestamp())),
-            "domainIdentifier"          : domain_identifier,
-            "displayName"               : display_name,
-            "description"               : description,
-            "requestSourceGUIDs"        : request_source_guids,
-            "actionTargets"             : action_targets,
-            "receivedGuards"            : received_guards,
-            "startTime"                 : int(start_time.timestamp()*1000),
-            "requestType"               : request_type,
-            "requestParameters"         : request_parameters,
-            "processName"               : process_name,
-            "requestSourceName"         : request_src_name,
-            "originatorServiceName"     : originator_svc_name,
-            "originatorEngineName"      : originator_eng_name
-        }
-        new_body = body_slimmer(body)
-        response = self.make_request("POST", url, new_body)
-        if response.status_code != 200:
-            return response.json()  # should never get here?
-
-        related_code = response.json().get("relatedHTTPCode")
-        if related_code == 200:
-            return response.json().get('guid')
-        else:
-            raise InvalidParameterException(response.content)
-
-
-    def print_engine_action_summary(self,governanceAction: dict):
-        """ print_governance_action_summary
-
-                Print all the governance actions with their status, in the server.
-
-                Parameters
-                ----------
-
-                Returns
-                -------
-
-                Raises
-                ------
-                InvalidParameterException
-                PropertyServerException
-                UserNotAuthorizedException
-                """
-        if governanceAction:
-            name = governanceAction.get('displayName')
-            if not name:
-                name = governanceAction.get('qualifiedName')
-            actionStatus = governanceAction.get('actionStatus')
-            if governanceAction.get('completionGuards'):
-                completionGuards = governanceAction.get('completionGuards')
-            else:
-                completionGuards = "\t"
-            if governanceAction.get('processName'):
-                processName = governanceAction.get('processName')
-            else:
-                processName = "\t"
-            if governanceAction.get('completionMessage'):
-                completionMessage = governanceAction.get('completionMessage')
-            else:
-                completionMessage = ""
-            print(actionStatus + "\n\t| " + name + "\t| " + processName + "\t| " + '%s' % ', '.join(
-                map(str, completionGuards)) + "\t| " + completionMessage)
-
-    def print_engine_actions(self):
-        """ print_governance_actions
-
-                Print all the governance actions with their status, in the server.
-
-                Parameters
-                ----------
-
-                Returns
-                -------
-
-                Raises
-                ------
-                InvalidParameterException
-                PropertyServerException
-                UserNotAuthorizedException
-
-        """
-        governance_actions = self.get_engine_actions(0,0)
-        if governance_actions != None:
-            for x in range(len(governance_actions)):
-                self.print_engine_action_summary(governance_actions[x])
-
-
-
-
-
-
-
-
-
-
-

pyegeria-0.2.4.dist-info/METADATA

@@ -1,57 +0,0 @@
-Metadata-Version: 2.1
-Name: pyegeria
-Version: 0.2.4
-Summary: A python client for Egeria
-Project-URL: Homepage, https://github.com/odpi/egeria-python
-Project-URL: Issues, https://github.com/odpi/egeria-python/issues
-Author-email: Dan Wolfson <dan.wolfson@pdr-associates.com>
-License-File: LICENSE
-Keywords: egeria,governance,metadata
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
-Requires-Dist: httpx~=0.26.0
-Requires-Dist: pandas~=2.2.0
-Requires-Dist: pytest~=7.4.2
-Requires-Dist: requests~=2.31.0
-Requires-Dist: rich~=13.7.1
-Requires-Dist: tabulate~=0.9.0
-Requires-Dist: urllib3~=1.26.15
-Requires-Dist: validators~=0.22.0
-Description-Content-Type: text/markdown
-
-<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-<!-- Copyright Contributors to the ODPi Egeria project. -->
-
-![Egeria Logo](https://github.com/odpi/egeria/blob/master/assets/img/ODPi_Egeria_Logo_color.png?raw=true)
-
-[![GitHub](https://img.shields.io/github/license/odpi/egeria)](LICENSE)
-
-
-# pyegeria: a python client for Egeria
-
-This is an experimental package for easily using the Egeria
-open metadata environment from python. Details about the
-open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
-
-This package is in active development. There is initial
-support for Egeria's platform services and configuration of Open Metadata and Governance servers
-along with some basic utilities. 
-Next will be additional support to configure and operate servers, followed
-by glossary support.
-
-The code is organized to mimic the existing Egeria Java Client structure.
-
-All feedback is welcome. Please engage via our [community](http://egeria-project.org/guides/community/), 
-team calls, or via github issues in this repo. If interested in contributing,
-you can engage via the community or directly reach out to
-[dan.wolfson\@pdr-associates.com](mailto:dan.wolfson@pdr-associates.com?subject=pyegeria).
-
-This is a learning experience.
-
-
-
-----
-License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
-Copyright Contributors to the ODPi Egeria project.

pyegeria-0.2.4.dist-info/RECORD

@@ -1,19 +0,0 @@
-pyegeria/__init__.py,sha256=Rd8lF5FOXZWwvzGRxcQalmEW_N3eQh1NOjJI-ayt85w,1220
-pyegeria/_client.py,sha256=835PUECHzGSpKigQ54TRwmSj1vqnPrS3wmx64Yb4uJs,20990
-pyegeria/_exceptions.py,sha256=E4d60USV3A6X7e3WzE0f7o7U7wAntS0ajvXeMrBKRzg,18306
-pyegeria/_globals.py,sha256=WgJ6O7_ACiAG8CUUHT_AbGgahLhO0APU8Y4rCwv9DRw,558
-pyegeria/_validators.py,sha256=Gd2BnFYYUWWJ0OBWvlGE3-ENQE22pyKTfsvep8eWaQ8,12701
-pyegeria/config.toml,sha256=2Jp6ozhlVgDLWeG5702dTTAYEUv_jYNAFFWpEyR8xV8,214
-pyegeria/core_omag_server_config.py,sha256=vDNeOdxN548g5SZUHSTtK8iz0lE8jbcj7XgRllNA5Dk,93098
-pyegeria/curation_omvs.py,sha256=b_QutK9kAhpdaAjv5zTAneURmsZrMiKZymEeYV9Y1Fg,18952
-pyegeria/exceptions.py,sha256=LImJPHy7MVgoH17LfqEL4ytLKcOhV7oCe66wZiDBzec,18399
-pyegeria/glossary_omvs.py,sha256=txe8wMWEGFoglWT1ACgeI9m54fNyP0E1r8T4b8Otbyc,29809
-pyegeria/gov_engine.py,sha256=gR79hwQsqsteS8m4C22KQqQsUesqhJEqlZ1AUEglrIM,23234
-pyegeria/platform_services.py,sha256=aAQ5zI7JL3LURDyTZDLr1mP21hfjC6Y-KPfERmWpLD4,41885
-pyegeria/registered_info.py,sha256=vffGbrb4nD3_mp6MfAan8pC82vRJTRHKGTbF0Giy1PM,7502
-pyegeria/server_operations.py,sha256=uKQl9ONH3kxPictvNfX4OFSC4y0zqvTL6XZ-mMuwBD0,13107
-pyegeria/utils.py,sha256=qA9VYct7hf76l9lvgZgMmcygst-_ikUrm08VWO67IGg,5252
-pyegeria-0.2.4.dist-info/METADATA,sha256=Q4mn77DP1SCjZm10dg-sGZYE_yNfr24KCg_FlETDQ4Y,2179
-pyegeria-0.2.4.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
-pyegeria-0.2.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-0.2.4.dist-info/RECORD,,