pyegeria 0.3.8__py3-none-any.whl → 0.4.0__py3-none-any.whl

pyegeria/Xfeedback_manager_omvs.py

@@ -0,0 +1,238 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+ Feedback Manager View Service Methods - Add comments, reviews, tags and notes to elements of interest.
+
+ This work is being actively developed..
+
+"""
+import asyncio
+from datetime import datetime
+
+from httpx import Response
+
+from pyegeria import Client, max_paging_size, body_slimmer
+from pyegeria._exceptions import (
+    InvalidParameterException,
+)
+from ._validators import validate_name, validate_guid, validate_search_string
+
+
+class FeedbackManager(Client):
+    """ Set up and maintain automation services in Egeria.
+
+    Attributes:
+        server_name : str
+            The name of the View Server to use.
+        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
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
+
+    """
+
+    def __init__(
+            self,
+            server_name: str,
+            platform_url: str,
+            user_id: str,
+            user_pwd: str = None,
+            verify_flag: bool = False,
+    ):
+        Client.__init__(self, server_name, platform_url, user_id, user_pwd, verify_flag)
+        self.cur_command_root = f"{platform_url}/servers/"
+
+
+    async def _async_get_comment_by_guid(self, comment_guid: str, view_server: str, server: str = None,
+                                         access_service: str = 'asset-manager',for_lineage: bool = False,
+                                         for_duplicate_processing: bool = False, effective_time: str = None) -> dict:
+        """ Create a new metadata element from a template.  Async version.
+             Parameters
+             ----------
+             body : str
+                 The json body used to instantiate the template.
+             server : str, optional
+                The name of the view server to use. If not provided, the default server name will be used.
+
+             Returns
+             -------
+             Response
+                The guid of the resulting element
+
+             Raises
+             ------
+             InvalidParameterException
+             PropertyServerException
+             UserNotAuthorizedException
+
+             Notes
+             -----
+
+                """
+
+        server = self.server_name if server is None else server
+
+        url = f"{self.platform_url}/servers/{server}/api/open-metadata/automated-curation/catalog-templates/new-element"
+        response = await self._async_make_request("POST", url)
+        return response.json().get("guid", "GUID failed to be returned")
+
+    def get_comment_by_guid(self, comment_guid: str, view_server: str, server: str = None,
+                                         access_service: str = 'asset-manager',for_lineage: bool = False,
+                                         for_duplicate_processing: bool = False, effective_time: str = None) -> dict:
+        """ Create a new metadata element from a template.  Async version.
+           Parameters
+           ----------
+           body : str
+                The json body used to instantiate the template.
+           server : str, optional
+               The name of the view server to use. If not provided, the default server name will be used.
+
+           Returns
+           -------
+           Response
+               The guid of the resulting element
+
+            Raises
+            ------
+            InvalidParameterException
+            PropertyServerException
+            UserNotAuthorizedException
+
+            Notes
+            -----
+            See also: https://egeria-project.org/features/templated-cataloguing/overview/
+            The full description of the body is shown below:
+                {
+                  "typeName" : "",
+                  "initialStatus" : "",
+                  "initialClassifications" : "",
+                  "anchorGUID" : "",
+                  "isOwnAnchor" : "",
+                  "effectiveFrom" : "",
+                  "effectiveTo" : "",
+                  "templateGUID" : "",
+                  "templateProperties" : {},
+                  "placeholderPropertyValues" : {
+                    "placeholderPropertyName1" : "placeholderPropertyValue1",
+                    "placeholderPropertyName2" : "placeholderPropertyValue2"
+                  },
+                  "parentGUID" : "",
+                  "parentRelationshipTypeName" : "",
+                  "parentRelationshipProperties" : "",
+                  "parentAtEnd1" : "",
+                  "effectiveTime" : ""
+                }
+        """
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_comment_by_guid(comment_guid, view_server,server,access_service,
+                                            for_lineage,for_duplicate_processing,effective_time)
+        )
+        return response
+
+    async def _async_add_comment_to_reply(self, comment_guid: str, view_server: str, comment: str, server: str = None,
+                                          access_service: str = 'asset-manager', is_public: bool = False,
+                                          for_lineage: bool = False, for_duplicate_processing: bool = False,
+                                          effective_time: str = None) -> str:
+        """ Add a reply to a comment.  Async version.
+            See also: https://egeria-project.org/patterns/metadata-manager/overview/#asset-feedback
+
+        Parameters
+        ----------
+        comment_guid : str
+            The GUID of the comment.
+        view_server : str
+            The server where the view is hosted.
+        comment : str
+            The text to add as the reply.
+        server : str, optional
+            The server to connect to. Default is None.
+        access_service : str, optional
+            The access service to use. Default is 'asset-manager'.
+        is_public : bool, optional
+            Determines if the comment is public. Default is False.
+        for_lineage : bool, optional
+            Determines if the comment is for lineage. Default is False.
+        for_duplicate_processing : bool, optional
+            Determines if the comment is for duplicate processing. Default is False.
+        effective_time : str, optional
+            The effective time for the comment. Default is None.
+
+        Returns
+        -------
+        str
+            The unique identifier (guid) of the new comment.
+
+        Raises
+        ------
+        InvalidParameterException
+        PropertyServerException
+        UserNotAuthorizedException
+
+        """
+
+        url = f"{self.cur_command_root}api/open-metadata/feedback-manager/comments/{comment_guid}/replies"
+        body = {
+            'parentGUID': comment_guid,
+            'effectiveTime': effective_time,
+            'updateDescription': comment
+            }
+
+        response = await self._async_make_request("POST",url,body)
+        return response
+
+    def add_comment_to_reply(self, comment_guid: str, view_server: str, comment: str, server: str = None,
+                                          access_service: str = 'asset-manager', is_public: bool = False,
+                                          for_lineage: bool = False, for_duplicate_processing: bool = False,
+                                          effective_time: str = None) -> str:
+        """ Add a reply to a comment.  Async version.
+            See also: https://egeria-project.org/patterns/metadata-manager/overview/#asset-feedback
+
+        Parameters
+        ----------
+        comment_guid : str
+            The GUID of the comment.
+        view_server : str
+            The server where the view is hosted.
+        comment : str
+            The text to add as the reply.
+        server : str, optional
+            The server to connect to. Default is None.
+        access_service : str, optional
+            The access service to use. Default is 'asset-manager'.
+        is_public : bool, optional
+            Determines if the comment is public. Default is False.
+        for_lineage : bool, optional
+            Determines if the comment is for lineage. Default is False.
+        for_duplicate_processing : bool, optional
+            Determines if the comment is for duplicate processing. Default is False.
+        effective_time : str, optional
+            The effective time for the comment. Default is None.
+
+        Returns
+        -------
+        str
+            The unique identifier (guid) of the new comment.
+
+        Raises
+        ------
+        InvalidParameterException
+        PropertyServerException
+        UserNotAuthorizedException
+
+        """
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_add_comment_to_reply(comment_guid, view_server, comment,
+                                             server, access_service, is_public,)
+        )
+        return response
+
+

pyegeria/Xloaded_resources_omvs.py

@@ -0,0 +1,91 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+This module allows users to query the available (registered) capabilities of Egeria. Detailed information is returned
+to provide both insight and understanding in how to use these capabilities. For example, when configuring an Egeria
+integration service, it is importregistered_info.pyant to know what companion service it depends on so that you can make sure the
+companion service is also configured and running.
+
+"""
+
+from pyegeria import (
+    Client, max_paging_size, InvalidParameterException, PropertyServerException, UserNotAuthorizedException,
+    print_exception_response
+)
+
+
+
+class LoadedResources(Client):
+    """ Client to search and retrieve currently loaded information about connectors, templates, governance actions,
+        etc.
+
+    Attributes:
+    ----------
+        server_name: str
+                Name of the server to use.
+        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
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
+
+    Methods:
+    -------
+
+    """
+
+    admin_command_root: str
+
+    def __init__(
+            self,
+            server_name: str,
+            platform_url: str,
+            user_id: str,
+            user_pwd: str = None,
+            verify_flag: bool = False,
+    ):
+        if server_name is None:
+            server_name = "NA"
+        Client.__init__(self, server_name, platform_url,
+                        user_id, user_pwd, verify_flag)
+
+    def get_all_templates(self, server: str = None, start_from: int = 0, page_size: int = 0) -> list | str:
+        """ Get Loaded templates for the Server.
+
+           Parameters
+           ----------
+
+           Returns
+           -------
+           dict | str
+              A dictionary containing a simplified list of key template attributes.
+
+           Raises
+           ------
+           InvalidParameterException
+               If the response code is not 200.
+           PropertyServerException:
+               Raised by the server when an issue arises in processing a valid request
+           NotAuthorizedException:
+               The principle specified by the user_id does not have authorization for the requested action
+
+           """
+        server = self.server_name if server is None else server
+        url = (f"{self.platform_url}/servers/{server}/open-metadata/framework-services/asset-owner/open-metadata-store/"
+               f"users/{self.user_id}/metadata-elements/by-search-string?startFrom=start_from&pageSize=page_size")
+        body = {
+                  "class" : "SearchStringRequestBody",
+                  "searchString" : ".*Template.*"
+                }
+        response = self.make_request("POST", url, body)
+        return response.json().get("elementList", "No elements")
+
+    # def get_all_assets_in_archives(self, asset_type: str = None, archive_id: str = None, server: str= None, page_start:int = 0, page_size = max_paging_size):

