pyegeria 5.3.10__tar.gz → 5.4.0.dev2__tar.gz

{pyegeria-5.3.10 → pyegeria-5.4.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyegeria
-Version: 5.3.10
+Version: 5.4.0.dev2
 Summary: A python client for Egeria
 License: Apache 2.0
 Keywords: egeria,metadata,governance
@@ -16,6 +16,7 @@ Requires-Dist: click
 Requires-Dist: httpx
 Requires-Dist: jupyter
 Requires-Dist: jupyter-notebook-parser (>=0.1.4,<0.2.0)
+Requires-Dist: loguru (>=0.7.3,<0.8.0)
 Requires-Dist: mermaid-py
 Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
 Requires-Dist: pytest (>=8.3.5,<9.0.0)

{pyegeria-5.3.10 → pyegeria-5.4.0.dev2}/commands/cat/dr_egeria_md.py

@@ -1,9 +1,14 @@
 """
 This is an ongoing experiment in parsing and playing with Freddie docs
 """
-import os
+import os, sys
 from datetime import datetime
-
+from loguru import logger
+log_format = "{time} | {level} | {function} | {line} | {message} | {extra}"
+logger.remove()
+logger.add(sys.stderr, level="SUCCESS", format=log_format, colorize=True)
+logger.add("debug_log.log", rotation="1 day", retention="1 week", compression="zip", level="TRACE", format=log_format,
+           colorize=True)
 import click
 from rich import print
 from rich.console import Console
@@ -15,12 +20,14 @@ from md_processing import (extract_command, process_glossary_upsert_command, pro
                            process_category_list_command, process_glossary_list_command, process_term_history_command,
                            process_glossary_structure_command, process_term_revision_history_command,
                            process_create_term_term_relationship_command, process_term_details_command,
-                           )
+                           process_information_supply_chain_upsert_command, process_information_supply_chain_segment_upsert_command,
+                           process_information_supply_chain_link_unlink_command,process_sol_arch_list_command)
 from md_processing.md_commands.data_designer_commands import (process_data_spec_upsert_command,
                                                               process_data_dict_upsert_command,
                                                               process_data_dict_list_command,
                                                               process_data_field_upsert_command,
-                                                              process_data_structure_upsert_command)
+                                                              process_data_structure_upsert_command,
+                                                              process_data_class_upsert_command)
 
 from pyegeria import EgeriaTech
 
@@ -53,10 +60,12 @@ EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "md_processing/dr_eger
 @click.option("--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to")
 @click.option("--userid", default=EGERIA_USER, help="Egeria user")
 @click.option("--user_pass", default=EGERIA_USER_PASSWORD, help="Egeria user password")
+@logger.catch
 def process_markdown_file(file_path: str, directive: str, server: str, url: str, userid: str, user_pass: str, ) -> None:
     """
     Process a markdown file by parsing and executing Dr. Egeria md_commands. Write output to a new file.
     """
+
     cmd_list = command_list
     console = Console(width=int(EGERIA_WIDTH))
     client = EgeriaTech(server, url, user_id=userid)
@@ -64,7 +73,8 @@ def process_markdown_file(file_path: str, directive: str, server: str, url: str,
 
     updated = False
     full_file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_INBOX_PATH, file_path)
-    print(f"Processing Markdown File: {full_file_path}")
+    logger.info("\n\n====================================================\n\n")
+    logger.info(f"Processing Markdown File: {full_file_path}")
     try:
         with open(full_file_path, 'r') as f:
             lines = f.readlines()
