pyegeria 0.7.45__py3-none-any.whl → 0.8.0__py3-none-any.whl

examples/widgets/tech/list_relationship_types.py

@@ -26,23 +26,31 @@ from pyegeria import (
 from pyegeria import ValidMetadataManager
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
-EGERIA_KAFKA_ENDPOINT = os.environ.get('KAFKA_ENDPOINT', 'localhost:9092')
-EGERIA_PLATFORM_URL = os.environ.get('EGERIA_PLATFORM_URL', 'https://localhost:9443')
-EGERIA_VIEW_SERVER = os.environ.get('VIEW_SERVER', 'view-server')
-EGERIA_VIEW_SERVER_URL = os.environ.get('EGERIA_VIEW_SERVER_URL', 'https://localhost:9443')
-EGERIA_INTEGRATION_DAEMON = os.environ.get('INTEGRATION_DAEMON', 'integration-daemon')
-EGERIA_ADMIN_USER = os.environ.get('ADMIN_USER', 'garygeeke')
-EGERIA_ADMIN_PASSWORD = os.environ.get('ADMIN_PASSWORD', 'secret')
-EGERIA_USER = os.environ.get('EGERIA_USER', 'erinoverview')
-EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
-EGERIA_JUPYTER = bool(os.environ.get('EGERIA_JUPYTER', 'False'))
-EGERIA_WIDTH = int(os.environ.get('EGERIA_WIDTH', '200'))
-
-
-def display_relationship_types(type_name: str, server: str, url: str,
-                 username: str, user_pass: str, save_output: bool = False, jupyter: bool = EGERIA_JUPYTER,
-                 width: int = EGERIA_WIDTH
-                 ):
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_relationship_types(
+    type_name: str,
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    save_output: bool = False,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
     p_client = ValidMetadataManager(server, url, user_id=username)
     token = p_client.create_egeria_bearer_token(username, user_pass)
 
@@ -58,7 +66,7 @@ def display_relationship_types(type_name: str, server: str, url: str,
             show_lines=True,
             box=box.ROUNDED,
             caption=f"list for Server '{server}' @ Platform - {url}",
-            expand=True
+            expand=True,
         )
 
         table.add_column("Status")
@@ -85,38 +93,49 @@ def display_relationship_types(type_name: str, server: str, url: str,
             raise ValueError("-->This is not a known Type")
         else:
             for types in types_list:
-
-                name = types['name']
+                name = types["name"]
                 # guid = types['guid']
-                status = types['initialStatus']
-                description = types['description']
+                status = types["initialStatus"]
+                description = types["description"]
                 description_wiki = types.get("descriptionWiki", " ")
                 attribute_defs = types.get("attributeDefinitions")
                 if attribute_defs:
                     for attr in attribute_defs:
-                        attr_name = attr['attributeName']
-                        attr_desc = attr['attributeDescription']
-                        attr_status = attr['attributeStatus']
-                        attr_type = attr['attributeType']["name"]
+                        attr_name = attr["attributeName"]
+                        attr_desc = attr["attributeDescription"]
+                        attr_status = attr["attributeStatus"]
+                        attr_type = attr["attributeType"]["name"]
                         table.add_row(
-                            status, name, description, attr_name, attr_status, attr_type, attr_desc,
-                            description_wiki
+                            status,
+                            name,
+                            description,
+                            attr_name,
+                            attr_status,
+                            attr_type,
+                            attr_desc,
+                            description_wiki,
                         )
                 else:
-                    table.add_row(status, name, description, description_wiki, " ", " ", " ", " ")
+                    table.add_row(
+                        status, name, description, description_wiki, " ", " ", " ", " "
+                    )
 
         p_client.close_session()
         return table
 
     try:
-
         console = Console(width=width, force_terminal=not jupyter, record=True)
         with console.pager(styles=True):
             console.print(generate_table(type_name))
         if save_output:
             console.save_html("projects.html")
 
-    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ValueError) as e:
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
         if type(e) is str:
             print(e)
         else:

examples/widgets/tech/list_valid_metadata_values.py

@@ -27,24 +27,34 @@ from pyegeria import (
     print_exception_response,
 )
 from pyegeria import ValidMetadataManager
+
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
-EGERIA_KAFKA_ENDPOINT = os.environ.get('KAFKA_ENDPOINT', 'localhost:9092')
-EGERIA_PLATFORM_URL = os.environ.get('EGERIA_PLATFORM_URL', 'https://localhost:9443')
-EGERIA_VIEW_SERVER = os.environ.get('VIEW_SERVER', 'view-server')
-EGERIA_VIEW_SERVER_URL = os.environ.get('EGERIA_VIEW_SERVER_URL', 'https://localhost:9443')
-EGERIA_INTEGRATION_DAEMON = os.environ.get('INTEGRATION_DAEMON', 'integration-daemon')
-EGERIA_ADMIN_USER = os.environ.get('ADMIN_USER', 'garygeeke')
-EGERIA_ADMIN_PASSWORD = os.environ.get('ADMIN_PASSWORD', 'secret')
-EGERIA_USER = os.environ.get('EGERIA_USER', 'erinoverview')
-EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
-EGERIA_JUPYTER = bool(os.environ.get('EGERIA_JUPYTER', 'False'))
-EGERIA_WIDTH = int(os.environ.get('EGERIA_WIDTH', '200'))
-
-
-def display_metadata_values(property_name: str, type_name: str, server: str, url: str,
-                   username: str,  user_pass:str, save_output: bool, jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_metadata_values(
+    property_name: str,
+    type_name: str,
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    save_output: bool,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
 ):
-
     m_client = ValidMetadataManager(server, url, user_id=username)
     token = m_client.create_egeria_bearer_token(username, user_pass)
 
@@ -60,7 +70,7 @@ def display_metadata_values(property_name: str, type_name: str, server: str, url
             show_lines=True,
             box=box.ROUNDED,
             caption=f"Valid Metadata Values for Server '{server}' @ Platform - {url}",
-            expand=True
+            expand=True,
         )
 
         table.add_column("Category")
@@ -84,20 +94,28 @@ def display_metadata_values(property_name: str, type_name: str, server: str, url
             status = " "
             sponsor = " "
         elif type(valid_values[0]) == str:
-            raise ValueError("-->This is not a known metadata property with a valid value")
+            raise ValueError(
+                "-->This is not a known metadata property with a valid value"
+            )
         else:
             for value in valid_values:
-                category = value.get("category","None")
-                display_name = value.get("displayName","None")
+                category = value.get("category", "None")
+                display_name = value.get("displayName", "None")
                 preferred_value = value.get("preferredValue", "None ")
                 deprecated = str(value.get("isDeprecated", "None "))
                 case_sensitive = str(value.get("isCaseSensitive", "None"))
                 description = value.get("description", "None")
-                additional_properties = value.get('additionalProperties',"None")
+                additional_properties = value.get("additionalProperties", "None")
                 if additional_properties is not None:
                     props = json.dumps(additional_properties)
                 table.add_row(
-                    category, display_name, preferred_value, deprecated, case_sensitive, props,description
+                    category,
+                    display_name,
+                    preferred_value,
+                    deprecated,
+                    case_sensitive,
+                    props,
+                    description,
                 )
 
         m_client.close_session()
@@ -114,12 +132,18 @@ def display_metadata_values(property_name: str, type_name: str, server: str, url
         if save_output:
             console.save_html("valid-metadata-values.html")
 
-    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ValueError) as e:
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
         if type(e) is str:
             print(e)
         else:
             print_exception_response(e)
 
+
 def main():
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -136,12 +160,17 @@ def main():
     user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
     save_output = args.save_output if args.save_output is not None else False
 
-
     try:
-        property_name = Prompt.ask("Enter the Property to retrieve:", default="projectHealth")
-        type_name = Prompt.ask("Enter the Metadata Type to filter on:", default="Project")
-        display_metadata_values(property_name, type_name,server, url, userid, user_pass, save_output)
-    except(KeyboardInterrupt):
+        property_name = Prompt.ask(
+            "Enter the Property to retrieve:", default="projectHealth"
+        )
+        type_name = Prompt.ask(
+            "Enter the Metadata Type to filter on:", default="Project"
+        )
+        display_metadata_values(
+            property_name, type_name, server, url, userid, user_pass, save_output
+        )
+    except KeyboardInterrupt:
         pass
 
 

examples/widgets/tech/x_list_related_elements.py

@@ -23,34 +23,45 @@ from pyegeria import (
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    ClassificationManager
+    ClassificationManager,
 )
 
 console = Console()
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
-EGERIA_KAFKA_ENDPOINT = os.environ.get('KAFKA_ENDPOINT', 'localhost:9092')
-EGERIA_PLATFORM_URL = os.environ.get('EGERIA_PLATFORM_URL', 'https://localhost:9443')
-EGERIA_VIEW_SERVER = os.environ.get('VIEW_SERVER', 'view-server')
-EGERIA_VIEW_SERVER_URL = os.environ.get('EGERIA_VIEW_SERVER_URL', 'https://localhost:9443')
-EGERIA_INTEGRATION_DAEMON = os.environ.get('INTEGRATION_DAEMON', 'integration-daemon')
-EGERIA_ADMIN_USER = os.environ.get('ADMIN_USER', 'garygeeke')
-EGERIA_ADMIN_PASSWORD = os.environ.get('ADMIN_PASSWORD', 'secret')
-EGERIA_USER = os.environ.get('EGERIA_USER', 'erinoverview')
-EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
-EGERIA_JUPYTER = bool(os.environ.get('EGERIA_JUPYTER', 'False'))
-EGERIA_WIDTH = int(os.environ.get('EGERIA_WIDTH', '200'))
-
-
-def display_related_elements(element_guid: str, relationship: str, om_type: str, server: str,
-                             url: str, username: str, password: str, jupyter: bool = EGERIA_JUPYTER,
-                             width: int = EGERIA_WIDTH
-                             ):
+EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
+EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
+EGERIA_VIEW_SERVER = os.environ.get("VIEW_SERVER", "view-server")
+EGERIA_VIEW_SERVER_URL = os.environ.get(
+    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
+)
+EGERIA_INTEGRATION_DAEMON = os.environ.get("INTEGRATION_DAEMON", "integration-daemon")
+EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
+EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
+EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+
+
+def display_related_elements(
+    element_guid: str,
+    relationship: str,
+    om_type: str,
+    server: str,
+    url: str,
+    username: str,
+    password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
     c_client = ClassificationManager(server, url, user_id=username, user_pwd=password)
     token = c_client.create_egeria_bearer_token()
     rel_el = c_client.get_related_elements(element_guid, relationship, om_type)
 
     if type(rel_el) is str:
-        print(f"\n\nWas not able find related elements for {element_guid} with relationship {relationship}\n\n")
+        print(
+            f"\n\nWas not able find related elements for {element_guid} with relationship {relationship}\n\n"
+        )
         sys.exit(0)
 
     def generate_table() -> Table:
@@ -78,23 +89,23 @@ def display_related_elements(element_guid: str, relationship: str, om_type: str,
         for related_element in rel_el:
             relationship_props = related_element["relationshipProperties"]
 
-            rel_prop_md = ''
+            rel_prop_md = ""
             for key in relationship_props.keys():
                 rel_prop_md += f"{key}: {relationship_props[key]}\n"
             # rel_prop_out = Markdown(rel_prop_md)
 
-            rel_element = related_element['relatedElement']
+            rel_element = related_element["relatedElement"]
             el = rel_element["properties"]
             for prop in el:
-                el_case = el.get("isCaseSensitive", '---')
-                el_pref = el.get("preferredValue", '---')
-                el_desc = el.get("description", '---')
-                el_add = el.get("additionalProperties", '---')
-
-                el_add_md = ''
-                el_add_f = el_add.replace('\u003d',':')
-                s = el_add.strip('{}').strip()
-                pairs = [i.split('=') for i in s.split(', ')]
+                el_case = el.get("isCaseSensitive", "---")
+                el_pref = el.get("preferredValue", "---")
+                el_desc = el.get("description", "---")
+                el_add = el.get("additionalProperties", "---")
+
+                el_add_md = ""
+                el_add_f = el_add.replace("\u003d", ":")
+                s = el_add.strip("{}").strip()
+                pairs = [i.split("=") for i in s.split(", ")]
                 # d_add_prop = dict(pairs)
                 # for key in d_add_prop.keys():
                 #     el_add_md += f"{key}: {d_add_prop[key]}\n"
@@ -110,7 +121,11 @@ def display_related_elements(element_guid: str, relationship: str, om_type: str,
         with console.pager(styles=True):
             console.print(generate_table())
 
-    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
     finally:
@@ -134,10 +149,15 @@ def main():
 
     try:
         element_guid = Prompt.ask("Enter an Element GUID find relationships for")
-        relationship = Prompt.ask("Enter the relationship to search", default="SpecificationPropertyAssignment")
+        relationship = Prompt.ask(
+            "Enter the relationship to search",
+            default="SpecificationPropertyAssignment",
+        )
         om_type = Prompt.ask("Enter an optional Open Metadata Type", default=None)
-        display_related_elements(element_guid, relationship, om_type, server, url, userid, password)
-    except(KeyboardInterrupt):
+        display_related_elements(
+            element_guid, relationship, om_type, server, url, userid, password
+        )
+    except KeyboardInterrupt:
         pass
 
 

pyegeria/Xloaded_resources_omvs.py

@@ -12,14 +12,17 @@ companion service is also configured and running.
 """
 
 from pyegeria import (
-    Client, max_paging_size, InvalidParameterException, PropertyServerException, UserNotAuthorizedException,
-    print_exception_response
+    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,
+    """Client to search and retrieve currently loaded information about connectors, templates, governance actions,
         etc.
 
     Attributes:
@@ -45,48 +48,47 @@ class LoadedResources(Client):
     admin_command_root: str
 
     def __init__(
-            self,
-            server_name: str,
-            platform_url: str,
-            user_id: str,
-            user_pwd: str = None,
-            verify_flag: bool = False,
+        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 = max_paging_size) -> 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
-
-           """
+        Client.__init__(self, server_name, platform_url, user_id, user_pwd)
+
+    def get_all_templates(
+        self, server: str = None, start_from: int = 0, page_size: int = max_paging_size
+    ) -> 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.*"
-                }
+        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

@@ -63,12 +63,16 @@ 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 .action_author_omvs import ActionAuthor
 from .glossary_manager_omvs import GlossaryManager
 from .create_tech_guid_lists import build_global_guid_lists
 from .classification_manager_omvs import ClassificationManager
 from .feedback_manager_omvs import FeedbackManager
 from .mermaid_utilities import load_mermaid, render_mermaid, generate_process_graph
+from .egeria_my_client import EgeriaMy
+from .egeria_cat_client import EgeriaCat
+from .egeria_tech_client import EgeriaTech
+from .egeria_config_client import EgeriaConfig
 
 
 #