pyegeria 0.2.4__py3-none-any.whl → 5.3.0.dev3__py3-none-any.whl

pyegeria/commands/tech/list_tech_templates.py

@@ -0,0 +1,360 @@
+"""This creates a templates guid file from the core metadata archive"""
+
+import argparse
+import os
+import sys
+import time
+from typing import Union
+
+import nest_asyncio
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+from textual.widgets import DataTable
+
+from pyegeria import AutomatedCuration
+from pyegeria import (
+    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("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 list_templates(
+    search_string: str, server: str, url: str, username: str, password: str
+) -> []:
+    """Return a list of templates for one or more technology type"""
+    a_client = AutomatedCuration(server, url, username)
+    token = a_client.create_egeria_bearer_token(username, password)
+    tech_list = a_client.find_technology_types(search_string, page_size=0)
+    tech_info_list: dict = []
+
+    if type(tech_list) is list:
+        for item in tech_list:
+            if "deployedImplementationType" not in item["qualifiedName"]:
+                continue
+
+            details = a_client.get_technology_type_detail(item["name"])
+            entry = {details["name"]: {}}
+            if type(details) is str:
+                tech_info_list.append(entry)
+                continue
+            templates = details.get("catalogTemplates", "Not Found")
+            if type(templates) is list:
+                t_list = []
+                entry = {details["name"]: {}}
+                for template in templates:
+                    t_list.append({"template": template["name"]})
+                entry[details["name"]] = t_list
+                tech_info_list.append(entry)
+    return tech_info_list
+
+
+def add_row(
+    table: Union[Table, DataTable],
+    name: str,
+    template_name: str,
+    template_guid: str,
+    placeholder_table: Table,
+) -> Table | DataTable:
+    if isinstance(table, Table):
+        table.add_row(name, template_name, template_guid, placeholder_table)
+    elif isinstance(table, DataTable):
+        table.add_row(name, template_name, template_guid, placeholder_table)
+
+    return table
+
+
+def display_templates_spec(
+    search_string: str,
+    server: str,
+    url: str,
+    username: str,
+    password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    data_table: bool = False,
+) -> Table | DataTable:
+    a_client = AutomatedCuration(server, url, username)
+    nest_asyncio.apply()
+    token = a_client.create_egeria_bearer_token(username, password)
+    tech_list = a_client.find_technology_types(search_string, page_size=0)
+
+    def generate_table(data_table: bool) -> Table | DataTable:
+        """Make a new table."""
+        if data_table:
+            table = DataTable()
+            table.add_columns("Name", "Template Name", "Template GUID", "Placeholders")
+        else:
+            table = Table(
+                title=f"Technology Templates for: {url} @ {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,
+                caption=f"Templates from Server '{server}' @ Platform - {url}",
+                expand=True,
+                # width=500
+            )
+
+            table.add_column("Name", width=20)
+            table.add_column("Template Name", width=20)
+            table.add_column("Template GUID", width=38, no_wrap=True)
+            table.add_column("Placeholders")
+
+        if type(tech_list) is list:
+            for item in tech_list:
+                if "deployedImplementationType" not in item["qualifiedName"]:
+                    continue
+                placeholder_table = Table(expand=False, show_lines=True)
+                placeholder_table.add_column("Name", width=20, no_wrap=True)
+                placeholder_table.add_column("Type", width=10)
+                placeholder_table.add_column("Required", width=10)
+                placeholder_table.add_column("Example", width=20)
+                placeholder_table.add_column("Description", width=40)
+
+                name = item.get("name", "none")
+
+                details = a_client.get_technology_type_detail(name)
+                if type(details) is str:
+                    console.log(f"Missing details for - {name}: {details}")
+                    continue
+
+                templates = details.get("catalogTemplates", "Not Found")
+                if type(templates) is not str:
+                    for template in templates:
+                        template_name = template.get("name", None)
+
+                        template_name = (
+                            f"{name}_Template"
+                            if template_name is None
+                            else template_name
+                        )
+
+                        specification = template["specification"]["placeholderProperty"]
+                        template_guid = template["relatedElement"]["guid"]
+
+                        for placeholder in specification:
+                            placeholder_data_type = placeholder["dataType"]
+                            placeholder_description = placeholder["description"]
+                            placeholder_name = placeholder["placeholderPropertyName"]
+                            placeholder_required = placeholder["required"]
+                            placeholder_example = placeholder.get("example", None)
+                            placeholder_table.add_row(
+                                placeholder_name,
+                                placeholder_data_type,
+                                placeholder_required,
+                                placeholder_example,
+                                placeholder_description,
+                            )
+
+                        # table.add_row(name, template_name, template_guid, placeholder_table)
+                        table = add_row(
+                            table, name, template_name, template_guid, placeholder_table
+                        )
+
+            return table
+        else:
+            print("Unknown technology type")
+            sys.exit(1)
+
+    try:
+        if data_table:
+            return generate_table(data_table)
+        else:
+            console = Console(width=width, force_terminal=not jupyter)
+
+            with console.pager(styles=True):
+                console.print(generate_table(data_table))
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+    finally:
+        a_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
+    guid = None
+
+    try:
+        search_string = Prompt.ask(
+            "Enter the technology you are searching for:", default="*"
+        )
+        display_templates_spec(
+            search_string, server, url, userid, password, data_table=False
+        )
+    except KeyboardInterrupt:
+        pass
+
+
+# def display_templates_spec(
+#     search_string: str,
+#     server: str,
+#     url: str,
+#     username: str,
+#     password: str,
+#     jupyter: bool = EGERIA_JUPYTER,
+#     width: int = EGERIA_WIDTH,
+# ):
+#     a_client = AutomatedCuration(server, url, username)
+#     token = a_client.create_egeria_bearer_token(username, password)
+#     tech_list = a_client.find_technology_types(search_string, page_size=0)
+#
+#     def generate_table() -> Table:
+#         """Make a new table."""
+#         table = Table(
+#             title=f"Technology Templates for: {url} @ {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,
+#             caption=f"Templates from Server '{server}' @ Platform - {url}",
+#             expand=True,
+#             # width=500
+#         )
+#
+#         table.add_column("Name", width=20)
+#         table.add_column("Template Name", width=20)
+#         table.add_column("Template GUID", width=38, no_wrap=True)
+#         table.add_column("Placeholders")
+#
+#         if type(tech_list) is list:
+#             for item in tech_list:
+#                 if "deployedImplementationType" not in item["qualifiedName"]:
+#                     continue
+#                 placeholder_table = Table(expand=False, show_lines=True)
+#                 placeholder_table.add_column("Name", width=20, no_wrap=True)
+#                 placeholder_table.add_column("Type", width=10)
+#                 placeholder_table.add_column("Required", width=10)
+#                 placeholder_table.add_column("Example", width=20)
+#                 placeholder_table.add_column("Description", width=40)
+#
+#                 name = item.get("name", "none")
+#
+#                 details = a_client.get_technology_type_detail(name)
+#                 if type(details) is str:
+#                     console.log(f"Missing details for - {name}: {details}")
+#                     continue
+#
+#                 templates = details.get("catalogTemplates", "Not Found")
+#                 if type(templates) is not str:
+#                     for template in templates:
+#                         template_name = template.get("name", None)
+#
+#                         template_name = (
+#                             f"{name}_Template"
+#                             if template_name is None
+#                             else template_name
+#                         )
+#
+#                         specification = template["specification"]["placeholderProperty"]
+#                         template_guid = template["relatedElement"]["guid"]
+#
+#                         for placeholder in specification:
+#                             placeholder_data_type = placeholder["dataType"]
+#                             placeholder_description = placeholder["description"]
+#                             placeholder_name = placeholder["placeholderPropertyName"]
+#                             placeholder_required = placeholder["required"]
+#                             placeholder_example = placeholder.get("example", None)
+#                             placeholder_table.add_row(
+#                                 placeholder_name,
+#                                 placeholder_data_type,
+#                                 placeholder_required,
+#                                 placeholder_example,
+#                                 placeholder_description,
+#                             )
+#
+#                         table.add_row(
+#                             name, template_name, template_guid, placeholder_table
+#                         )
+#
+#             return table
+#         else:
+#             print("Unknown technology type")
+#             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)
+#         assert e.related_http_code != "200", "Invalid parameters"
+#     finally:
+#         a_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
+#     guid = None
+#
+#     try:
+#         search_string = Prompt.ask(
+#             "Enter the technology you are searching for:", default="*"
+#         )
+#         # display_templates_spec(search_string, server, url, userid, password)
+#         list_templates(search_string, server, url, userid, password)
+#     except KeyboardInterrupt:
+#         pass
+#
+#
+# if __name__ == "__main__":
+#     main()

pyegeria/commands/tech/list_valid_metadata_values.py

@@ -0,0 +1,178 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for glossary terms
+"""
+import os
+import argparse
+import json
+import time
+
+from rich import box
+from rich import print
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+)
+from pyegeria import ValidMetadataManager
+
+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"))
+
+
+def display_metadata_values(
+    property_name: str,
+    type_name: str,
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    save_output: bool,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    m_client = ValidMetadataManager(server, url, user_id=username)
+    token = m_client.create_egeria_bearer_token(username, user_pass)
+
+    def generate_table(property_name: str, type_name: str) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Valid Metadata Values for Property: {property_name} of type {type_name} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Valid Metadata Values for Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+
+        table.add_column("Category")
+        table.add_column("Display Name")
+
+        table.add_column("Preferred Value")
+        table.add_column("Deprecated")
+        table.add_column("Case Sensitive")
+        table.add_column("Additional Properties")
+        table.add_column("Description")
+
+        valid_values = m_client.get_valid_metadata_values(property_name, type_name)
+
+        if valid_values is None:
+            name = " "
+            type_name = " "
+            created = " "
+            priority = " "
+            due = " "
+            completed = " "
+            status = " "
+            sponsor = " "
+        elif type(valid_values[0]) == str:
+            raise ValueError(
+                "-->This is not a known metadata property with a valid value"
+            )
+        else:
+            for value in valid_values:
+                category = value.get("category", "None")
+                display_name = value.get("displayName", "None")
+                preferred_value = value.get("preferredValue", "None ")
+                deprecated = str(value.get("isDeprecated", "None "))
+                case_sensitive = str(value.get("isCaseSensitive", "None"))
+                description = value.get("description", "None")
+                additional_properties = value.get("additionalProperties", "None")
+                if additional_properties is not None:
+                    props = json.dumps(additional_properties)
+                table.add_row(
+                    category,
+                    display_name,
+                    preferred_value,
+                    deprecated,
+                    case_sensitive,
+                    props,
+                    description,
+                )
+
+        m_client.close_session()
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+        console = Console(width=width, force_terminal=not jupyter, record=True)
+        with console.pager(styles=True):
+            console.print(generate_table(property_name, type_name))
+        if save_output:
+            console.save_html("valid-metadata-values.html")
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
+        if type(e) is str:
+            print(e)
+        else:
+            print_exception_response(e)
+
+
+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("--save-output", help="Save output to file?")
+    parser.add_argument("--password", help="User Password")
+    # parser.add_argument("--sponsor", help="Name of sponsor to search")
+    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
+    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
+
+    try:
+        property_name = Prompt.ask(
+            "Enter the Property to retrieve:", default="projectHealth"
+        )
+        type_name = Prompt.ask(
+            "Enter the Metadata Type to filter on:", default="Project"
+        )
+        display_metadata_values(
+            property_name, type_name, server, url, userid, user_pass, save_output
+        )
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()