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

commands/cli/egeria_tech.py

@@ -53,7 +53,7 @@ from commands.tech.list_solution_components import solution_component_list
 from commands.tech.list_solution_roles import solution_role_list
 from commands.tech.list_tech_templates import display_templates_spec
 from commands.tech.list_valid_metadata_values import display_metadata_values
-from commands.tech.generic_actions import delete_element
+from commands.tech.element_actions import delete_element
 
 @tui()
 @click.version_option("0.0.1", prog_name="egeria_ops")
@@ -360,17 +360,8 @@ def show_elements_by_classification_by_prop(
     """Show elements by classification and property value"""
     c = ctx.obj
     if extended:
-        find_elements_by_prop_value_x(
-            om_type,
-            property_value,
-            [property_names],
-            c.view_server,
-            c.view_server_url,
-            c.userid,
-            c.password,
-            c.jupyter,
-            c.width,
-        )
+        find_elements_by_prop_value_x(om_type, property_value, [property_names], c.view_server, c.view_server_url,
+                                      c.userid, c.password, c.jupyter, c.width)
     else:
         find_elements_by_prop_value(
             om_type,
@@ -404,17 +395,8 @@ def show_elements_by_classification_by_prop(
 def show_related_elements(ctx, element_guid, om_type, rel_type):
     """Show all elements related to specified guid"""
     c = ctx.obj
-    list_related_elements(
-        element_guid,
-        om_type,
-        rel_type,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    list_related_elements(element_guid, om_type, rel_type, c.view_server, c.view_server_url, c.userid, c.password,
+                          c.jupyter, c.width)
 
 
 @show_elements.command("related-elements_by_prop")
@@ -491,9 +473,7 @@ def show_tech_types(ctx, search_string):
     """
 
     c = ctx.obj
-    display_tech_types(
-        search_string, c.view_server, c.view_server_url, c.userid, c.password
-    )
+    display_tech_types(search_string, c.view_server, c.view_server_url, c.userid, c.password)
 
 
 @show_tech.command("tech-details")
@@ -507,15 +487,7 @@ def show_tech_details(ctx, tech_name):
            tech-name is a valid technology name (see 'show tech-types')
     """
     c = ctx.obj
-    tech_details_viewer(
-        tech_name,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    tech_details_viewer(tech_name, c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width)
 
 
 @show_tech.command("tech-type-templates")
@@ -552,7 +524,7 @@ def show_asset_types(ctx):
 @show_info.command("registered-services")
 @click.option(
     "--services",
-    type=click.Choice(
+    type_name = click.Choice(
         [
             "all",
             "access-services",
@@ -571,15 +543,7 @@ def show_asset_types(ctx):
 def show_registered_services(ctx, services):
     """Show information about a registered services"""
     c = ctx.obj
-    display_registered_svcs(
-        services,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    display_registered_svcs(services, c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width)
 
 
 @show_info.command("relationship-types")
@@ -592,16 +556,8 @@ def show_registered_services(ctx, services):
 def show_relationship_types(ctx, rel_type):
     """Show information about the specified relationship type"""
     c = ctx.obj
-    display_relationship_types(
-        rel_type,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        False,
-        c.jupyter,
-        c.width,
-    )
+    display_relationship_types(rel_type, c.view_server, c.view_server_url, c.userid, c.password, False, c.jupyter,
+                               c.width)
 
 
 @show_tech.command("tech-templates")
@@ -701,15 +657,7 @@ def list_element_info(ctx):
 def get_element_info(ctx, om_type):
     """Display graph of elements for an Open Metadata Type"""
     c = ctx.obj
-    display_elements(
-        om_type,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    display_elements(om_type, c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width)
 
 
 @show_elements.command("elements")
@@ -752,15 +700,7 @@ def list_all_om_type_elements(ctx, om_type, extended):
 def list_supply_chains(ctx, search_string):
     """Display supply chains"""
     c = ctx.obj
-    supply_chain_viewer(
-        search_string,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    supply_chain_viewer(search_string, c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width)
 
 
 @show_supply_chains.command("blueprints")
@@ -769,22 +709,14 @@ def list_supply_chains(ctx, search_string):
 def list_blueprints(ctx, search_string):
     """Display solution blueprints"""
     c = ctx.obj
-    blueprint_list(
-        search_string,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    blueprint_list(search_string, c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width)
 
 
-@show_supply_chains.command("solution-roles")
+@show_supply_chains.command("solution-perspectives")
 @click.option("--search-string", default="*", help="Search string")
 @click.pass_context
 def list_solution_roles(ctx, search_string):
-    """Display solution roles"""
+    """Display solution perspectives"""
     c = ctx.obj
     solution_role_list(
         search_string,
@@ -803,15 +735,7 @@ def list_solution_roles(ctx, search_string):
 def list_solution_components(ctx, search_string):
     """Display solution componentss"""
     c = ctx.obj
-    solution_component_list(
-        search_string,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
+    solution_component_list(search_string, c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width)
 
 
 #

commands/cli/ops_config.py

@@ -12,14 +12,12 @@ class Config(object):
         integration_daemon_url: str,
         engine_host: str,
         engine_host_url: str,
-        admin_user: str,
-        admin_user_password: str,
         userid: str,
         password: str,
         timeout: int,
         jupyter: bool,
         width: int,
-        home_glossary_guid: str,
+        home_glossary_name: str,
         glossary_path: str,
         root_path: str,
         inbox_path: str,
@@ -33,8 +31,7 @@ class Config(object):
         self.integration_daemon_url = integration_daemon_url
         self.engine_host = engine_host
         self.engine_host_url = engine_host_url
-        self.admin_user = admin_user
-        self.admin_user_password = admin_user_password
+
         self.userid = userid
         self.password = password
         self.timeout = timeout
@@ -42,7 +39,7 @@ class Config(object):
         self.width = width
         self.server = server
         self.url = url
-        self.home_glossary_guid = home_glossary_guid
+        self.home_glossary_name = home_glossary_name
         self.glossary_path = glossary_path
         self.root_path = root_path
         self.inbox_path = inbox_path

commands/{cat/list_categories.py → deprecated/list_data_designer.py}

@@ -1,3 +1,4 @@
+
 #!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
@@ -13,18 +14,19 @@ import os
 import sys
 import time
 
-from rich import box
+from rich import box, print
 from rich.console import Console
 from rich.prompt import Prompt
 from rich.table import Table
 from rich.text import Text
+from rich.console import Console
+from rich.markdown import Markdown
+
 
 from pyegeria import (
     EgeriaTech,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response,
+PyegeriaAPIException, PyegeriaClientException, print_basic_exception, print_exception_table
+    NO_ELEMENTS_FOUND
 )
 
 disable_ssl_warnings = True
@@ -48,9 +50,11 @@ EGERIA_ROOT_PATH = os.environ.get("EGERIA_ROOT_PATH", "../../")
 EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "md_processing/dr_egeria_inbox")
 EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "md_processing/dr_egeria_outbox")
 
+console = Console(width=EGERIA_WIDTH)
 
 
-def display_categories(
+def display_data_obj(
+    object_type: str,
     search_string: str = "*",
     view_server: str = EGERIA_VIEW_SERVER,
     view_url: str = EGERIA_VIEW_SERVER_URL,
@@ -63,6 +67,8 @@ def display_categories(
     """Display either a specified category or all categories if the search_string is '*'.
     Parameters
     ----------
+    object_type: str
+        The type of object to display,
     search_string : str, default is '*'
         The string used to search for categories.
     view_server : str
@@ -83,76 +89,48 @@ def display_categories(
     m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
     token = m_client.create_egeria_bearer_token()
 
+    match object_type:
+        case "Data Structures":
+            find_proc = m_client.find_data_structures
+        case "Data Fields":
+            find_proc = m_client.find_data_fields
+        case "Data Classes":
+            find_proc = m_client.find_data_classes
+        case _: #catch invalid patterns
+            print(f"Invalid object type: {object_type}")
+            return
 
     try:
+        if not callable(find_proc):
+            raise TypeError(f"find_proc is not callable for object type '{object_type}'")
+
         if output_format == "FORM":
             action = "Update-Form"
         elif output_format == "REPORT":
             action = "Report"
         if output_format != "TABLE":
             file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_OUTBOX_PATH)
-            file_name = f"Categories-{time.strftime('%Y-%m-%d-%H-%M-%S')}-{action}.md"
+            file_name = f"{object_type}-{time.strftime('%Y-%m-%d-%H-%M-%S')}-{action}.md"
             full_file_path = os.path.join(file_path, file_name)
             os.makedirs(os.path.dirname(full_file_path), exist_ok=True)
-            output = m_client.find_glossary_categories(search_string, output_format=output_format)
-            if output == "NO_CATEGORIES_FOUND":
-                print(f"\n==> No categories found for search string '{search_string}'")
+            output = find_proc(search_string, output_format=output_format)
+            if output == NO_ELEMENTS_FOUND:
+                print(f"\n==> No elements found for search string '{search_string}'")
                 return
             with open(full_file_path, 'w') as f:
                 f.write(output)
-            print(f"\n==> Categories output written to {full_file_path}")
+            print(f"\n==> Elements output written to {full_file_path}")
+            return
+        else:
+            output =find_proc(search_string, output_format="LIST")
+            if output == NO_ELEMENTS_FOUND:
+                print(f"\n==> No elements found for search string '{search_string}'")
+                return
+            console.print(Markdown(output))
             return
 
-        table = Table(
-            title=f"Category List @ {time.asctime()}",
-            style="bright_white on black",
-            header_style="bright_white on dark_blue",
-            title_style="bold white on black",
-            caption_style="white on black",
-            show_lines=True,
-            box=box.ROUNDED,
-            caption=f"View Server '{view_server}' @ Platform - {view_url}",
-            expand=True,
-        )
-        table.add_column("Category Name")
-        table.add_column(
-            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
-        )
-        table.add_column("Description")
-        table.add_column("In Glossary")
-        table.add_column("Parent Category")
-
-        categories = m_client.find_glossary_categories(search_string)
-        if type(categories) is list:
-            sorted_category_list = sorted(
-                categories, key=lambda k: k["glossaryCategoryProperties"]["displayName"]
-            )
-            for category in sorted_category_list:
-                display_name = category["glossaryCategoryProperties"].get("displayName",'---')
-                qualified_name = category["glossaryCategoryProperties"]["qualifiedName"]
-                category_guid = category["elementHeader"]["guid"]
-                q_name = Text(f"{qualified_name}\n&\n{category_guid}", justify="center")
-                description = category["glossaryCategoryProperties"].get("description",'---')
-                classification_props = category["elementHeader"]['classifications'][0].get('classificationProperties',None)
-                glossary_qualified_name = '---'
-                if classification_props is not None:
-                    glossary_guid = classification_props.get('anchorScopeGUID','---')
-                    glossary_qualified_name = (
-                        m_client.get_glossary_by_guid(glossary_guid))['glossaryProperties']['qualifiedName']
-                cat_info = m_client.get_category_parent(category_guid)
-                if type(cat_info) is dict:
-                    parent_qn = cat_info['glossaryCategoryProperties']['qualifiedName']
-                else:
-                    parent_qn = '---'
-
-
-                table.add_row(display_name, q_name, description, glossary_qualified_name, parent_qn)
-            console = Console(
-                style="bold bright_white on black",
-                width=width,
-                force_terminal=not jupyter,
-            )
-            console.print(table)
+
+
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
@@ -160,8 +138,18 @@ def display_categories(
         m_client.close_session()
 
 
-def main():
+def main_structs():
+    main(object_type = "Data Structures")
+
+def main_fields():
+    main(object_type = "Data Fields")
+
+def main_classes():
+    main(object_type = "Data Classes")
+
+def main(object_type: str="Data Fields"):
     parser = argparse.ArgumentParser()
+    parser.add_argument("--kind", choices=["Data Structures", "Data Fields", "Data Classes"])
     parser.add_argument("--server", help="Name of the server to display status for")
     parser.add_argument("--url", help="URL Platform to connect to")
     parser.add_argument("--userid", help="User Id")
@@ -173,15 +161,16 @@ def main():
     url = args.url if args.url is not None else EGERIA_PLATFORM_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
+    kind = args.kind if args.kind is not None else object_type
 
     try:
         search_string = Prompt.ask(
-            "Enter the category you are searching for or '*' for all:", default="*"
+            "Enter the element you are searching for or '*' for all:", default="*"
         )
         output_format = Prompt.ask("What output format do you want?", choices=["TABLE", "FORM", "REPORT"],
                                    default="TABLE")
 
-        display_categories(search_string, server, url, userid,
+        display_data_obj(kind, search_string, server, url, userid,
                            user_pass, output_format = output_format)
 
     except KeyboardInterrupt:

commands/{cat/list_data_structures.py → deprecated/list_data_structures_full.py}

@@ -19,10 +19,7 @@ from rich.text import Text
 
 from pyegeria import (
     EgeriaTech,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response, NO_ELEMENTS_FOUND,
+PyegeriaAPIException, PyegeriaClientException, print_basic_exception, print_exception_table NO_ELEMENTS_FOUND,
     )
 
 disable_ssl_warnings = True
@@ -89,7 +86,7 @@ def display_data_struct(
             action = "Dict"
         elif output_format == "MERMAID":
             action = "Mermaid"
-        filter = search_string.strip() if search_string != "*" else None
+        filter_string = search_string.strip() if search_string != "*" else None
 
         body = {
             "class": "FilterRequestBody",
@@ -100,7 +97,7 @@ def display_data_struct(
             "limitResultsByStatus": ["ACTIVE"],
             "sequencingOrder": "PROPERTY_ASCENDING",
             "sequencingProperty": "qualifiedName",
-            "filter": filter
+            "filter": filter_string
             }
 
         if output_format != "TABLE":