pyegeria 5.3.8.2__tar.gz → 5.3.8.4__tar.gz

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pyegeria
-Version: 5.3.8.2
+Version: 5.3.8.4
 Summary: A python client for Egeria
 License: Apache 2.0
 Keywords: egeria,metadata,governance

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/__init__.py

@@ -94,7 +94,9 @@ from .md_processing_utils import (extract_command, process_glossary_upsert_comma
                                   process_categories_upsert_command,
                                   get_current_datetime_string, process_per_proj_upsert_command, command_list,
                                   render_markdown, process_provenance_command, process_blueprint_upsert_command,
-                                  process_solution_component_upsert_command)
+                                  process_solution_component_upsert_command, process_set_categories_parent_command,
+                                  process_term_list_command, process_glossary_list_command,process_category_list_command,
+                                  process_term_history_command,)
 
 #
 # The following assignments were generated by the `create_tech_guid_lists.py` utility that uses the pyegeria functions

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/_client.py

@@ -784,5 +784,55 @@ class Client:
             q_name = f"{q_name}::{version_identifier}"
         return q_name
 
+    def make_preamble(self, obj_type: str, search_string: str, output_format: str = 'MD') -> tuple[str, str | None]:
+        """
+        Creates a preamble string and an elements action based on the given object type, search string,
+        and output format. The preamble provides a descriptive header based on the intent: To make a form,
+        a report, or unadorned markdwon. The elements action specifies the action to be taken on the object type.
+
+        Args:
+            obj_type: The type of object being updated or reported on (e.g., "Product", "Category").
+            search_string: The search string used to filter objects. Defaults to "All Terms" if None.
+            output_format: A format identifier determining the output structure.
+                JSON - output standard json
+                MD - output standard markdown with no preamble
+                FORM - output markdown with a preamble for a form
+                REPORT - output markdown with a preamble for a report
+
+        Returns:
+            tuple: A tuple containing:
+                - A string representing the formatted update or report preamble.
+                - A string or None indicating the action description for the elements,
+                  depending on the output format.
+        """
+        search_string = search_string if search_string else "All Elements"
+        elements_action = "Update " + obj_type
+        if output_format == "FORM":
+            preamble = (f"\n# Update {obj_type} Form - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+                        f"\t {obj_type} found from the search string:  `{search_string}`\n\n")
+
+            return preamble, elements_action
+        elif output_format == "REPORT":
+            elements_md = (f"# {obj_type} Report - created at {datetime.now().strftime('%Y-%m-%d %H:%M')}\n"
+                           f"\t{obj_type}  found from the search string:  `{search_string}`\n\n")
+            elements_action = None
+            return elements_md, elements_action
+
+        else:
+            return "\n", elements_action
+
+    def make_md_attribute(self, attribute_name: str, attribute_value: str, output_type: str) -> str | None:
+        """ Create a markdown attribute line for a given attribute name and value."""
+        output = ""
+        attribute_value = attribute_value.strip() if attribute_value else ""
+        attribute_title = attribute_name.title() if attribute_name else ""
+        if output_type in ["FORM", "MD"]:
+            output = f"## {attribute_title}\n{attribute_value}\n\n"
+        elif output_type == "REPORT":
+            if attribute_value:
+                output = f"## {attribute_title}\n{attribute_value}\n\n"
+        return output
+
+
 if __name__ == "__main__":
     print("Main-__client")

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/commands/cat/dr_egeria_md.py

@@ -1,34 +1,27 @@
 """
 This is an ongoing experiment in parsing and playing with Freddie docs
 """
-import argparse
-import json
 import os
+from datetime import datetime
+
+import click
 from rich import print
 from rich.console import Console
-from rich.prompt import Prompt
 
-
-import click
 from pyegeria import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
                       process_categories_upsert_command, process_provenance_command,
-                      get_current_datetime_string, process_per_proj_upsert_command, command_list,EgeriaTech,
-                      process_blueprint_upsert_command, process_solution_component_upsert_command,
-                      shared_state
-                      )
-from datetime import datetime
+                      process_set_categories_parent_command, get_current_datetime_string,
+                      process_per_proj_upsert_command, command_list, EgeriaTech, process_blueprint_upsert_command,
+                      process_solution_component_upsert_command, dr_egeria_state, process_term_list_command,
+                      process_category_list_command, process_glossary_list_command, process_term_history_command)
 
 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_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_INTEGRATION_DAEMON_URL = os.environ.get(
-    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
-)
+EGERIA_INTEGRATION_DAEMON_URL = os.environ.get("EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443")
 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")
