pyegeria 5.2.1.1__py3-none-any.whl → 5.3__py3-none-any.whl

{pyegeria/commands → commands}/tech/list_anchored_elements.py

@@ -4,7 +4,7 @@ SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
 
-Retrieve elements based on a search of a specified properties.
+Retrieve anchored elements based on a search of a specified properties.
 """
 import argparse
 import os
@@ -13,26 +13,26 @@ import time
 
 from rich import box
 from rich.console import Console
-from rich.prompt import Prompt
 from rich.markdown import Markdown
+from rich.prompt import Prompt
 from rich.table import Table
 
 from pyegeria import (
+    EgeriaTech,
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    EgeriaTech,
 )
 
 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 = 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_INTEGRATION_DAEMON = os.environ.get("EGERIA_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")
@@ -45,7 +45,7 @@ disable_ssl_warnings = True
 
 
 def display_anchored_elements(
-    search_string: str,
+    property_value: str,
     prop_list: list[str],
     server: str,
     url: str,
@@ -56,19 +56,19 @@ def display_anchored_elements(
     width: int = EGERIA_WIDTH,
 ):
     console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
-    if (search_string is None) or (len(search_string) < 3):
+    if (property_value is None) or (len(property_value) < 3):
         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")
+    print(f"search value is {property_value} and prop_list is {prop_list}\n")
 
-    def generate_table(search_string: str, prop_list: [str]) -> Table:
+    def generate_table(property_value: str, prop_list: [str]) -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Elements containing the string  {search_string} @ {time.asctime()}",
+            title=f"Elements containing the string  {property_value} @ {time.asctime()}",
             header_style="white on dark_blue",
             style="bold white on black",
             row_styles=["bold white on black"],
@@ -88,7 +88,7 @@ def display_anchored_elements(
 
         classification = "Anchors"
         open_type_name = None
-        property_value = search_string
+        property_value = property_value
 
         property_names = prop_list
 
@@ -150,7 +150,7 @@ def display_anchored_elements(
 
     try:
         with console.pager(styles=True):
-            console.print(generate_table(search_string, prop_list), soft_wrap=True)
+            console.print(generate_table(property_value, prop_list), soft_wrap=True)
 
     except (
         InvalidParameterException,
@@ -183,19 +183,19 @@ 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 property search string:", default="")
+        property_value = Prompt.ask("Enter an property search string:", default="")
         prop_list = Prompt.ask(
             "Enter the list of properties to search", default="anchorTypeName"
         )
-        if search_string == "":
+        if property_value == "":
             print("\nError --> Search string can't be empty")
             sys.exit(1)
-        elif len(search_string) <= 4:
+        elif len(property_value) <= 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
+                property_value, [prop_list], server, url, userid, user_pass, time_out
             )
     except KeyboardInterrupt:
         pass

{pyegeria/commands → commands}/tech/list_asset_types.py

@@ -8,8 +8,8 @@ Unit tests for the Utils helper functions using the Pytest framework.
 
 A simple display for my profile
 """
-import os
 import argparse
+import os
 import time
 
 from rich import box
@@ -19,19 +19,19 @@ from rich.table import Table
 from pyegeria import (
     InvalidParameterException,
     PropertyServerException,
+    RegisteredInfo,
     UserNotAuthorizedException,
     print_exception_response,
-    RegisteredInfo,
 )
 
 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 = 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_INTEGRATION_DAEMON = os.environ.get("EGERIA_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")

commands/tech/list_elements_by_classification_by_property_value.py

@@ -0,0 +1,200 @@
+"""This finds all elements of a classification that match the property value for the properties specified"""
+
+import argparse
+import os
+import sys
+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 (
+    EgeriaTech,
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+
+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("EGERIA_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="Referenceable"
+        )
+        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()

commands/tech/list_elements_by_property_value.py

@@ -0,0 +1,180 @@
+"""This creates a templates guid file from the core metadata archive"""
+
+import argparse
+import os
+import sys
+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 (
+    EgeriaTech,
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+
+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("EGERIA_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_prop_value(
+    om_type: 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(1)
+    elements = c_client.find_elements_by_property_value(
+        property_value, property_names, om_type
+    )
+
+    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 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:
+        om_type = Prompt.ask(
+            "Enter the Open Metadata Type to find elements of", default="Referenceable"
+        )
+        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_prop_value(
+            om_type, property_value, [property_names], server, url, userid, password
+        )
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()