pyegeria 5.3.8.6__tar.gz → 5.3.8.9__tar.gz

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/PKG-INFO

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

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/__init__.py

@@ -11,24 +11,10 @@ the server platform and servers.
 
 """
 
-from ._globals import (
-    INTEGRATION_GUIDS,
-    TEMPLATE_GUIDS,
-    default_time_out,
-    disable_ssl_warnings,
-    enable_ssl_check,
-    is_debug,
-    max_paging_size,
-    NO_ELEMENTS_FOUND,
-    NO_ASSETS_FOUND,
-    NO_SERVERS_FOUND,
-    NO_CATALOGS_FOUND,
-    NO_GLOSSARIES_FOUND,
-    NO_TERMS_FOUND,
-    NO_CATEGORIES_FOUND,
-    NO_ELEMENT_FOUND,
-    NO_PROJECTS_FOUND,
-)
+from ._globals import (INTEGRATION_GUIDS, TEMPLATE_GUIDS, default_time_out, disable_ssl_warnings, enable_ssl_check,
+                       is_debug, max_paging_size, NO_ELEMENTS_FOUND, NO_ASSETS_FOUND, NO_SERVERS_FOUND,
+                       NO_CATALOGS_FOUND, NO_GLOSSARIES_FOUND, NO_TERMS_FOUND, NO_CATEGORIES_FOUND, NO_ELEMENT_FOUND,
+                       NO_PROJECTS_FOUND, )
 
 if disable_ssl_warnings:
     from urllib3 import disable_warnings
@@ -38,22 +24,10 @@ if disable_ssl_warnings:
 
 from ._client import Client
 from ._deprecated_gov_engine import GovEng
-from ._exceptions import (
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response,
-)
-from ._validators import (
-    is_json,
-    validate_guid,
-    validate_name,
-    validate_public,
-    validate_search_string,
-    validate_server_name,
-    validate_url,
-    validate_user_id,
-)
+from ._exceptions import (InvalidParameterException, PropertyServerException, UserNotAuthorizedException,
+                          print_exception_response, )
+from ._validators import (is_json, validate_guid, validate_name, validate_public, validate_search_string,
+                          validate_server_name, validate_url, validate_user_id, )
 from .asset_catalog_omvs import AssetCatalog
 from .automated_curation_omvs import AutomatedCuration
 from .classification_manager_omvs import ClassificationManager
@@ -69,16 +43,8 @@ from .feedback_manager_omvs import FeedbackManager
 from .full_omag_server_config import FullServerConfig
 from .glossary_browser_omvs import GlossaryBrowser
 from .glossary_manager_omvs import GlossaryManager
-from .mermaid_utilities import (
-    construct_mermaid_web,
-    construct_mermaid_jup,
-    generate_process_graph,
-    load_mermaid,
-    parse_mermaid_code,
-    render_mermaid,
-    save_mermaid_graph,
-    save_mermaid_html,
-)
+from .mermaid_utilities import (construct_mermaid_web, construct_mermaid_jup, generate_process_graph, load_mermaid,
+                                parse_mermaid_code, render_mermaid, save_mermaid_graph, save_mermaid_html, )
 from .metadata_explorer_omvs import MetadataExplorer
 from .my_profile_omvs import MyProfile
 from .platform_services import Platform
@@ -91,12 +57,13 @@ from .utils import body_slimmer, print_response
 from .valid_metadata_omvs import ValidMetadataManager
 from .x_action_author_omvs import ActionAuthor
 from .md_processing_utils import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
-                                  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_set_categories_parent_command,
-                                  process_term_list_command, process_glossary_list_command,process_category_list_command,
-                                  process_term_history_command,)
+                                  process_category_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_term_list_command,
+                                  process_glossary_list_command, process_category_list_command,
+                                  process_term_history_command, process_glossary_structure_command,
+                                  process_term_revision_history_command)
 
 #
 # The following assignments were generated by the `create_tech_guid_lists.py` utility that uses the pyegeria functions
@@ -482,6 +449,5 @@ INTEGRATION_GUIDS['OpenLineageCataloguer'] = '3347ac71-8dd2-403a-bc16-75a71be64b
 INTEGRATION_GUIDS['ApacheAtlasExchange'] = '5721627a-2dd4-4f95-a274-6cfb128edb97'
 INTEGRATION_GUIDS['HarvestSurveys'] = 'fae162c3-2bfd-467f-9c47-2e3b63a655de'
 
-
 if __name__ == "__main__":
     print("Main-Init")

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/commands/cat/Dr-Egeria_md-orig.py

@@ -13,8 +13,8 @@ from pyegeria.md_processing_utils import (extract_command, process_glossary_upse
 
 import click
 from pyegeria import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
-                      process_categories_upsert_command,
-                      get_current_datetime_string, process_per_proj_upsert_command, commands,EgeriaTech
+                      process_category_upsert_command,
+                      get_current_datetime_string, process_per_proj_upsert_command, commands, EgeriaTech
                       )
 from datetime import datetime
 
@@ -116,13 +116,13 @@ def process_markdown_file(
                 prov_found = True
                 result = process_provenance_command(file_path, block)
             elif potential_command in ["Create Glossary", "Update Glossary"]:
-                result = process_glossary_upsert_command(client, element_dictionary, block, directive)
+                result = process_glossary_upsert_command(client, block, directive)
             elif potential_command in ["Create Category", "Update Category"]:
-                result = process_categories_upsert_command(client, element_dictionary, block, directive)
+                result = process_category_upsert_command(client, block, directive)
             elif potential_command in ["Create Term", "Update Term"]:
-                result = process_term_upsert_command(client, element_dictionary, block, directive)
+                result = process_term_upsert_command(client, block, directive)
             elif potential_command in ["Create Personal Project", "Update Personal Project"]:
-                result = process_per_proj_upsert_command(client, element_dictionary, block, directive)
+                result = process_per_proj_upsert_command(client, block, directive)
             else:
                 # If command is not recognized, copy the block as-is
                 result = None

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/commands/cat/dr_egeria_jupyter.py

@@ -79,14 +79,12 @@ def process_jupyter_notebook(
                         potential_command = extract_command(cell.source)
                         if potential_command in command_list:
                             if potential_command in ["Create Glossary", "Update Glossary"]:
-                                result = process_glossary_upsert_command(client, element_dictionary,
-                                                                         cell.source, directive)
+                                result = process_glossary_upsert_command(client, cell.source, directive)
 
                             elif potential_command in ["Create Term", "Update Term"]:
-                                result = process_term_upsert_command(client, element_dictionary,
-                                                                     cell.source, directive)
+                                result = process_term_upsert_command(client, cell.source, directive)
                             elif potential_command in ["Create Personal Project", "Update Personal Project"]:
-                                result = process_per_proj_upsert_command(client, element_dictionary, cell.source, directive)
+                                result = process_per_proj_upsert_command(client, cell.source, directive)
                             else:
                                 # If command is not recognized, copy the block as-is
                                 result = None

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/commands/cat/dr_egeria_md.py

@@ -9,11 +9,12 @@ from rich import print
 from rich.console import Console
 
 from pyegeria import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
-                      process_categories_upsert_command, process_provenance_command,
-                      process_set_categories_parent_command, get_current_datetime_string,
+                      process_category_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, dr_egeria_state, process_term_list_command,
-                      process_category_list_command, process_glossary_list_command, process_term_history_command)
+                      process_category_list_command, process_glossary_list_command, process_term_history_command,
+                      process_glossary_structure_command, process_term_revision_history_command,)
 
 EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
 EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
@@ -86,39 +87,30 @@ def process_markdown_file(file_path: str, directive: str, server: str, url: str,
                 prov_found = True
 
             elif potential_command in ["Create Glossary", "Update Glossary"]:
-                result = process_glossary_upsert_command(client, dr_egeria_state.get_element_dictionary(),
-                                                         current_block, directive)
+                result = process_glossary_upsert_command(client, current_block, directive)
             elif potential_command in ["Create Category", "Update Category"]:
-                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)
+                result = process_category_upsert_command(client, current_block, directive)
             elif potential_command in ["Create Term", "Update Term"]:
-                result = process_term_upsert_command(client, dr_egeria_state.get_element_dictionary(), current_block,
-                                                     directive)
+                result = process_term_upsert_command(client, 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)
+                result = process_term_history_command(client, current_block, directive)
+            elif potential_command in ["List Term Update History", "List Term Revision History"]:
+                result = process_term_revision_history_command(client, 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)
+                result = process_term_list_command(client, 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)
+                result = process_category_list_command(client, current_block, directive)
+            elif potential_command in ["List Glossary Structure"]:
+                result = process_glossary_structure_command(client, current_block, directive)
             elif potential_command in ["List Glossaries"]:
-                result = process_glossary_list_command(client, dr_egeria_state.get_element_dictionary(), current_block,
-                                                     directive)
+                result = process_glossary_list_command(client, current_block, directive)
             elif potential_command in ["Create Personal Project", "Update Personal Project"]:
-                result = process_per_proj_upsert_command(client, dr_egeria_state.get_element_dictionary(),
-                                                         current_block, directive)
+                result = process_per_proj_upsert_command(client, 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)
+                result = process_blueprint_upsert_command(client, current_block, directive)
             elif potential_command in ["Create Solution Component", "Update Solution Component"]:
-                result = process_solution_component_upsert_command(client, dr_egeria_state.get_element_dictionary(),
-                                                                   current_block, directive)
+                result = process_solution_component_upsert_command(client, current_block, directive)
 
 
             else:

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/commands/cat/list_categories.py

@@ -136,7 +136,7 @@ def display_categories(
                 classification_props = category["elementHeader"]['classifications'][0].get('classificationProperties',None)
                 glossary_qualified_name = '---'
                 if classification_props is not None:
-                    glossary_guid = classification_props.get('anchorGUID','---')
+                    glossary_guid = classification_props.get('anchorScopeGUID','---')
                     glossary_qualified_name = (
                         m_client.get_glossary_by_guid(glossary_guid))['glossaryProperties']['qualifiedName']
                 cat_info = m_client.get_category_parent(category_guid)

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/commands/cat/list_terms.py

@@ -187,16 +187,16 @@ def display_glossary_terms(
             q_name = Text(
                 f"{qualified_name}\n&\n{term_guid}", style=style, justify="center"
             )
-            abbrev = Text(props.get("abbreviation", " "), style=style, justify="center")
-            summary = Text(props.get("summary", " "), style=style)
-            description = Markdown(props.get("description"))
+            abbrev = Text(props.get("abbreviation", "---"), style=style, justify="center")
+            summary = Text(props.get("summary", "---"), style=style)
+            description = Markdown(props.get("description",'---'))
             version = Text(
-                props.get("publishVersionIdentifier", " "),
+                props.get("publishVersionIdentifier", "---"),
                 style=style,
                 justify="center",
             )
-            example = props.get("example", " ")
-            usage = props.get("usage", " ")
+            example = props.get("example", "---")
+            usage = props.get("usage", "---")
             ex_us_out = Markdown(f"Example:\n{example}\n---\nUsage: \n{usage}")
 
             classifications = term["elementHeader"]["classifications"]

{pyegeria-5.3.8.6 → pyegeria-5.3.8.9}/pyegeria/glossary_browser_omvs.py

@@ -640,11 +640,11 @@ class GlossaryBrowser(Client):
             output_format (str): Output format (FORM, REPORT, LIST, etc.)
 
         Returns:
-            str: The parent category name or '---' if no parent
+            str: The parent category name or ' ' if no parent
         """
         parent_cat = self.get_category_parent(category_guid)
         if isinstance(parent_cat, str):