@@ -41,26 +34,17 @@ EGERIA_ROOT_PATH = os.environ.get("EGERIA_ROOT_PATH", "/Users/dwolfson/localGit/
 EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", "pyegeria/commands/cat/dr_egeria_inbox")
 EGERIA_OUTBOX_PATH = os.environ.get("EGERIA_OUTBOX_PATH", "pyegeria/commands/cat/dr_egeria_outbox")
 
+
 @click.command("process_markdown_file", help="Process a markdown file and return the output as a string.")
-@click.option("--file-path", help="File path to markdown file",
-              default="glossary_test1.md", required=True, prompt=False)
+@click.option("--file-path", help="File path to markdown file", default="glossary_test1.md", required=True,
+              prompt=False)
 @click.option("--directive", default="display", help="How to process the file",
-              type=click.Choice(["display","validate","process"],case_sensitive=False), prompt=False,)
+              type=click.Choice(["display", "validate", "process"], case_sensitive=False), prompt=False, )
 @click.option("--server", default=EGERIA_VIEW_SERVER, help="Egeria view server to use.")
-@click.option(
-    "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
-)
-
+@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")
-def process_markdown_file(
-        file_path: str,
-        directive: str,
-        server: str,
-        url: str,
-        userid: str,
-        user_pass: str,
-        )-> None:
+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 commands. Write output to a new file.
     """
@@ -82,12 +66,11 @@ def process_markdown_file(
     final_output = []
     prov_found = False
     prov_output = (f"\n# Provenance\n\n* Results from processing file {file_path} on "
-                    f"{datetime.now().strftime("%Y-%m-%d %H:%M")}\n")
+                   f"{datetime.now().strftime("%Y-%m-%d %H:%M")}\n")
     h1_blocks = []
     current_block = ""
     in_h1_block = False
 
-
     # Helper function to process the current block
     def process_current_block(current_block):
         nonlocal updated, final_output, prov_found, prov_output, h1_blocks, in_h1_block
@@ -103,31 +86,51 @@ def process_markdown_file(
                 prov_found = True
 
             elif potential_command in ["Create Glossary", "Update Glossary"]:
-                result = process_glossary_upsert_command(client, shared_state.get_element_dictionary(), current_block, directive)
+                result = process_glossary_upsert_command(client, dr_egeria_state.get_element_dictionary(),
+                                                         current_block, directive)
             elif potential_command in ["Create Category", "Update Category"]:
-                result = process_categories_upsert_command(client, shared_state.get_element_dictionary(), current_block, directive)
+                result = process_categories_upsert_command(client, dr_egeria_state.get_element_dictionary(),
+                                                           current_block, directive)
+            elif potential_command in ["Set Parent Category", "UnSet Parent Category"]:
+                result = process_set_categories_parent_command(client, dr_egeria_state.get_element_dictionary(),
+                                                               current_block, directive)
             elif potential_command in ["Create Term", "Update Term"]:
-                result = process_term_upsert_command(client, shared_state.get_element_dictionary(), current_block, directive)
+                result = process_term_upsert_command(client, dr_egeria_state.get_element_dictionary(), current_block,
+                                                     directive)
+            elif potential_command in ["List Term History", "Term History"]:
+                result = process_term_history_command(client, dr_egeria_state.get_element_dictionary(), current_block,
+                                                 directive)
+            elif potential_command in ["List Terms", "List Glossary Terms"]:
+                result = process_term_list_command(client, dr_egeria_state.get_element_dictionary(), current_block,
+                                                     directive)
+            elif potential_command in ["List Categories", "List Glossary Categories"]:
+                result = process_category_list_command(client, dr_egeria_state.get_element_dictionary(), current_block,
+                                                     directive)
+            elif potential_command in ["List Glossaries"]:
+                result = process_glossary_list_command(client, dr_egeria_state.get_element_dictionary(), current_block,
+                                                     directive)
             elif potential_command in ["Create Personal Project", "Update Personal Project"]:
-                result = process_per_proj_upsert_command(client, shared_state.get_element_dictionary(), current_block, directive)
-            elif potential_command in ["Create Blueprint", "Update Blueprint", "Create Solution Blueprint", "Update Solution Blueprint"]:
-                result = process_blueprint_upsert_command(client, shared_state.get_element_dictionary(), current_block, directive)
+                result = process_per_proj_upsert_command(client, dr_egeria_state.get_element_dictionary(),
+                                                         current_block, directive)
+            elif potential_command in ["Create Blueprint", "Update Blueprint", "Create Solution Blueprint",
+                                       "Update Solution Blueprint"]:
+                result = process_blueprint_upsert_command(client, dr_egeria_state.get_element_dictionary(),
+                                                          current_block, directive)
             elif potential_command in ["Create Solution Component", "Update Solution Component"]:
-                result = process_solution_component_upsert_command(client, shared_state.get_element_dictionary(), current_block, directive)
+                result = process_solution_component_upsert_command(client, dr_egeria_state.get_element_dictionary(),
+                                                                   current_block, directive)
 
 
             else:
                 # If command is not recognized, keep the block as-is
                 result = None
-            # print(json.dumps(shared_state.get_element_dictionary(), indent=4))
+            # print(json.dumps(dr_egeria_state.get_element_dictionary(), indent=4))
             if result:
                 if directive == "process":
                     updated = True
-                    final_output.append(result)
-                    # print(json.dumps(shared_state.get_element_dictionary(), indent=4))
+                    final_output.append(result)  # print(json.dumps(dr_egeria_state.get_element_dictionary(), indent=4))
                 elif directive == "validate":
-                    pass
-                    # print(json.dumps(shared_state.get_element_dictionary(), indent=4))
+                    pass  # print(json.dumps(dr_egeria_state.get_element_dictionary(), indent=4))
             elif directive == "process":
                 # Handle errors (skip this block but notify the user)
                 print(f"\n==>\tErrors found while processing command: \'{potential_command}\'\n"
@@ -175,7 +178,6 @@ def process_markdown_file(
     # Join the final output list into a single string
     final_output = "\n".join(final_output)
 
-
     try:
         if updated:
             path, filename = os.path.split(file_path)  # Get both parts
@@ -213,7 +215,8 @@ def process_markdown_file(
 #     time_out = args.time_out if args.time_out is not None else 60
 #     try:
 #         file_path = Prompt.ask("Markdown File name to process:", default="")
-#         directive = Prompt.ask("Processing Directive:", choices=[ "display", "validate", "process"], default="validate")
+#         directive = Prompt.ask("Processing Directive:", choices=[ "display", "validate", "process"],
+#         default="validate")
 #
 #         process_markdown_file(file_path, directive, server, url, userid, user_pass)
 #     except KeyboardInterrupt:

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/commands/cat/glossary_actions.py

@@ -128,7 +128,7 @@ def delete_glossary(server, url, userid, password, timeout, glossary_guid):
     m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
     token = m_client.create_egeria_bearer_token()
     try:
-        m_client.delete_glossary(glossary_guid)
+        m_client.delete_glossary(glossary_guid, cascade = True)
 
         click.echo(f"Deleted glossary: {glossary_guid}")
 

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/commands/cat/list_categories.py

@@ -119,7 +119,8 @@ def display_categories(
             "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
         )
         table.add_column("Description")
-        table.add_column("In Glossary (Qualified Name)")
+        table.add_column("In Glossary")
+        table.add_column("Parent Category")
 
         categories = m_client.find_glossary_categories(search_string)
         if type(categories) is list:
@@ -138,8 +139,14 @@ def display_categories(
                     glossary_guid = classification_props.get('anchorGUID','---')
                     glossary_qualified_name = (
                         m_client.get_glossary_by_guid(glossary_guid))['glossaryProperties']['qualifiedName']
+                cat_info = m_client.get_category_parent(category_guid)
+                if type(cat_info) is dict:
+                    parent_qn = cat_info['glossaryCategoryProperties']['qualifiedName']
+                else:
+                    parent_qn = '---'
 
-                table.add_row(display_name, q_name, description, glossary_qualified_name)
+
+                table.add_row(display_name, q_name, description, glossary_qualified_name, parent_qn)
             console = Console(
                 style="bold bright_white on black",
                 width=width,

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/commands/cat/list_glossaries.py

@@ -15,6 +15,7 @@ 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 rich.text import Text
@@ -128,6 +129,7 @@ def display_glossaries(
         table.add_column("Language")
         table.add_column("Description")
         table.add_column("Usage")
+        table.add_column("Categories")
 
         glossaries = m_client.find_glossaries(search_string)
         if type(glossaries) is list:
@@ -142,7 +144,15 @@ def display_glossaries(
                 language = glossary["glossaryProperties"].get("language",'---')
                 description = glossary["glossaryProperties"].get("description",'---')
                 usage = glossary["glossaryProperties"].get("usage",'---')
-                table.add_row(display_name, q_name, language, description, usage)
+
+                categories = m_client.get_categories_for_glossary(guid)
+                cat_md = ''
+                if type(categories) is list:
+                    for category in categories:
+                        cat_md += f"* {category['glossaryCategoryProperties'][('displayName')]}\n"
+                    cat_md = cat_md.strip()
+
+                table.add_row(display_name, q_name, language, description, usage, Markdown(cat_md))
 
             console.print(table)
 

{pyegeria-5.3.8.2 → pyegeria-5.3.8.4}/pyegeria/commands/cat/list_terms.py

@@ -189,7 +189,7 @@ def display_glossary_terms(
             )
             abbrev = Text(props.get("abbreviation", " "), style=style, justify="center")
             summary = Text(props.get("summary", " "), style=style)
-            description = Text(props.get("description", " "), style=style)
+            description = Markdown(props.get("description"))
             version = Text(
                 props.get("publishVersionIdentifier", " "),
                 style=style,
@@ -223,6 +223,7 @@ def display_glossary_terms(
                     category_list_md += f"* {category_name}\n"
             term_abb_ver_out = Markdown(f"{display_name}\n---\n{abbrev}\n---\n{version}")
             category_list_out = Markdown(category_list_md)
+
             term_status = term["elementHeader"].get("status","---")
             table.add_row(
                 term_abb_ver_out,