pyegeria/__init__.py

@@ -11,17 +11,14 @@ the server platform and servers.
 
 """
 
-
-try:
-    import tomllib
-except ModuleNotFoundError:
-    import tomli as tomllib
-
-from ._globals import is_debug, disable_ssl_warnings, max_paging_size
+from ._globals import (is_debug, disable_ssl_warnings, max_paging_size,
+                       )
+from .core_guids import *
 
 if disable_ssl_warnings:
     from urllib3.exceptions import InsecureRequestWarning
     from urllib3 import disable_warnings
+
     disable_warnings(InsecureRequestWarning)
 
 from ._exceptions import (InvalidParameterException, PropertyServerException, UserNotAuthorizedException,
@@ -32,16 +29,22 @@ from .automated_curation_omvs import AutomatedCuration
 from .core_omag_server_config import CoreServerConfig
 from .platform_services import Platform
 from .registered_info import RegisteredInfo
-from .glossary_omvs import GlossaryBrowser
+from .glossary_browser_omvs import GlossaryBrowser
 from ._validators import (validate_user_id, validate_name, validate_guid, validate_server_name, validate_search_string,
                           validate_url, is_json, validate_public)
-# from .asset_catalog_omvs import AssetCatalog
-from .gov_engine import GovEng
+from .asset_catalog_omvs import AssetCatalog
+
 from .my_profile_omvs import MyProfile
 from .full_omag_server_config import FullServerConfig
 from .server_operations import ServerOps
 from .collection_manager_omvs import CollectionManager
 from .project_manager_omvs import ProjectManager
 from .valid_metadata_omvs import ValidMetadataManager
-from .loaded_resources_omvs import LoadedResources
-__version__ = "0.38"
+from .asset_catalog_omvs import AssetCatalog
+from .Xloaded_resources_omvs import LoadedResources
+from ._deprecated_gov_engine import GovEng
+from .runtime_manager_omvs import RuntimeManager
+from .action_author_omvs import GovernanceAuthor
+from .glossary_manager_omvs import GlossaryManager
+
+__version__ = "0.4"

pyegeria/_client.py

@@ -12,6 +12,7 @@ import json
 import os
 
 import httpx
+from httpx import AsyncClient, Response
 
 from pyegeria._exceptions import (
     OMAGCommonErrorCode,
@@ -126,9 +127,6 @@ class Client:
             self.headers["Authorization"] = f"Bearer {token}"
             self.text_headers["Authorization"] = f"Bearer {token}"
 
-        calling_frame = inspect.currentframe().f_back
-        caller_method = inspect.getframeinfo(calling_frame).function
-
         v_url = validate_url(platform_url)
 
         if v_url:
@@ -139,7 +137,7 @@ class Client:
             #     self.session = httpx.Client(verify=self.ssl_verify)
             # else:
             #     self.session = httpx.AsyncClient(verify=self.ssl_verify)
-            self.session = httpx.AsyncClient(verify=self.ssl_verify)
+            self.session = AsyncClient(verify=self.ssl_verify)
 
     def __enter__(self):
         return self
@@ -334,7 +332,7 @@ class Client:
         return self.text_headers["Authorization"]
 
     def make_request(self, request_type: str, endpoint: str, payload: str | dict = None,
-                     time_out: int = 30) -> dict | str:
+                     time_out: int = 30) -> Response | str:
         """ Make a request to the Egeria API"""
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(self._async_make_request(request_type, endpoint,
@@ -342,7 +340,7 @@ class Client:
         return response
 
     async def _async_make_request(self, request_type: str, endpoint: str, payload: str | dict = None,
-                                  time_out: int = 30) -> dict | str:
+                                  time_out: int = 30) -> Response | str:
         """  Make a request to the Egeria API - Async Version
         Function to make an API call via the self.session Library. Raise an exception if the HTTP response code
         is not 200/201. IF there is a REST communication exception, raise InvalidParameterException.

