pyegeria 5.4.0.28__py3-none-any.whl → 5.5.3.3__py3-none-any.whl

commands/cat/get_asset_graph.py

@@ -3,293 +3,60 @@
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-Display the status of cataloged platforms and servers.
+Display Asset Graph Information using generic functions.
 """
+from __future__ import annotations
 import argparse
 import os
-import sys
 
-from rich import print
 from rich.console import Console
-from rich.markdown import Markdown
-from rich.panel import Panel
 from rich.prompt import Prompt
-from rich.tree import Tree
 
+from commands.cat.run_report import list_generic
+from pyegeria.core.config import settings
 from pyegeria import (
-    AssetCatalog,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
+    PyegeriaAPIException, PyegeriaClientException, print_basic_exception, print_exception_table, PyegeriaException
 )
 
-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("EGERIA_VIEW_SERVER", "view-server")
-EGERIA_VIEW_SERVER_URL = os.environ.get(
-    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
-)
-EGERIA_INTEGRATION_DAEMON = os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon")
-EGERIA_INTEGRATION_DAEMON_URL = os.environ.get(
-    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
-)
-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
+
+app_config = settings.Environment
 
 guid_list = []
 
-console = Console(width=EGERIA_WIDTH, force_terminal=(not EGERIA_JUPYTER))
+console = Console(width=app_config.console_width, force_terminal=(not app_config.egeria_jupyter))
 
 
 def asset_viewer(
-    asset_guid: str,
-    server_name: str,
-    platform_url: str,
-    user: str,
-    user_pass: str,
-    jupyter: bool = EGERIA_JUPYTER,
-    width: int = EGERIA_WIDTH,
+    output_format: str = "TABLE",
+    asset_guid: str = None,
+    view_server: str = app_config.egeria_view_server,
+    view_url: str = app_config.egeria_view_server_url,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = app_config.egeria_jupyter,
+    width: int = app_config.console_width,
+    prompt_missing: bool = False,
+    write_file: bool = False,
+    render_table: bool = False,
+    table_caption: str | None = None,
+    use_pager: bool = True,
 ):
-    def build_classifications(classification: dict) -> Markdown:
-        class_md = ""
-        for c in classification:
-            c_type = c["classificationName"]
-            if c_type == "Anchors":
-                continue
-            class_md += f"\n* Classification: {c_type}\n"
-            class_props = c.get("classificationProperties", "---")
-            if type(class_props) is dict:
-                for prop in class_props.keys():
-                    class_md += f"\t* {prop}: {class_props[prop]}\n"
-        if class_md == "":
-            output = None
-        else:
-            output = class_md
-        return output
-
-    def build_nested_elements(nested_element: dict) -> Markdown:
-        ne_md = " "
-        ne_header = nested_element["elementHeader"]
-        ne_created_by = ne_header["versions"]["createdBy"]
-        ne_created_at = ne_header["versions"]["createTime"]
-        ne_guid = ne_header["guid"]
-        guid_list.append(ne_guid)
-
-        ne_type = ne_header["type"]["typeName"]
-        ne_classifications = ne_header["classifications"]
-        ne_class_md = build_classifications(ne_classifications)
-        # ne_class_md = " " if ne_class_md is None else ne_class_md
-        ne_props = nested_element.get("properties", "---")
-        ne_prop_md = "\n"
-        if type(ne_props) is dict:
-            for prop in ne_props.keys():
-                ne_prop_md += f"\t* {prop}: {ne_props[prop]}\n"
-        ne_md = (
-            f"Nested Element of Type: {ne_type} with GUID:  {ne_guid} \n "
-            f"* created by {ne_created_by} at time {ne_created_at}\n"
-            f"\n* Properties:\n{ne_prop_md}\n"
-        )
-
-        if ne_class_md is not None:
-            ne_md += f"* {ne_class_md}"
-
-        output = Markdown(ne_md)
-        return output
-
     try:
-        a_client = AssetCatalog(server_name, platform_url, user_id=user)
-
-        token = a_client.create_egeria_bearer_token(user, user_pass)
-        # asset_info = a_client.find_assets_in_domain(asset_name)
-        # if type(asset_info) is str:
-        #     print("\n No Assets Found - Exiting\n")
-        #     sys.exit(1)
-        #
-        # asset_guid = asset_info[0]['guid']
-
-        guid_list.append(asset_guid)
-
-        asset_graph = a_client.get_asset_graph(asset_guid)
-        if type(asset_graph) is not dict:
-            print(f"\n No Asset found for {asset_guid}")
-            sys.exit(1)
-
-        # print(f"\n{json.dumps(asset_graph, indent =2)}\n")
-
-        asset_display_name = asset_graph["properties"].get("displayName", "---")
-        asset_display_description = asset_graph["properties"].get(
-            "displayDescription", "---"
-        )
-        asset_name = asset_graph["properties"].get("name", "---")
-        asset_resource_name = asset_graph["properties"].get("resourceName", "---")
-        asset_resource_description = asset_graph["properties"].get(
-            "resourceDescription", "---"
-        )
-        qualified_name = asset_graph["properties"].get("qualifiedName", "---")
-
-        tree = Tree(
-            f"{asset_name} ({asset_guid})",
-            style="bold bright_white on black",
-            guide_style="bold bright_blue",
-        )
-        style = ""
-        asset_elements = asset_graph["elementHeader"]
-        asset_type = asset_elements["type"]["typeName"]
-        asset_deployed_imp_type = asset_graph["properties"].get(
-            "deployedImplementationType", "---"
-        )
-
-        asset_origin = asset_elements["origin"]["homeMetadataCollectionName"]
-        asset_creation = asset_elements["versions"]["createTime"]
-        asset_created_by = asset_elements["versions"]["createdBy"]
-        asset_classifications = asset_elements["classifications"]
-        asset_nested_elements = asset_graph.get("anchoredElements", "----")
-        asset_relationships = asset_graph["relationships"]
-        asset_class_md = build_classifications(asset_classifications)
+        list_generic(report_spec="Asset-Graph", output_format=output_format, view_server=view_server,
+                 view_url=view_url, user=user, user_pass=user_pass, params={"asset_guid": asset_guid},
+                 render_table=render_table, write_file = write_file, table_caption=table_caption, use_pager=use_pager,
+                     width=width, jupyter=jupyter, prompt_missing=prompt_missing)
 
-        additional_properties = asset_graph["properties"].get(
-            "additionalProperties", None
-        )
-        if additional_properties is not None:
-            add_prop_md = "\n* Additional Properties:\n"
-            for prop in additional_properties:
-                add_prop_md = (
-                    f"{add_prop_md}\n\t* {prop}: {additional_properties[prop]}\n"
-                )
-        else:
-            add_prop_md = ""
+    except PyegeriaAPIException as e:
+        if e.response_egeria_msg_id == "OMAG-REPOSITORY-HANDLER-404-001":
+            print(e.response_egeria_msg)
+            return
 
-        extended_properties = asset_graph["properties"].get("extendedProperties", None)
-        if extended_properties is not None:
-            prop_md = "\n* Extended Properties:\n"
-            for prop in extended_properties:
-                prop_md = f"{prop_md}\n\t* {prop}: {extended_properties[prop]}\n"
-        else:
-            prop_md = ""
-        core_md = (
-            f"**Type: {asset_type}  Created by: {asset_created_by} on {asset_creation}**\n"
-            f"* Deployed Implementation Type: {asset_deployed_imp_type}\n"
-            f"* Name: {asset_name}\n "
-            f"* Asset Resource Name: {asset_resource_name}\n"
-            f"* Asset Resource Description: {asset_resource_description}\n "
-            f"* Asset Display Name: {asset_display_name}\n"
-            f"* Asset Display Description: {asset_display_description}\n "
-            f"* Qualified Name: {qualified_name}\n "
-            f"* Asset Origin: {asset_origin}\n"
-            f" {prop_md}\n"
-            f" {add_prop_md}\n"
-        )
-        core_md = Markdown(core_md)
-
-        p1 = Panel.fit(core_md, style="bold bright_white")
-        l2 = tree.add(p1)
-        if asset_class_md is not None:
-            p2 = Panel.fit(
-                Markdown(asset_class_md),
-                style="bold bright_white",
-                title="Classifications",
-            )
-            l2 = tree.add(p2)
-
-        #
-        # Nested Assets
-        #
-        if type(asset_nested_elements) is list:
-            l2 = tree.add("Nested Elements", style="bold white")
-            for el in asset_nested_elements:
-                asset_ne_md = build_nested_elements(el)
-                p3 = Panel.fit(
-                    asset_ne_md, style="bold bright_white", title="Nested Elements"
-                )
-                l2.add(p3)
-
-        #
-        # Now work on the Relationships
-        #
-        for relationship in asset_relationships:
-            # Find the end guids - if one isn't in our list then display
-            rel_end1 = relationship["end1"]
-            rel_end1_type = rel_end1["type"]["typeName"]
-            rel_end1_guid = rel_end1["guid"]
-            rel_end1_unique_name = rel_end1.get("uniqueName", "---")
-
-            rel_end2 = relationship["end2"]
-            rel_end2_type = rel_end2["type"]["typeName"]
-            rel_end2_guid = rel_end2["guid"]
-            rel_end2_unique_name = rel_end2.get("uniqueName", "---")
-
-            if (rel_end1_guid not in guid_list) or (rel_end2_guid not in guid_list):
-                # rel_end1_class_md = build_classifications(rel_end1["classifications"])
-                # rel_end2_class_md = build_classifications(rel_end2["classifications"])
-
-                relationship_guid = relationship["guid"]
-                relationship_type = relationship["type"]["typeName"]
-                relationship_created_by = relationship["versions"]["createdBy"]
-                relationship_creation_time = relationship["versions"]["createTime"]
-                relationship_properties = relationship.get("properties", "--- ")
-                relationship_md = (
-                    f"Relationship Type {relationship_type}\n"
-                    f"* GUID: {relationship_guid}\n* Created by: {relationship_created_by} \n"
-                    f"* Creation Time: {relationship_creation_time}\n"
-                    f"* Properties: {relationship_properties}\n"
-                )
-
-                rel_md = (
-                    f"* Relationship Type: {relationship_type}\n"
-                    f"* Relationship GUID: {relationship_guid}\n"
-                    f"* Created by: {relationship_created_by} at time {relationship_creation_time}\n"
-                )
-                rel_end1_md = (
-                    f"* End1:\n"
-                    f"\t* Type: {rel_end1_type}\n"
-                    f"\t* GUID: {rel_end1_guid}\n"
-                    f"\t* Unique Name: {rel_end1_unique_name}\n"
-                )
-
-                # if rel_end1_class_md is not None:
-                #     rel_end1_md = rel_end1_class_md + rel_end1_md
-
-                rel_end2_md = (
-                    f"* End2:\n"
-                    f"\t* Type: {rel_end2_type}\n"
-                    f"\t* GUID: {rel_end2_guid}\n"
-                    f"\t* Unique Name: {rel_end2_unique_name}\n"
-                )
-
-                # if rel_end2_class_md is not None:
-                #     rel_end1_md = rel_end2_class_md + rel_end1_md
-                #
-                # for prop in relationship_properties.keys():
-                #     relationship_md += f"* {prop}: {relationship_properties[prop]}\n"
-
-                relationship_md += rel_end1_md + rel_end2_md
-
-                relationship_panel = Panel.fit(
-                    Markdown(relationship_md),
-                    style="bold bright_white",
-                    title="Asset Relationships",
-                )
-                tree.add(relationship_panel)
-        with console.screen():
-            print("\n\n")
-        print(tree)
-
-    except (
-        InvalidParameterException,
-        PropertyServerException,
-        UserNotAuthorizedException,
-    ) as e:
-        console.print_exception()
-        console.print(
-            "\n\n ======> Most likely the GUID you provided is either incorrect or not an asset\n[red bold]"
-        )
+    except (PyegeriaException, PyegeriaClientException) as e:
+        print_basic_exception(e)
 
 
 def main():
@@ -301,13 +68,16 @@ def main():
     parser.add_argument("--password", help="User Password")
     args = parser.parse_args()
 
-    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
-    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    server = args.server if args.server is not None else app_config.egeria_view_server
+    url = args.url if args.url is not None else app_config.egeria_view_server_url
     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
     try:
         asset_guid = Prompt.ask("Enter the Asset GUID to view:", default="")
-        asset_viewer(asset_guid, server, url, userid, user_pass)
+        output_format = Prompt.ask("Enter the output format:", default="TABLE")
+        asset_viewer(output_format, asset_guid, server, url, userid,
+                     user_pass, prompt_missing=True, write_file=True, render_table=True,
+                     table_caption="Asset Graph")
     except KeyboardInterrupt as e:
         # console.print_exception()
         pass

commands/cat/{get_collection.py → get_collection_tree.py}

@@ -18,11 +18,9 @@ from rich.tree import Tree
 
 from pyegeria import (
     CollectionManager,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException, NO_ELEMENTS_FOUND,
-    )
-from pyegeria._exceptions import print_exception_response
+    NO_ELEMENTS_FOUND,
+    PyegeriaAPIException, PyegeriaClientException, print_basic_exception, print_exception_table
+)
 
 disable_ssl_warnings = True
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -74,9 +72,9 @@ def collection_viewer(
                 )
                 text_guid = Text(f"* GUID: {member['guid']}", "green")
                 text_collection_type = Text(
-                    f"* Collection Type: {member['collectionType']}"
+                    f"* Collection Type: {member.get('typeName','')}"
                 )
-                text_description = Text(f"* Description: {member['description']}")
+                text_description = Text(f"* Description: {member.get('description','')}")
                 p = Panel.fit(
                     f"{text_collection_name}[green]\n{text_qualified_name}\n{text_guid}\n"
                     f"{text_collection_type}\n{text_description}"
@@ -94,9 +92,7 @@ def collection_viewer(
                     )
                     walk_collection_hierarchy(branch, collection_client, member["guid"])
         else:
-            tt = tree.add(
-                f"[bold magenta on black]No collections found in {root_collection_name}"
-            )
+            tt = tree.add("[bold magenta on black]No Members found")
 
     try:
         tree = Tree(f"[bold bright green]{root}", guide_style="bold bright_blue")
@@ -106,15 +102,11 @@ def collection_viewer(
         walk_collection_hierarchy(tree, c_client, None, root)
         print(tree)
 
-    except (
-        InvalidParameterException,
-        PropertyServerException,
-        UserNotAuthorizedException,
-    ) as e:
-        if e.exception_error_message_parameters[1] == NO_ELEMENTS_FOUND:
+    except (PyegeriaAPIException, PyegeriaClientException) as e:
+        if hasattr(e, 'exception_error_message_parameters') and len(e.exception_error_message_parameters) > 1 and e.exception_error_message_parameters[1] == NO_ELEMENTS_FOUND:
             print("The collection was not found.")
         else:
-            print_exception_response(e)
+            print_basic_exception(e)
     finally:
         c_client.close_session()
 
@@ -136,7 +128,7 @@ def main():
     try:
         root_collection = Prompt.ask(
             "Enter the Root Collection to start from:",
-            default="Digital Products Root",
+            default="GeoSpatial-Root",
         )
         collection_viewer(root_collection, server, url, userid, user_pass)
     except KeyboardInterrupt:

commands/cat/get_project_dependencies.py

@@ -10,6 +10,7 @@ A simple viewer for project dependencies - provide the root and we display the d
 import argparse
 import os
 
+from pydantic import ValidationError
 from rich import print
 from rich.console import Console
 from rich.markdown import Markdown
@@ -18,12 +19,11 @@ from rich.prompt import Prompt
 from rich.tree import Tree
 
 from pyegeria import (
-    InvalidParameterException,
     ProjectManager,
-    PropertyServerException,
-    UserNotAuthorizedException,
+    PyegeriaAPIException, PyegeriaClientException,
+    print_basic_exception,
+    print_validation_error,
 )
-from pyegeria._exceptions import print_exception_response
 
 disable_ssl_warnings = True
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -72,7 +72,7 @@ def project_dependency_viewer(
             proj_type = proj_props.get("typeName", "---")
             proj_unique = proj_props.get("qualifiedName", "---")
             proj_identifier = proj_props.get("identifier", "---")
-            proj_name = proj_props.get("name", "---")
+            proj_name = proj_props.get("displayName", "---")
             proj_desc = proj_props.get("description", "---")
             proj_status = proj_props.get("projectStatus", "---")
             proj_priority = proj_props.get("priority", "---")
@@ -90,12 +90,12 @@ def project_dependency_viewer(
         else:
             return
 
-        team = project_client.get_project_team(proj_guid)
+        team = project_client.get_project_team(proj_guid,"")
         member_md = ""
         if type(team) is list:
             for member in team:
-                member_guid = member["member"]["guid"]
-                member_unique = member["member"]["uniqueName"]
+                member_guid = member["elementHeader"]["guid"]
+                member_unique = member["properties"]["qualifiedName"]
                 member_md += f"* Member Unique Name: {member_unique}\n* Member GUID: {member_guid}"
             proj_props_md += f"\n### Team Members\n {member_md}"
 
@@ -131,12 +131,12 @@ def project_dependency_viewer(
         walk_project_hierarchy(p_client, root, tree, root=True)
         print(tree)
 
-    except (
-        InvalidParameterException,
-        PropertyServerException,
-        UserNotAuthorizedException,
-    ) as e:
-        print_exception_response(e)
+    except (PyegeriaAPIException, PyegeriaClientException) as e:
+        print_basic_exception(e)
+    except ValidationError as e:
+        print_validation_error(e)
+    except Exception as e:
+        print_basic_exception(e)
 
 
 def main():

commands/cat/get_project_structure.py

@@ -10,6 +10,7 @@ A simple viewer for project structure - provide the root and we display the hier
 import argparse
 import os
 
+from pydantic import ValidationError
 from rich import print
 from rich.console import Console
 from rich.markdown import Markdown
@@ -18,12 +19,9 @@ from rich.prompt import Prompt
 from rich.tree import Tree
 
 from pyegeria import (
-    InvalidParameterException,
     ProjectManager,
-    PropertyServerException,
-    UserNotAuthorizedException,
+    PyegeriaAPIException, PyegeriaClientException, print_basic_exception, print_exception_table, print_validation_error
 )
-from pyegeria._exceptions import print_exception_response
 
 disable_ssl_warnings = True
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
@@ -72,7 +70,7 @@ def project_structure_viewer(
             proj_type = proj_props.get("typeName", "---")
             proj_unique = proj_props.get("qualifiedName", "---")
             proj_identifier = proj_props.get("identifier", "---")
-            proj_name = proj_props.get("name", "---")
+            proj_name = proj_props.get("displayName", "---")
             proj_desc = proj_props.get("description", "---")
             proj_status = proj_props.get("projectStatus", "---")
             proj_priority = proj_props.get("priority", "---")
@@ -90,12 +88,12 @@ def project_structure_viewer(
         else:
             return
 
-        team = project_client.get_project_team(proj_guid)
+        team = project_client.get_project_team(proj_guid,"")
         member_md = ""
         if type(team) is list:
             for member in team:
-                member_guid = member["member"]["guid"]
-                member_unique = member["member"]["uniqueName"]
+                member_guid = member["elementHeader"]["guid"]
+                member_unique = member["properties"]["qualifiedName"]
                 member_md += f"* Member Unique Name: {member_unique}\n* Member GUID: {member_guid}"
             proj_props_md += f"\n### Team Members\n {member_md}"
 
@@ -131,12 +129,15 @@ def project_structure_viewer(
         walk_project_hierarchy(p_client, root, tree, root=True)
         print(tree)
 
-    except (
-        InvalidParameterException,
-        PropertyServerException,
-        UserNotAuthorizedException,
-    ) as e:
-        print_exception_response(e)
+    except (PyegeriaAPIException, PyegeriaClientException) as e:
+        print_basic_exception(e)
+
+    except ValidationError as e:
+        print_validation_error(e)
+
+    except Exception as e:
+        console.print_exception()
+
 
 
 def main():