pyegeria 5.2.0.20__py3-none-any.whl → 5.2.0.42.3__py3-none-any.whl

pyegeria/commands/tech/get_tech_type_template.py

@@ -20,21 +20,23 @@ from pyegeria import (
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    AutomatedCuration
+    AutomatedCuration,
 )
 
 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'))
+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"))
 
 
 disable_ssl_warnings = True
@@ -42,12 +44,18 @@ console = Console(width=200)
 
 guid_list = []
 
-def template_viewer(tech_name: str, server_name:str, platform_url:str, user:str, user_pass:str,
-                jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH):
 
+def template_viewer(
+    tech_name: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_pass: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
     def build_classifications(classification: dict) -> Markdown:
-
-        class_md = ("\n")
+        class_md = "\n"
         for c in classification:
             c_type = c["classificationName"]
             if c_type == "Anchors":
@@ -65,53 +73,59 @@ def template_viewer(tech_name: str, server_name:str, platform_url:str, user:str,
         return output
 
     try:
-
         console = Console(width=width, force_terminal=not jupyter)
 
-        a_client = AutomatedCuration(server_name, platform_url,
-                                     user_id=user)
+        a_client = AutomatedCuration(server_name, platform_url, user_id=user)
 
         token = a_client.create_egeria_bearer_token(user, user_pass)
-        tech_elements = a_client.get_technology_type_elements(tech_name, get_templates=True)
+        tech_elements = a_client.get_technology_type_elements(
+            tech_name, get_templates=True
+        )
         if (len(tech_elements) >= 1) and (type(tech_elements) is list):
-            tree = Tree(f"Deployed Technology Type: {tech_name}", style="bold bright_white", guide_style="bold bright_blue")
-            note: str =" "
+            tree = Tree(
+                f"Deployed Technology Type: {tech_name}",
+                style="bold bright_white",
+                guide_style="bold bright_blue",
+            )
+            note: str = " "
             for element in tech_elements:
-                header = element['elementHeader']
+                header = element["elementHeader"]
                 tech_type = header["type"]["typeName"]
-                tech_collection = header["origin"]['homeMetadataCollectionName']
-                tech_created_by = header['versions']['createdBy']
-                tech_created_at = header['versions']['createTime']
-                tech_guid = header['guid']
-                tech_classifications = header['classifications']
+                tech_collection = header["origin"]["homeMetadataCollectionName"]
+                tech_created_by = header["versions"]["createdBy"]
+                tech_created_at = header["versions"]["createTime"]
+                tech_guid = header["guid"]
+                tech_classifications = header["classifications"]
                 class_md = build_classifications(tech_classifications)
 
-                referenceables = element['referenceableProperties']
-                tech_qualified_name = referenceables['qualifiedName']
-                extended = referenceables['extendedProperties']
-                ex_md:str = ""
+                referenceables = element["referenceableProperties"]
+                tech_qualified_name = referenceables["qualifiedName"]
+                extended = referenceables["extendedProperties"]
+                ex_md: str = ""
                 for key, value in extended.items():
                     ex_md += f"* {key}: {value}\n"
 
-                note = (f"* Qualified Name: {tech_qualified_name}\n"
-                              f"* GUID: {tech_guid}\n"
-                              f"* Createdy by: {tech_created_by}\n"
-                              f"* Created at: {tech_created_at}\n"
-                              f"* Home Collection: {tech_collection}\n"
-                              f"{class_md}\n"
-                              f"{ex_md}\n"
-                              )
-
-                interfaces = extended.get('connectorInterfaces', None)
+                note = (
+                    f"* Qualified Name: {tech_qualified_name}\n"
+                    f"* GUID: {tech_guid}\n"
+                    f"* Createdy by: {tech_created_by}\n"
+                    f"* Created at: {tech_created_at}\n"
+                    f"* Home Collection: {tech_collection}\n"
+                    f"{class_md}\n"
+                    f"{ex_md}\n"
+                )
+
+                interfaces = extended.get("connectorInterfaces", None)
                 if interfaces is not None:
-                    interface_type_name = interfaces['typeName']
-                    interface_array_cnt = interfaces['arrayCount']
+                    interface_type_name = interfaces["typeName"]
+                    interface_array_cnt = interfaces["arrayCount"]
                     note += f"* Interface Type: {interface_type_name}\n"
                     for i in range(0, int(interface_array_cnt)):
-                        note += (f"\t* Type: {interfaces['arrayValues']['propertyValueMap'][str(i)]['typeName']}"
-                                f"\tName: {interfaces['arrayValues']['propertiesAsStrings'][str(i)]}\n"
-                                )
-                note_md = Panel.fit(Markdown(note), style = 'bold bright_white on black')
+                        note += (
+                            f"\t* Type: {interfaces['arrayValues']['propertyValueMap'][str(i)]['typeName']}"
+                            f"\tName: {interfaces['arrayValues']['propertiesAsStrings'][str(i)]}\n"
+                        )
+                note_md = Panel.fit(Markdown(note), style="bold bright_white on black")
                 t = tree.add(note_md)
 
         else:
@@ -120,7 +134,7 @@ def template_viewer(tech_name: str, server_name:str, platform_url:str, user:str,
     except (
         InvalidParameterException,
         PropertyServerException,
-        UserNotAuthorizedException
+        UserNotAuthorizedException,
     ) as e:
         print_exception_response(e)
 
@@ -140,11 +154,13 @@ def main():
     user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
 
     try:
-        tech_name = Prompt.ask("Enter the Asset Name to view:", default="Apache Kafka Server")
-        template_viewer(tech_name,server, url, userid, user_pass)
-    except(KeyboardInterrupt):
+        tech_name = Prompt.ask(
+            "Enter the Asset Name to view:", default="Apache Kafka Server"
+        )
+        template_viewer(tech_name, server, url, userid, user_pass)
+    except KeyboardInterrupt:
         pass
 
 
 if __name__ == "__main__":
-    main()
+    main()

pyegeria/commands/tech/list_anchored_elements.py

@@ -3,8 +3,6 @@
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-Unit tests for the Utils helper functions using the Pytest framework.
-
 
 Retrieve elements based on a search of a specified properties.
 """
@@ -48,7 +46,7 @@ disable_ssl_warnings = True
 
 def display_anchored_elements(
     search_string: str,
-    prop_list: [str],
+    prop_list: list[str],
     server: str,
     url: str,
     username: str,
@@ -59,16 +57,18 @@ def display_anchored_elements(
 ):
     console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
     if (search_string is None) or (len(search_string) < 3):
-        raise ValueError(
-            "Invalid Search String - must be greater than four characters long"
+        print(
+            "\nError --> Invalid Search String - must be greater than four characters long"
         )
+        sys.exit(3)
     g_client = EgeriaTech(server, url, username, user_password)
     token = g_client.create_egeria_bearer_token()
+    print(f"search string is {search_string} and prop_list is {prop_list}\n")
 
     def generate_table(search_string: str, prop_list: [str]) -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Assets containing the string  {search_string} @ {time.asctime()}",
+            title=f"Elements containing the string  {search_string} @ {time.asctime()}",
             header_style="white on dark_blue",
             style="bold white on black",
             row_styles=["bold white on black"],
@@ -89,6 +89,7 @@ def display_anchored_elements(
         classification = "Anchors"
         open_type_name = None
         property_value = search_string
+
         property_names = prop_list
 
         elements = g_client.find_elements_by_classification_with_property_value(
@@ -148,11 +149,6 @@ def display_anchored_elements(
         return table
 
     try:
-        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
-        #     while True:
-        #         time.sleep(2)
-        #         live.update(generate_table())
-
         with console.pager(styles=True):
             console.print(generate_table(search_string, prop_list), soft_wrap=True)
 
@@ -164,7 +160,7 @@ def display_anchored_elements(
         console.print_exception()
         sys.exit(1)
 
-    except ValueError as e:
+    except Exception as e:
         console.print(
             f"\n\n====> Invalid Search String - must be greater than four characters long"
         )
@@ -191,9 +187,16 @@ def main():
         prop_list = Prompt.ask(
             "Enter the list of properties to search", default="anchorTypeName"
         )
-        display_anchored_elements(
-            search_string, [prop_list], server, url, userid, user_pass, time_out
-        )
+        if search_string == "":
+            print("\nError --> Search string can't be empty")
+            sys.exit(1)
+        elif len(search_string) <= 4:
+            print("\nError --> Search string must be greater than four characters long")
+            sys.exit(2)
+        else:
+            display_anchored_elements(
+                search_string, [prop_list], server, url, userid, user_pass, time_out
+            )
     except KeyboardInterrupt:
         pass
 

pyegeria/commands/tech/list_elements_x.py

@@ -102,13 +102,13 @@ def list_elements_x(
                 if type(tags) is list:
                     for tag in tags:
                         tags_md += (
-                            f"* tag: {tag.get('name','---')}\n"
+                            f"* tag: {tag.get('name','')}\n"
                             f"\t description: {tag.get('description','---')}\n"
                             f"\t assigned by: {tag.get('user','---')}\n"
                         )
 
                 else:
-                    tags_md = "---"
+                    tags_md = ""
 
                 likes = c_client.get_attached_likes(el_guid)
                 likes_md = "Likes:\b"
@@ -122,9 +122,12 @@ def list_elements_x(
                         )
 
                 else:
-                    likes_md = "---"
+                    likes_md = ""
 
-                feedback_out = f"{tags_md}\n --- \n{likes_md}"
+                if len(tags_md) > 0 and len(likes_md) > 0:
+                    feedback_out = f"{tags_md}\n --- \n{likes_md}"
+                else:
+                    feedback_out = ""
 
                 comments_out = " "
 

pyegeria/commands/tech/list_registered_services.py

@@ -71,7 +71,7 @@ def display_registered_svcs(
     def generate_table(svc_list) -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Technology Types for: {url} @ {time.asctime()}",
+            title=f"Services for: {url} @ {time.asctime()}",
             style="bold bright_white on black",
             row_styles=["bold bright_white on black"],
             header_style="white on dark_blue",

pyegeria/commands/tech/list_relationship_types.py

@@ -14,6 +14,7 @@ import time
 from rich import box
 from rich import print
 from rich.console import Console
+from rich.markdown import Markdown
 from rich.prompt import Prompt
 from rich.table import Table
 
@@ -69,16 +70,11 @@ def display_relationship_types(
             expand=True,
         )
 
-        table.add_column("Status")
         table.add_column("Name")
-        # table.add_column("GUID", no_wrap=True,)
-
+        table.add_column("Status")
         table.add_column("Description")
-        table.add_column("Attrib Name")
-        table.add_column("Attrib Status")
-        table.add_column("Attrib Type")
-        table.add_column("Attrib Description")
         table.add_column("Description Wiki", no_wrap=True)
+        table.add_column("Attributes", min_width=50)
 
         types_list = p_client.get_valid_relationship_types(type_name)
 
@@ -99,27 +95,27 @@ def display_relationship_types(
                 description = types["description"]
                 description_wiki = types.get("descriptionWiki", " ")
                 attribute_defs = types.get("attributeDefinitions")
+
+                att_table = Table(show_lines=True)
+                att_table.add_column("Name")
+                att_table.add_column("Description")
+                att_table.add_column("Status")
+                att_table.add_column("Type")
+
                 if attribute_defs:
+                    att_md = True
                     for attr in attribute_defs:
                         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,
-                        )
+                        att_table.add_row(attr_name, attr_desc, attr_status, attr_type)
+
                 else:
-                    table.add_row(
-                        status, name, description, description_wiki, " ", " ", " ", " "
-                    )
+                    att_md = False
+            att_out = att_table if att_md else " "
 
+            table.add_row(name, status, description, description_wiki, att_out)
         p_client.close_session()
         return table
 
@@ -157,7 +153,9 @@ def main():
     userid = args.userid if args.userid is not None else EGERIA_USER
     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
-    type_name = Prompt.ask("Enter the Type Name to retrieve:", default="AssetOwner")
+    type_name = Prompt.ask(
+        "Enter the OM Type Name to retrieve relationships for:", default="AssetOwner"
+    )
 
     display_relationship_types(type_name, server, url, userid, user_pass, save_output)
 

pyegeria/commands/tech/list_relationships.py

@@ -16,6 +16,7 @@ import time
 from rich import box
 from rich.console import Console
 from rich.markdown import Markdown
+from rich.prompt import Prompt
 from rich.table import Table
 
 from pyegeria import (
@@ -23,6 +24,7 @@ from pyegeria import (
     PropertyServerException,
     UserNotAuthorizedException,
     ClassificationManager,
+    max_paging_size,
 )
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -87,7 +89,7 @@ def list_relationships(
         table.add_column("Properties", min_width=40)
 
         rel_list = g_client.get_relationships(
-            search_string, page_size=100, time_out=time_out
+            search_string, page_size=max_paging_size, time_out=time_out
         )
         if type(rel_list) is str:
             return table
@@ -164,8 +166,10 @@ def main():
     user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
     time_out = args.time_out if args.time_out is not None else 60
     try:
-        # search_string = Prompt.ask("Enter an asset search string:", default="*")
-        search_string = "Certification"
+        search_string = Prompt.ask(
+            "Enter an asset search string:", default="Certification"
+        )
+
         list_relationships(search_string, server, url, userid, user_pass, time_out)
     except KeyboardInterrupt:
         pass

pyegeria/create_tech_guid_lists.py

@@ -82,10 +82,10 @@ def build_global_guid_lists(
                     )
             #
             #   Ok - now lets harvest integration connectors using get_integration_daemon_status from ServerOps
-            #   Assume that integration daemon called integration-daemon
+            #   Assume that integration daemon called integration_daemon
             #
             s_client = ServerOps(
-                "integration-daemon", url, user_id=user_id, user_pwd=user_pwd
+                "integration_daemon", url, user_id=user_id, user_pwd=user_pwd
             )
             integ_status = s_client.get_integration_daemon_status()
 

pyegeria/glossary_manager_omvs.py

@@ -2470,7 +2470,70 @@ class GlossaryManager(GlossaryBrowser):
             )
         )
 
-        return
+    async def _async_undo_term_update(self, glossary_term_guid: str) -> None:
+        """Undo an update to a glossary term
+
+            Async Version.
+
+        Parameters
+        ----------
+            glossary_term_guid: str
+                Unique identifier for the source glossary term.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+         InvalidParameterException
+             If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
+         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.
+        Notes
+        -----
+        This creates a new version with the state of the term before the last update.
+
+        """
+
+        validate_guid(glossary_term_guid)
+
+        url = (
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-manager/glossaries/terms/"
+            f"{glossary_term_guid}/undo"
+        )
+
+        await self._async_make_request("POST", url)
+
+    def undo_term_update(self, glossary_term_guid: str) -> None:
+        """Undo an update to a glossary term
+
+        Parameters
+        ----------
+            glossary_term_guid: str
+                Unique identifier for the source glossary term.
+
+        Returns
+        -------
+        None
+
+        Raises
+        ------
+         InvalidParameterException
+             If the client passes incorrect parameters on the request - such as bad URLs or invalid values.
+         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.
+        Notes
+        -----
+        This creates a new version with the state of the term before the last update.
+
+        """
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(self._async_undo_term_update(glossary_term_guid))
 
     async def _async_get_terms_for_category(
         self,