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

commands/tech/list_solution_roles.py

@@ -0,0 +1,184 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for Information Solution Roles
+
+"""
+
+import argparse
+import os
+import time
+
+from rich import box, print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+from rich.tree import Tree
+
+from pyegeria import (
+    InvalidParameterException,
+    ProjectManager,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    save_mermaid_html,
+)
+from pyegeria._exceptions import print_exception_response
+from pyegeria.mermaid_utilities import EGERIA_MERMAID_FOLDER
+from pyegeria.solution_architect_omvs import SolutionArchitect
+
+disable_ssl_warnings = True
+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", "qs-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", "150"))
+EGERIA_MERMAID_FOLDER = os.environ.get("EGERIA_MERMAID_FOLDER", "work/mermaid_graphs")
+
+
+def solution_role_list(
+    search_string: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    timeout: int = 30,
+):
+    """A Supply Chain viewer"""
+    client = SolutionArchitect(server_name, platform_url, user, user_password)
+    token = client.create_egeria_bearer_token()
+
+    def generate_table() -> Table | str:
+        table = Table(
+            title=f"Solution Roles matching  {search_string} @ {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 '{server_name}' @ Platform - {platform_url}",
+            expand=True,
+        )
+        table.add_column("Role Id  /  Diagram Link", justify="center", no_wrap=False)
+        table.add_column("Title / Type / Scope / HeadCount", justify="center")
+        table.add_column(
+            "Qualified Name   /  GUID", justify="center", width=38, no_wrap=False
+        )
+        table.add_column("Description / HeadCount", justify="center")
+        table.add_column("Solution Components", justify="center")
+
+        roles = client.find_solution_roles(search_string)
+        if isinstance(roles, list) is False:
+            return "No Roles found"
+
+        for role in roles:
+            role_name = role["properties"].get("roleId", "---")
+
+            role_title = role["properties"].get("title", "---")
+            role_scope = role["properties"].get("scope", "---")
+            role_type = role["properties"].get("typeName", "---")
+            role_headcount = (
+                role["properties"].get("extendedProperties", {}).get("headCount", "---")
+            )
+            role_info = (
+                f"Title: {role_title}\n\n--\n\nType: {role_type}\n\n--\n\n"
+                f"Scope: {role_scope}\n\n--\n\nHeadCount: {role_headcount}"
+            )
+
+            role_qname = role["properties"].get("qualifiedName", "---")
+            role_guid = role["elementHeader"]["guid"]
+            role_unique_name = f"{role_qname}\n\n--\n\n{role_guid}"
+
+            role_desc = role["properties"].get("description", "---")
+
+            role_mermaid = role.get("mermaidGraph", "---")
+            if role_mermaid != "---":
+                link = save_mermaid_html(
+                    role_name, role_mermaid, f"{EGERIA_MERMAID_FOLDER}/roles"
+                )
+                link = f"file://:{link}"
+                role_mermaid = Text(link, style="blue link " + link)
+
+            role_mermaid_label = Text(f"{role_name}\n\n--\n\n{role_mermaid}")
+
+            role_components = role.get("solutionComponents", [])
+            comp_props_md = ""
+            first_comp = True
+            for component in role_components:
+                if first_comp:
+                    first_comp = False
+                else:
+                    comp_props_md += "\n\n---\n\n"
+                comp = component.get("relatedElement", "")
+                if isinstance(comp, dict) is False:
+                    continue
+                comp_props = comp.get("properties", {})
+
+                for prop in comp_props.keys():
+                    comp_props_md += f"* **{prop}**: {comp_props[prop]}\n"
+
+
+
+            comp_props_out = Markdown(comp_props_md)
+            table.add_row(
+                role_mermaid_label,
+                role_info,
+                role_unique_name,
+                role_desc,
+                comp_props_out,
+            )
+
+        return table
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+        with console.pager():
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        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("--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
+    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:
+        search_string = Prompt.ask("Enter a search string:", default="*")
+        solution_role_list(search_string, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

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

@@ -13,8 +13,8 @@ from rich.prompt import Prompt
 from rich.table import Table
 from textual.widgets import DataTable
 
-from pyegeria import AutomatedCuration
 from pyegeria import (
+    AutomatedCuration,
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
@@ -25,11 +25,11 @@ 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 = 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")

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

@@ -9,13 +9,12 @@ Unit tests for the Utils helper functions using the Pytest framework.
 
 A simple display for glossary terms
 """
-import os
 import argparse
 import json
+import os
 import time
 
-from rich import box
-from rich import print
+from rich import box, print
 from rich.console import Console
 from rich.prompt import Prompt
 from rich.table import Table