-            return '---'
+            return ' '
 
         # Return qualified name for FORM output, display name for REPORT and LIST output
         if output_format == 'FORM':
@@ -847,16 +847,21 @@ class GlossaryBrowser(Client):
         # Get parent category
         parent_cat_md = self._get_parent_category_name(category_guid, output_format)
 
-        # Get subcategories
-        _, subcategory_list_md = self._get_subcategories_list(category_guid, output_format)
-
         # Get glossary information
         glossary_qualified_name = self._get_glossary_name_for_element(element, output_format)
 
-        return {
-            'in_glossary': glossary_qualified_name, 'parent_category': parent_cat_md,
-            'subcategories': subcategory_list_md
-            }
+        # Only include subcategories if output_format is not FORM, REPORT, or MD
+        if output_format not in ['FORM', 'REPORT', 'MD']:
+            # Get subcategories
+            _, subcategory_list_md = self._get_subcategories_list(category_guid, output_format)
+            return {
+                'in_glossary': glossary_qualified_name, 'parent_category': parent_cat_md,
+                'subcategories': subcategory_list_md
+                }
+        else:
+            return {
+                'in_glossary': glossary_qualified_name, 'parent_category': parent_cat_md
+                }
 
     def _generate_category_md(self, elements: list, elements_action: str, output_format: str) -> str:
         """
@@ -1528,6 +1533,7 @@ class GlossaryBrowser(Client):
 
         return response.json().get("elementList", "No categories found")
 
+
     def get_glossary_subcategories(self, glossary_category_guid: str, effective_time: str = None, start_from: int = 0,
             page_size: int = max_paging_size, for_lineage: bool = False,
             for_duplicate_processing: bool = False, ) -> dict | str:
@@ -1979,8 +1985,8 @@ class GlossaryBrowser(Client):
             self._async_get_categories_by_name(name, glossary_guid, status, start_from, page_size))
         return response
 
-    async def _async_get_categories_by_guid(self, glossary_category_guid: str, effective_time: str = None,
-            output_format: str = 'JSON', ) -> list | str:
+    async def _async_get_category_by_guid(self, glossary_category_guid: str, effective_time: str = None,
+                                          output_format: str = 'JSON', ) -> list | str:
         """Retrieve the requested glossary category metadata element.  The optional request body contain an effective
         time for the query..
 