@@ -121,8 +131,23 @@ def process_markdown_file(file_path: str, directive: str, server: str, url: str,
             elif potential_command in ["Create Blueprint", "Update Blueprint", "Create Solution Blueprint",
                                        "Update Solution Blueprint"]:
                 result = process_blueprint_upsert_command(client, current_block, directive)
+            elif potential_command in ["View Solution Blueprints", "View Blueprint", "View Solution Blueprint"]:
+                result = process_sol_arch_list_command(client, current_block, "Solution Blueprints",directive)
+            elif potential_command in ["View Solution Component", "View Solution Components"]:
+                result = process_sol_arch_list_command(client, current_block, "Solution Components",directive)
+            elif potential_command in ["View Solution Roles", "View Solution Role"]:
+                result = process_sol_arch_list_command(client, current_block, "Solution Roles",directive)
+            elif potential_command in ["View Information Supply Chain", "View Information Supply Chains"]:
+                result = process_sol_arch_list_command(client, current_block, "Information Supply Chains",directive)
             elif potential_command in ["Create Solution Component", "Update Solution Component"]:
                 result = process_solution_component_upsert_command(client, current_block, directive)
+            elif potential_command in ["Create Information Supply Chain", "Update Information Supply Chain"]:
+                result = process_information_supply_chain_upsert_command(client, current_block, directive)
+            elif potential_command in ["Create Information Supply Chain Segment", "Update Information Supply Chain Segment"]:
+                result = process_information_supply_chain_segment_upsert_command(client, current_block, directive)
+            elif potential_command in ["Link Segments", "Detach Segments"]:
+                result = process_information_supply_chain_link_unlink_command(client, current_block, directive)
+
             elif potential_command in ["Create Data Spec", "Create Data Specification", "Update Data Spec",
                                        "Update Data Specification"]:
                 result = process_data_spec_upsert_command(client, current_block, directive)
@@ -133,6 +158,8 @@ def process_markdown_file(file_path: str, directive: str, server: str, url: str,
                 result = process_data_field_upsert_command(client, current_block, directive)
             elif potential_command in ["Create Data Structure", "Update Data Structure"]:
                 result = process_data_structure_upsert_command(client, current_block, directive)
+            elif potential_command in ["Create Data Class", "Update Data Class"]:
+                result = process_data_class_upsert_command(client, current_block, directive)
             elif potential_command in ["View Data Dictionaries", "View Data Dictionary"]:
                 result = process_data_dict_list_command(client, current_block, directive)
 

{pyegeria-5.3.10 → pyegeria-5.4.0.dev2}/commands/cat/list_collections.py

@@ -94,7 +94,7 @@ def display_collections(
             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_collections(
-                search_string.strip(), None, False, ends_with=False, ignore_case=True,
+                search_string.strip(), None, None, False, ends_with=False, ignore_case=True,
                 output_format=output_format
                 )
             if output == NO_ELEMENTS_FOUND:
@@ -129,7 +129,7 @@ def display_collections(
         table.add_column("Members")
 
         collections = m_client.find_collections(
-            search_string.strip(), None, False, ends_with=False, ignore_case=True,
+            search_string.strip(), None, None, False, ends_with=False, ignore_case=True,
             output_format = "DICT"
         )
         if type(collections) is list:
@@ -145,8 +145,14 @@ def display_collections(
                 collection_type = collection.get("collectionType", "---")
                 classifications = collection.get("classifications", "---")
                 classifications_md = Markdown(classifications)
-                members = "\n* ".join(collection.get("members", []))
-                members_md = Markdown(members)
+                members_struct = m_client.get_collection_members(collection_guid=guid)
+                member_list = ""
+                if isinstance(members_struct, list):
+                    for member in members_struct:
+                        member_list = member_list + f"- {member['properties'].get('qualifiedName','---')}\n"
+
+                # members = "\n* ".join(collection.get("members", []))
+                members_md = Markdown(member_list)
 
                 table.add_row(
                     display_name,

pyegeria-5.4.0.dev2/commands/cat/list_data_designer.py

@@ -0,0 +1,171 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+List categories for a category.
+
+
+A simple display for category terms
+"""
+import argparse
+import os
+import sys
+import time
+
+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,
+)
+
+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", "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_category_PATH = os.environ.get("EGERIA_category_PATH", None)
+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(
+    object_type: str,
+    search_string: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+    output_format: str = "TABLE",
+):
+    """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
+        The view server name or address where the Egeria services are hosted.
+    view_url : str
+        The URL of the platform the view server is on.
+    user : str
+        The user ID for authentication with the Egeria server.
+    user_pass : str
+        The password for authentication with the Egeria server.
+    jupyter : bool, optional
+        A boolean indicating whether the output is intended for a Jupyter notebook (default is EGERIA_JUPYTER).
+    width : int, optional
+        The width of the console output (default is EGERIA_WIDTH).
+    output_format: str, optional, default is 'JSON'
+        One of  FORM, REPORT, TABLE
+    """
+    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 Structure":
+            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
+
+    try:
+        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"{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_proc(search_string, output_format=output_format)
+            if output == "NO_ELEMENTSS_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==> Elements output written to {full_file_path}")
+            return
+        else:
+            output = m_client.find_proec(search_string, output_format=output_format)
+            console.print(Markdown(output))
+            return
+
+
+
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+def main_structs():
+    main(object_type = "Data Structure")
+
+def main_fileds():
+    main(object_type = "Data Fields")
+
+def main_classes():
+    main(object_type = "Data Classes")
+
+def main(object_type: str):
+    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 the category you are searching for or '*' for all:", default="*"
+        )
+        output_format = Prompt.ask("What output format do you want?", choices=["TABLE", "FORM", "REPORT"],
+                                   default="TABLE")
+        object_type = object_type if not None else "Data Structure"
+        display_categories(object_type, search_string, server, url, userid,
+                           user_pass, output_format = output_format)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()