pyegeria/{gov_engine.py → _deprecated_gov_engine.py}

@@ -3,6 +3,8 @@ 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
+
+ This module is deprecated - please use Automated Curation.
 """
 
 from datetime import datetime
@@ -396,62 +398,3 @@ class GovEng(Client):
         response = self.make_request("POST", url, new_body)
         return response.json().get('guid')
 
-    def print_engine_action_summary(self, governance_action: dict):
-        """ print_governance_action_summary
-
-                Print all the governance actions with their status, in the server.
-
-                Parameters
-                ----------
-
-                Returns
-                -------
-
-                Raises
-                ------
-                InvalidParameterException
-                PropertyServerException
-                UserNotAuthorizedException
-                """
-        if governance_action:
-            name = governance_action.get('displayName')
-            if not name:
-                name = governance_action.get('qualifiedName')
-            action_status = governance_action.get('action_status')
-            if governance_action.get('completion_guards'):
-                completion_guards = governance_action.get('completion_guards')
-            else:
-                completion_guards = "\t"
-            if governance_action.get('process_name'):
-                process_name = governance_action.get('process_name')
-            else:
-                process_name = "\t"
-            if governance_action.get('completion_message'):
-                completion_message = governance_action.get('completion_message')
-            else:
-                completion_message = ""
-            print(action_status + "\n\t| " + name + "\t| " + process_name + "\t| " + '%s' % ', '.join(
-                map(str, completion_guards)) + "\t| " + completion_message)
-
-    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 is not None:
-            for x in range(len(governance_actions)):
-                self.print_engine_action_summary(governance_actions[x])

pyegeria/_exceptions.py

@@ -323,6 +323,7 @@ class EgeriaException(Exception):
 
     """
     raw_error_message = ""