@@ -2035,8 +2041,8 @@ class GlossaryBrowser(Client):
             return self.generate_categories_md(element, "GUID", output_format)
         return response.json().get("element", NO_CATEGORIES_FOUND)
 
-    def get_categories_by_guid(self, glossary_category_guid: str, effective_time: str = None,
-            output_format: str = 'JSON', ) -> list | str:
+    def get_category_by_guid(self, glossary_category_guid: str, effective_time: str = None,
+                             output_format: str = 'JSON', ) -> list | str:
         """Retrieve the requested glossary category metadata element.  The optional request body contain an effective
         time for the query..
 
@@ -2074,7 +2080,7 @@ class GlossaryBrowser(Client):
         """
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_categories_by_guid(glossary_category_guid, effective_time, output_format))
+            self._async_get_category_by_guid(glossary_category_guid, effective_time, output_format))
         return response
 
     async def _async_get_category_parent(self, glossary_category_guid: str, effective_time: str = None, ) -> list | str:
@@ -3101,6 +3107,109 @@ class GlossaryBrowser(Client):
 
         return response
 
+    def list_term_revision_history(self, term_guid: str, output_format: str = "DICT") -> list | str:
+        """
+        Retrieve the revision history for a term.
+
+        This method retrieves the revision logs associated with a term, and for each revision log,
+        retrieves the revision history. The results are formatted according to the specified output format.
+
+        Parameters
+        ----------
+        term_guid : str
+            The GUID of the glossary term to retrieve the revision history for.
+        output_format : str, optional
+            The format in which to return the results. Can be "DICT", "MD", or "LIST".
+            Defaults to "DICT".
+
+        Returns
+        -------
+        list | str
+            If output_format is "DICT", returns a list of dictionaries containing the revision history.
+            If output_format is "MD", returns a markdown representation of the revision history.
+            If output_format is "LIST", returns a markdown table of the revision history.
+            If no revision logs are found, returns a string message "No revision logs found".
+        """
+        import re
+        validate_guid(term_guid)
+
+        # Get revision logs for the term
+        revision_logs = self.get_term_revision_logs(term_guid)
+        if isinstance(revision_logs, str):
+            return "No revision logs found"
+
+        # Process each revision log
+        all_entries = []
+        for log in revision_logs:
+            log_guid = log['elementHeader']['guid']
+            qualified_name = log.get('properties', {}).get('qualifiedName', '---')
+
+            # Get revision history for this log
+            history = self.get_term_revision_history(log_guid)
+            if isinstance(history, str):
+                continue
+
+            # Process each entry in the history
+            for entry in history:
+                # Extract update time from the title
+                title = entry.get('properties', {}).get('title', '---')
+
+                keyword_index = title.index('on')
+                update_time = title[keyword_index + 2:].strip()
+
+                entry_data = {
+                    'qualifiedName': qualified_name,
+                    'title': title,
+                    'text': entry.get('properties', {}).get('text', '---'),
+                    'updateTime': update_time  # Use extracted date/time or fall back to title
+                }
+                all_entries.append(entry_data)
+
+        # Sort entries by update time
+        sorted_entries = sorted(all_entries, key=lambda x: x['updateTime'] if x['updateTime'] != '---' else '', reverse=True)
+
+        # Return in the specified format
+        if output_format == "DICT":
+            return sorted_entries
+        elif output_format == "LIST":
+            # Create markdown table
+            if not sorted_entries:
+                return "No revision entries found"
+
+            # Get headers
+            headers = sorted_entries[0].keys()
+
+            # Create header row
+            header_row = " | ".join(headers)
+            separator_row = " | ".join(["---"] * len(headers))
+
+            # Create rows
+            rows = []
+            for entry in sorted_entries:
+                row = " | ".join(str(entry.get(header, "---")) for header in headers)
+                rows.append(row)
+
+            # Combine into table
+            markdown_table = f"{header_row}\n{separator_row}\n" + "\n".join(rows)
+            return markdown_table
+        elif output_format == "MD":
+            # Create markdown representation
+            if not sorted_entries:
+                return "No revision entries found"
+
+            md_output = "\n"
+
+            for entry in sorted_entries:
+                md_output += f"* Note Log Name: \n{entry['qualifiedName']}\n\n"
+                md_output += f"* Note Log Entry Title: \n{entry['title']}\n\n"
+                md_output += f"* Note Log Entry: \n\t{entry['text']}\n\n"
+                md_output += "---\n\n"
+
+            return md_output
+        else:
+            # Default to DICT format
+            return sorted_entries
+
 
     def list_full_term_history(self, term_guid: str, output_type: str = "DICT") -> list | str:
         """
@@ -3132,19 +3241,19 @@ class GlossaryBrowser(Client):
             return "No History Found"
         version_history = []
         for ver in history:
-            create_time = ver["elementHeader"]["versions"].get("createTime", "---")
-            update_time = ver["elementHeader"]["versions"].get("createTime", "---")
-            created_by = ver["elementHeader"]["versions"].get("createdBy", "---")
+            create_time = ver["elementHeader"]["versions"].get("createTime", " ")
+            update_time = ver["elementHeader"]["versions"].get("createTime", " ")
+            created_by = ver["elementHeader"]["versions"].get("createdBy", " ")
             updated_by = ver["elementHeader"]["versions"].get("updatedBy", "---")
             version = ver["elementHeader"]["versions"].get("version")
 
-            qualified_name = ver["glossaryTermProperties"].get("qualifiedName", '---')
-            display_name = ver["glossaryTermProperties"].get("displayName", '---')
-            summary = ver["glossaryTermProperties"].get("summary", '---')
-            description = ver["glossaryTermProperties"].get("description", '---')
-            examples = ver["glossaryTermProperties"].get("examples", '---')
-            usage = ver["glossaryTermProperties"].get("usage", '---')
-            version_identifier = ver["glossaryTermProperties"].get("versionIdentifier", '---')
+            qualified_name = ver["glossaryTermProperties"].get("qualifiedName", ' ')
+            display_name = ver["glossaryTermProperties"].get("displayName", ' ')
+            summary = ver["glossaryTermProperties"].get("summary", ' ')
+            description = ver["glossaryTermProperties"].get("description", ' ')
+            examples = ver["glossaryTermProperties"].get("examples", ' ')
+            usage = ver["glossaryTermProperties"].get("usage", ' ')
+            version_identifier = ver["glossaryTermProperties"].get("versionIdentifier", ' ')
 
             version_history.append({
                 "version": version, "displayName": display_name, "summary": summary, "created": create_time,
@@ -3172,6 +3281,8 @@ class GlossaryBrowser(Client):
             # Combine everything into a Markdown table string
             markdown_table = f"{header_row}\n{separator_row}\n" + "\n".join(rows)
             return markdown_table
+        else:
+            return None
 
     async def _async_find_glossary_terms(self, search_string: str, glossary_guid: str = None, status_filter: list = [],
             effective_time: str = None, starts_with: bool = False, ends_with: bool = False, ignore_case: bool = False,