@@ -24,18 +23,18 @@ from pyegeria import (
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
+    ValidMetadataManager,
     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 = 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")

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

@@ -1,37 +1,40 @@
 """This creates a templates guid file from the core metadata archive"""
-from rich.markdown import Markdown
-from rich.prompt import Prompt
-import os
-from pyegeria import AutomatedCuration, _client
-from datetime import datetime
+
 import argparse
-import time
+import asyncio
+import os
 import sys
+import time
+from datetime import datetime
+from typing import Union
+
+import nest_asyncio
 from rich import box
 from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
 from rich.table import Table
-import asyncio
-import nest_asyncio
-from typing import Union
+from textual.widgets import DataTable
 
 from pyegeria import (
+    AutomatedCuration,
     InvalidParameterException,
     PropertyServerException,
+    RegisteredInfo,
     UserNotAuthorizedException,
+    _client,
     print_exception_response,
-    RegisteredInfo,
 )
-from textual.widgets import DataTable
 
 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 = 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")

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

@@ -19,22 +19,22 @@ from rich.prompt import Prompt
 from rich.table import Table
 
 from pyegeria import (
+    ClassificationManager,
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    ClassificationManager,
 )
 
 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 = 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")
@@ -153,7 +153,9 @@ def main():
             "Enter the relationship to search",
             default="SpecificationPropertyAssignment",
         )
-        om_type = Prompt.ask("Enter an optional Open Metadata Type", default=None)
+        om_type = Prompt.ask(
+            "Enter an optional Open Metadata Type", default="Referenceable"
+        )
         display_related_elements(
             element_guid, relationship, om_type, server, url, userid, password
         )

md_processing/__init__.py

@@ -0,0 +1,49 @@
+"""
+This package contains functions to parse and process Egeria Markdown (Freddie)
+"""
+
+from md_processing.md_commands.blueprint_commands import (process_blueprint_upsert_command,
+                                                          process_solution_component_upsert_command)
+from md_processing.md_commands.data_designer_commands import (process_data_field_upsert_command,
+                                                              process_data_spec_upsert_command,
+                                                              process_data_dict_upsert_command,
+                                                              process_data_dict_list_command,
+                                                              process_data_structure_upsert_command)
+
+from md_processing.md_commands.glossary_commands import (process_glossary_upsert_command, process_glossary_list_command,
+                                                         process_glossary_structure_command,
+                                                         process_category_upsert_command, update_category_parent,
+                                                         process_category_list_command, update_term_categories,
+                                                         process_term_upsert_command,
+                                                         process_create_term_term_relationship_command,
+                                                         process_term_list_command, process_term_details_command,
+                                                         process_term_history_command,
+                                                         process_term_revision_history_command)
+from md_processing.md_commands.project_commands import (process_per_proj_upsert_command)
+# Re-export all functions from the original md_processing_utils.py to maintain backward compatibility
+from md_processing.md_processing_utils.common_md_utils import (render_markdown, is_valid_iso_date, set_debug_level,
+                                                               get_current_datetime_string, print_msg, EGERIA_WIDTH,
+                                                               console, debug_level, get_element_dictionary,
+                                                               update_element_dictionary, clear_element_dictionary,
+                                                               is_present, find_key_with_value,
+                                                               process_provenance_command)
+from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, extract_command,
+                                                                extract_attribute, process_simple_attribute,
+                                                                process_name_list, process_element_identifiers,
+                                                                get_element_by_name, update_a_command)
+from md_processing.md_processing_utils.md_processing_constants import (ALWAYS, ERROR, INFO, WARNING, pre_command,
+                                                                       command_seperator, EXISTS_REQUIRED,
+                                                                       GLOSSARY_NAME_LABELS, CATEGORY_NAME_LABELS,
+                                                                       PARENT_CATEGORY_LABELS, CHILD_CATEGORY_LABELS,
+                                                                       TERM_NAME_LABELS, PROJECT_NAME_LABELS,
+                                                                       BLUEPRINT_NAME_LABELS, COMPONENT_NAME_LABELS,
+                                                                       SOLUTION_ROLE_LABELS, SOLUTION_ACTOR_ROLE_LABELS,
+                                                                       SOLUTION_LINKING_ROLE_LABELS, OUTPUT_LABELS,
+                                                                       SEARCH_LABELS, GUID_LABELS,
+                                                                       ELEMENT_OUTPUT_FORMATS, TERM_RELATIONSHPS,
+                                                                       command_list, COMMAND_DEFINITIONS)
+# Import functions from md_processing_constants
+from md_processing.md_processing_utils.md_processing_constants import (load_commands, get_command_spec, get_attribute,
+                                                                       get_attribute_labels, get_alternate_names)
+# Import message constants
+from md_processing.md_processing_utils.message_constants import (message_types, ALWAYS, ERROR, INFO, WARNING)