pyegeria 5.3.2__py3-none-any.whl → 5.3.3__py3-none-any.whl

pyegeria/commands/cli/egeria_tech.py

@@ -20,45 +20,29 @@ from pyegeria.commands.cli.ops_config import Config
 from pyegeria.commands.tech.get_guid_info import display_guid
 from pyegeria.commands.tech.get_tech_details import tech_details_viewer
 from pyegeria.commands.tech.list_asset_types import display_asset_types
-from pyegeria.commands.tech.list_elements_x import list_elements_x
 from pyegeria.commands.tech.list_registered_services import display_registered_svcs
 from pyegeria.commands.tech.list_relationship_types import display_relationship_types
 from pyegeria.commands.tech.list_tech_templates import display_templates_spec
 from pyegeria.commands.tech.list_valid_metadata_values import display_metadata_values
-from pyegeria.commands.tech.get_tech_type_template import template_viewer
 from pyegeria.commands.tech.list_anchored_elements import display_anchored_elements
-from pyegeria.commands.tech.list_elements import list_elements
+from pyegeria.commands.tech.list_all_om_type_elements import list_elements
+from pyegeria.commands.tech.list_all_om_type_elements_x import list_elements_x
+from pyegeria.commands.tech.list_elements_by_classification_by_property_value import find_elements_by_classification_by_prop_value
+from pyegeria.commands.tech.list_elements_by_property_value import find_elements_by_prop_value
+from pyegeria.commands.tech.list_elements_by_property_value_x import find_elements_by_prop_value_x
+from pyegeria.commands.tech.list_related_elements_with_prop_value import list_related_elements_with_prop_value
 
 from pyegeria.commands.tech.get_element_info import display_elements
 from pyegeria.commands.tech.list_related_specification import (
     display_related_specification,
 )
-from pyegeria.commands.tech.list_related_elements import list_related_elements
+from pyegeria.commands.tech.list_all_related_elements import list_related_elements
 from pyegeria.commands.tech.list_elements_for_classification import (
     list_classified_elements,
 )
 from pyegeria.commands.tech.list_gov_action_processes import display_gov_processes
 from pyegeria.commands.tech.get_tech_type_template import template_viewer
 
-# from pyegeria import ServerOps
-
-
-# class Config(object):
-#     def __init__(self, server: str = None, url: str = None, userid:str = None, password:str = None,
-#                  timeout:int = 30, paging: bool = False):
-#         self.server = server
-#         self.url = url
-#         self.userid = userid
-#         self.password = password
-#         self.timeout = timeout
-#         self.paging = paging
-#
-#
-# pass_config = click.make_pass_decorator(Config)
-
-
-# @tui
-# @tui('menu', 'menu', 'A textual command line interface')
 @tui()
 @click.version_option("0.0.1", prog_name="egeria_ops")
 @click.group()
@@ -229,39 +213,21 @@ def show_guid_info(ctx, guid):
     display_guid(guid, c.server, c.url, c.userid, c.password, c.jupyter, c.width)
 
 