+
     def __init__(self, response_body) -> None:
         response_dict = json.loads(response_body)
         self.response_class = response_dict["class"]
@@ -330,14 +331,12 @@ class EgeriaException(Exception):
         self.exception_class_name = response_dict["exceptionClassName"]
         self.action_description = response_dict["actionDescription"]
         self.exception_error_message = response_dict["exceptionErrorMessage"]
-        self.exception_error_message_id = response_dict["exceptionErrorMessageId"]
+        self.exception_error_message_id = response_dict.get("exceptionErrorMessageId", "UNKNOWN-ERROR-CODE")
 
         # self.exception_error_message_id = response_dict["exceptionErrorMessageId"]
-        self.exception_error_message_parameters = response_dict[
-            "exceptionErrorMessageParameters"
-        ]
-        self.exception_system_action = response_dict["exceptionSystemAction"]
-        self.exception_user_action = response_dict["exceptionUserAction"]
+        self.exception_error_message_parameters = response_dict.get("exceptionErrorMessageParameters", "{}")
+        self.exception_system_action = response_dict.get("exceptionSystemAction", "UNKNOWN-SYSTEM-ACTION")
+        self.exception_user_action = response_dict.get("exceptionUserAction", "UNKNOWN-USER-ACTION")
 
     def __str__(self):
         return self.exception_error_message

pyegeria/_globals.py

@@ -8,10 +8,11 @@ This common file is used to set some global values and enumerations used by the
 
 """
 
+
 is_debug = False
 disable_ssl_warnings = True
 enable_ssl_check = False
-max_paging_size = 100
+max_paging_size = 500
 
 comment_types = (
     "ANSWER",
@@ -29,3 +30,4 @@ star_ratings = (
     "THREE_STARS",
     "TWO_STARS",
 )
+