-@show_elements.command("related-specifications")
-@click.pass_context
-@click.argument("element-guid")
-def show_related_specifications(ctx, element_guid):
-    """List specifications related to the given Element"""
-    c = ctx.obj
-    display_related_specification(
-        element_guid,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
-
-
-@show_elements.command("anchored-elements")
+@show_elements.command("anchored_elements")
 @click.pass_context
 @click.option(
-    "--search-string",
-    default="SoftwareCapability",
+    "--property_value",
+    default="DeployedDatabaseSchema",
     help="value we are searching for",
 )
 @click.option(
     "--prop-list",
-    default="anchorDomainName",
+    default="anchorTypeName",
     help="List of properties we are searching",
 )
 def list_anchored_elements(ctx, search_string: str, prop_list: str):
-    """List elements with the specified properties"""
+    """List anchored elements with the specified properties"""
     c = ctx.obj
-    # put guards around this to make it a list?
     if type(prop_list) is str:
         property_names = prop_list.split(",")
     elif type(prop_list) is list:
@@ -270,10 +236,9 @@ def list_anchored_elements(ctx, search_string: str, prop_list: str):
         property_names = []
         print(f"\nError --> Invalid property list - must be a string or list")
         sys.exit(4)
-
     display_anchored_elements(
         search_string,
-        property_names,
+        [prop_list],
         c.view_server,
         c.view_server_url,
         c.userid,
@@ -283,6 +248,208 @@ def list_anchored_elements(ctx, search_string: str, prop_list: str):
         c.width,
     )
 
+@show_elements.command("elements-by-classification")
+@click.option(
+    "--om-type",
+    default="Project",
+    help="Open Metadata type to filter by",
+)
+@click.option(
+    "--classification",
+    default="GovernanceProject",
+    help="Classification to filter byt",
+)
+@click.pass_context
+def show_elements_by_classification(ctx, om_type, classification):
+    """Show elements by classification"""
+    c = ctx.obj
+    list_classified_elements(
+        om_type,
+        classification,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+@show_elements.command("elements-by-classification-by-prop-value")
+@click.option(
+    "--classification",
+    default="GovernanceProject",
+    help="Classification to filter by",
+    )
+@click.option(
+    "--property_value",
+    help="Property value to filter by",
+)
+@click.option(
+    "--property_names",
+    help="List of properties to search by",
+)
+@click.option(
+    "--om-type",
+    default="Project",
+    help="Open Metadata type to filter by",
+)
+@click.pass_context
+def show_elements_by_classification_by_prop(ctx,  classification, property_value, property_names, om_type):
+    """Show elements by classification and property value"""
+    c = ctx.obj
+    find_elements_by_classification_by_prop_value(
+        om_type,
+        classification,
+        property_value,
+        [property_names],
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+@show_elements.command("elements-by-prop-value")
+@click.option(
+    "--property_value",
+    help="Property value to filter by",
+)
+@click.option(
+    "--property_names",
+    help="List of properties to search by",
+)
+@click.option(
+    "--om-type",
+    default="Project",
+    help="Open Metadata type to filter by",
+)
+@click.option(
+    "--extended",
+    is_flag=True,
+    default=False,
+    help="If True, feedback information is displayed",
+)
+@click.pass_context
+def show_elements_by_classification_by_prop(ctx,property_value, property_names, om_type, extended):
+    """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,
+        )
+    else:
+        find_elements_by_prop_value(
+            om_type,
+            property_value,
+            [property_names],
+            c.view_server,
+            c.view_server_url,
+            c.userid,
+            c.password,
+            c.jupyter,
+            c.width,
+            )
+
+@show_elements.command("related-elements")
+@click.option(
+    "--element-guid",
+    help="GUID of the Element to navigate from.",
+)
+@click.option(
+    "--om-type",
+    default="Project",
+    help="Open metadata type to filter by.",
+)
+@click.option(
+    "--rel-type",
+    default="Certification",
+    help="Relationship type to follow.",
+)
+@click.pass_context
+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,
+    )
+
+
+@show_elements.command("related-elements_by_prop")
+@click.option(
+    "--element-guid",
+    help="GUID of the Element to navigate from.",
+)
+@click.option(
+    "--rel-type",
+    default="Certification",
+    help="Relationship type to follow.",
+)
+@click.option(
+    "--property_value",
+    help="Property value to filter by",
+)
+@click.option(
+    "--property_names",
+    help="List of properties to search by",
+)
+@click.option(
+    "--om-type",
+    default="Project",
+    help="Open metadata type to filter by.",
+)
+
+@click.pass_context
+def show_related_elements(ctx, element_guid, rel_type, property_value, property_names, om_type):
+    """Show elements related to specified guid and property value"""
+    c = ctx.obj
+    list_related_elements_with_prop_value(
+        element_guid,
+        rel_type,
+        property_value,
+        [property_names],
+        om_type,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_elements.command("related-specifications")
+@click.pass_context
+@click.argument("element-guid")
+def show_related_specifications(ctx, element_guid):
+    """List specifications related to the given Element"""
+    c = ctx.obj
+    display_related_specification(
+        element_guid,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
 
 @show_tech.command("tech-types")
 @click.option("--search-string", default="*", help="Tech type to search for")
@@ -410,63 +577,6 @@ def show_relationship_types(ctx, rel_type):
     )
 
 
-@show_elements.command("elements-by-classification")
-@click.option(
-    "--om-type",
-    default="Project",
-    help="Open Metadata type to filter by",
-)
-@click.option(
-    "--classification",
-    default="GovernanceProject",
-    help="Classification to filter byt",
-)
-@click.pass_context
-def show_elements_by_classification(ctx, om_type, classification):
-    """Show elements by classification"""
-    c = ctx.obj
-    list_classified_elements(
-        om_type,
-        classification,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
-
-
-@show_elements.command("related-elements")
-@click.option(
-    "--element-guid",
-    help="GUID of the Element to navigate from.",
-)
-@click.option(
-    "--om-type",
-    default="Project",
-    help="Open metadata type to filter by.",
-)
-@click.option(
-    "--rel-type",
-    default="Certification",
-    help="Relationship type to follow.",
-)
-@click.pass_context
-def show_related_elements(ctx, element_guid, om_type, rel_type):
-    """Show information about related elements"""
-    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,
-    )
 
 
 @show_tech.command("tech-templates")
@@ -544,44 +654,12 @@ def valid_metadata_values(ctx, property, type_name):
     )
 
 
-@show_elements.command("elements")
-@click.pass_context
-@click.option(
-    "--extended",
-    is_flag=True,
-    default=False,
-    help="If True, feedback information is displayed",
-)
-@click.option("--om_type", default="Organization", help="Metadata type to query")
-def list_element_info(ctx, om_type, extended):
-    """Display elements of a specific Open Metadata Type"""
-    c = ctx.obj
-    if extended:
-        list_elements_x(
-            om_type,
-            c.view_server,
-            c.view_server_url,
-            c.userid,
-            c.password,
-            c.jupyter,
-            c.width,
-        )
-    else:
-        list_elements(
-            om_type,
-            c.view_server,
-            c.view_server_url,
-            c.userid,
-            c.password,
-            c.jupyter,
-            c.width,
-        )
 
 
 @show_info.command("processes")
 @click.pass_context
 def list_element_info(ctx):
-    """Display the valid metadata values for a property and type"""
+    """Display processes"""
     c = ctx.obj
     list_elements(
         "GovernanceActionProcess",
@@ -598,7 +676,7 @@ def list_element_info(ctx):
 @click.pass_context
 @click.option("--om_type", default="Project", help="Metadata type to query")
 def get_element_info(ctx, om_type):
-    """Display the elements for an Open Metadata Type"""
+    """Display graph of elements for an Open Metadata Type"""
     c = ctx.obj
     display_elements(
         om_type,
@@ -610,6 +688,38 @@ def get_element_info(ctx, om_type):
         c.width,
     )
 
+@show_elements.command("elements")
+@click.pass_context
+@click.option(
+    "--extended",
+    is_flag=True,
+    default=False,
+    help="If True, feedback information is displayed",
+)
+@click.option("--om_type", default="Organization", help="Metadata type to query")
+def list_all_om_type_elements(ctx, om_type, extended):
+    """Display all elements of a specific Open Metadata Type"""
+    c = ctx.obj
+    if extended:
+        list_elements_x(
+            om_type,
+            c.view_server,
+            c.view_server_url,
+            c.userid,
+            c.password,
+            c.jupyter,
+            c.width
+        )
+    else:
+        list_elements(
+            om_type,
+            c.view_server,
+            c.view_server_url,
+            c.userid,
+            c.password,
+            c.jupyter,
+            c.width
+        )
 
 #
 #  Tell

pyegeria/commands/tech/{list_elements.py → list_all_om_type_elements.py}

@@ -1,4 +1,4 @@
-"""This creates a templates guid file from the core metadata archive"""
+"""This lists all elemeents of an oopen metadata type"""
 from rich.markdown import Markdown
 from rich.prompt import Prompt
 import os

pyegeria/commands/tech/{list_elements_x.py → list_all_om_type_elements_x.py}

@@ -1,4 +1,4 @@
-"""This creates a templates guid file from the core metadata archive"""
+"""List elements """
 from rich.markdown import Markdown
 from rich.prompt import Prompt
 import os

pyegeria/commands/tech/list_elements_by_classification_by_property_value.py

@@ -0,0 +1,186 @@
+"""This finds all elements of a classification that match the property value for the properties specified"""
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+import os
+import argparse
+import time
+import sys
+from rich import box
+from rich.console import Console
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+
+
+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("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("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 find_elements_by_classification_by_prop_value(
+        om_type: str,
+        classification: str,
+        property_value: str,
+        property_names: [str],
+        server: str,
+        url: str,
+        username: str,
+        password: str,
+        jupyter: bool = EGERIA_JUPYTER,
+        width: int = EGERIA_WIDTH,
+):
+    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    token = c_client.create_egeria_bearer_token()
+
+    om_typedef = c_client.get_typedef_by_name(om_type)
+    if type(om_typedef) is str:
+        print(
+            f"The type name '{om_type}' is not known to the Egeria platform at {url} - {server}"
+        )
+        sys.exit(0)
+
+    class_def = c_client.get_typedef_by_name(classification)
+    if type(class_def) is str:
+        print(
+            f"The Classification {classification} is not known to the Egeria platform at {url} - {server}"
+            )
+        sys.exit(0)
+
+    elements = c_client.find_elements_by_classification_with_property_value(classification, property_value,
+                                                                           property_names, om_type)
+    c = classification
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            caption=f"Find Metadata Elements for: {url} - {server} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            title=f"Elements for Classification: {c}, Open Metadata Type: {om_type}, property value: {property_value}, "
+                  f"properties: {property_names}",
+            expand=True,
+            width=width,
+        )
+
+        table.add_column("Qualified Name")
+        table.add_column("Type")
+        table.add_column("Created")
+        table.add_column("Home Store")
+        table.add_column("GUID", width=38, no_wrap=True)
+        table.add_column("Properties")
+        table.add_column("Classifications")
+
+        if type(elements) is list:
+            for element in elements:
+                header = element["elementHeader"]
+                el_q_name = element["properties"].get("qualifiedName", "---")
+                el_type = header["type"]["typeName"]
+                el_home = header["origin"]["homeMetadataCollectionName"]
+                el_create_time = header["versions"]["createTime"][:-10]
+                el_guid = header["guid"]
+                el_class = header.get("classifications", "---")
+
+                el_props_md = ""
+                for prop in element["properties"].keys():
+                    el_props_md += f"* **{prop}**: {element['properties'][prop]}\n"
+                el_props_out = Markdown(el_props_md)
+
+                c_md = ""
+                if type(el_class) is list:
+                    for classification in el_class:
+                        classification_name = classification.get(
+                            "classificationName", "---"
+                        )
+                        c_md = f"* **{classification_name}**\n"
+                        class_props = classification.get(
+                            "classificationProperties", "---"
+                        )
+                        if type(class_props) is dict:
+                            for prop in class_props.keys():
+                                c_md += f"  * **{prop}**: {class_props[prop]}\n"
+                c_md_out = Markdown(c_md)
+
+                table.add_row(
+                    el_q_name,
+                    el_type,
+                    el_create_time,
+                    el_home,
+                    el_guid,
+                    el_props_out,
+                    c_md_out,
+                )
+
+            return table
+        else:
+            print("No instances found")
+            sys.exit(1)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+        print("\n\nPerhaps the type name isn't known")
+    finally:
+        c_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    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")
+    parser.add_argument("--password", help="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
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    password = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        classification = Prompt.ask("Enter the Classification to filter on", default="Anchors")
+        om_type = Prompt.ask(
+            "Enter the Open Metadata Type to find elements of", default="GlossaryTerm"
+        )
+        property_value = Prompt.ask("Enter the property value to search for")
+        property_names = Prompt.ask("Enter a comma seperated list of properties to search")
+        find_elements_by_classification_by_prop_value(om_type, classification,property_value,
+                                                      [property_names], server, url, userid, password)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()