pyegeria 5.4.0.dev13__py3-none-any.whl → 5.4.0.dev14__py3-none-any.whl

md_processing/md_processing_utils/extraction_utils.py

@@ -412,7 +412,7 @@ def get_element_by_name(egeria_client, element_type: str, element_name: str) ->
                 return q_name, guid, unique, exists
 
     # Haven't seen this element before
-    property_names = ['qualifiedName', 'name', 'displayName']
+    property_names = ['qualifiedName', 'name', 'displayName', 'title']
     open_metadata_type_name = None
     details = egeria_client.get_elements_by_property_value(element_name, property_names, open_metadata_type_name)
     if isinstance(details, str):

md_processing/md_processing_utils/generate_dr_help.py

@@ -4,6 +4,7 @@ This file contains general utility functions for processing Egeria Markdown
 import json
 import os
 import sys
+from datetime import datetime
 from typing import List
 
 from loguru import logger
@@ -45,6 +46,10 @@ full_file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_INBOX_PATH, "data_designe
 #            colorize=True)
 logger.add("debug_log", rotation="1 day", retention="1 week", compression="zip", level="TRACE", format=log_format,
            colorize=True)
+def get_iso8601_datetime():
+    """Returns the current date and time in ISO 8601 format."""
+    return datetime.now().strftime('%Y-%m-%dT%H:%M:%S')
+
 def yes_no(input: str)->str:
     if type(input) is bool:
         if input:
@@ -116,7 +121,10 @@ def create_help_terms():
 
     term_entry = """# Generating glossary entries for the documented commands\n\n
             This file contains generated Dr.Egeria commands to generate glossary term entries describing
-            each command represented in the `commands.json` file.\n"""
+            each Dr.Egeria command. 
+
+> Usage: Before executing this file, make sure you have a glossary named `Egeria-Markdown`
+> already created. If you Need to create one, you can use the \n"""
 
     for command, values in commands.items():
         if command == "exported":
@@ -127,7 +135,7 @@ def create_help_terms():
         command_verb = commands[command].get("verb","")
 
         term_entry+= "# Create Term\n"
-        term_entry+= f"## Term Name\n\n{command_verb} {command}\n\n"
+        term_entry+= f"## Term Name\n\n{command}\n\n"
         term_entry+= f"## Description\n\n{command_description}\n\n"
         term_entry+= f"## Owning Glossary\n\n{glossary_name}\n\n"
         term_entry+= f"## Categories\n\nWriting Dr.Egeria Markdown\n\n"
@@ -138,13 +146,20 @@ def create_help_terms():
 
         term_entry+= f"## Usage\n\n{output}\n\n___\n\n"
     print(term_entry)
-    file_path =  os.path.join(EGERIA_ROOT_PATH, EGERIA_INBOX_PATH, "generated_help_terms.md")
-    with open(file_path, 'a', encoding="utf-8") as f:
+    # Generate filename with current date and time in ISO 8601 format
+    current_datetime = get_iso8601_datetime()
+    filename = f"dr-egeria-help-{current_datetime}.md"
+    file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_INBOX_PATH, filename)
+
+    # Write the content to the file
+    with open(file_path, 'w', encoding="utf-8") as f:
         f.write(term_entry)
 
+    logger.info(f"Help documentation saved to {file_path}")
+
 def main():
     create_help_terms()
 
 
 if __name__ == "__main__":
-    main()
+    main()

md_processing/md_processing_utils/generate_md_cmd_templates.py

@@ -0,0 +1,143 @@
+"""
+This file contains general utility functions for processing Egeria Markdown
+"""
+import os
+import sys
+from typing import List, Dict
+import io
+
+from loguru import logger
+from rich import print
+from rich.console import Console
+
+from commands.cat.dr_egeria_command_help import EGERIA_INBOX_PATH
+from md_processing.md_processing_utils.common_md_utils import (get_current_datetime_string, get_element_dictionary,
+                                                               update_element_dictionary,
+                                                               split_tb_string, str_to_bool, )
+from md_processing.md_processing_utils.extraction_utils import (process_simple_attribute, extract_attribute,
+                                                                get_element_by_name)
+from md_processing.md_processing_utils.md_processing_constants import (get_command_spec, load_commands, load_commands, COMMAND_DEFINITIONS)
+
+from md_processing.md_processing_utils.message_constants import (ERROR, INFO, WARNING, ALWAYS, EXISTS_REQUIRED)
+from pyegeria import EgeriaTech
+from pyegeria._globals import DEBUG_LEVEL
+
+
+# Constants
+EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
+EGERIA_ROOT_PATH = os.environ.get("EGERIA_ROOT_PATH", ".")
+EGERIA_INBOX_PATH = os.environ.get("EGERIA_INBOX_PATH", ".")
+
+console = Console(width=EGERIA_WIDTH)
+
+debug_level = DEBUG_LEVEL
+global COMMAND_DEFINITIONS
+
+load_commands('commands.json')
+
+
+log_format = "D {time} | {level} | {function} | {line} | {message} | {extra}"
+logger.remove()
+logger.add(sys.stderr, level="INFO", format=log_format, colorize=True)
+full_file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_INBOX_PATH, "data_designer_debug.log")
+# logger.add(full_file_path, rotation="1 day", retention="1 week", compression="zip", level="TRACE", format=log_format,
+#            colorize=True)
+logger.add("debug_log", rotation="1 day", retention="1 week", compression="zip", level="TRACE", format=log_format,
+           colorize=True)
+@logger.catch
+def main():
+    """
+    Generate markdown command templates organized by family
+    """
+    glossary_name = "Egeria-Markdown"
+    commands = COMMAND_DEFINITIONS["Command Specifications"]
+
+    # Create base output directory if it doesn't exist
+    base_output_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)), "..", "family_docs")
+    os.makedirs(base_output_dir, exist_ok=True)
+
+    # Group commands by family
+    families = {}
+    for command, values in commands.items():
+        if command == "exported":
+            continue
+        if values.get("level", "") not in ["Basic"]:
+            continue
+
+        family = values.get("family", "Other")
+        if family not in families:
+            families[family] = []
+
+        families[family].append(command)
+
+    # Process each family
+    for family, command_list in sorted(families.items()):
+        # Create a folder for each family
+        family_dir = os.path.join(base_output_dir, family)
+        os.makedirs(family_dir, exist_ok=True)
+
+        print(f"\n# Family: {family}\n")
+
+        # Process each command in the family
+        for command in sorted(command_list):
+            values = commands[command]
+            command_description = values.get("description", "")
+            command_verb = values.get("verb", "")
+
+            # Create a string buffer for the command's output
+            command_output = io.StringIO()
+
+            # Write command header
+            command_output.write(f"# **{command}**\n>\t{command_description}\n")
+            print(f"\n## {command_verb} **{command}**\n>\t{command_description}")
+
+            # Process command attributes
+            attributes = values['Attributes']
+            for attribute in attributes:
+                for key, value in attribute.items():
+                    if value.get('level', "") not in ["Basic"]:
+                        continue
+                    user_specified = value.get('user_specified', 'true') in ["true", "True"]
+
+                    command_output.write(f"\n## **{key}**\n")
+                    print(f"\n### **{key}**")
+
+                    command_output.write(f">\t**Input Required**: {value.get('input_required', 'false')}\n\n")
+                    print(f">\tInput Required: {value.get('input_required', 'false')}")
+
+                    command_output.write(f">\t**Description**: {value.get('description', '')}\n\n")
+                    print(f">\tDescription: {value.get('description', '')}")
+
+                    labels = value.get("attr_labels", None)
+                    if labels:
+                        command_output.write(f">\t**Alternative Labels**: {labels}\n\n")
+                        print(f">\tAlternative Labels: {labels}")
+
+                    valid_values = value.get("valid_values", None)
+                    if valid_values:
+                        command_output.write(f">\t**Valid Values**: {valid_values}\n\n")
+                        print(f">\tValid Values: {valid_values}")
+
+                    default_value = value.get("default_value", None)
+                    if default_value:
+                        command_output.write(f">\t**Default Value**: {default_value}\n\n")
+                        print(f">\tDefault Value: {default_value}")
+
+            # Save the command to its own file in the family directory
+            # Use a sanitized version of the command name for the filename
+            command_filename = command.replace(" ", "_").replace(":", "").replace("/", "_")
+            command_file_path = os.path.join(family_dir, f"{command_filename}.md")
+
+            with open(command_file_path, 'w') as f:
+                f.write(command_output.getvalue())
+
+            logger.info(f"Saved command documentation to {command_file_path}")
+            print("\n___\n")
+
+
+
+
+    #
+
+if __name__ == "__main__":
+    main()

md_processing/md_processing_utils/md_processing_constants.py

@@ -47,6 +47,30 @@ TERM_RELATIONSHPS = ["Synonym", "Translation", "PreferredTerm", "TermISATYPEOFRe
                      "ISARelationship"]
 
 # List of supported md_commands
+GOV_LINK_LIST = [ "Link Governance Drivers", "Detach Governance Drivers",
+                "Link Governance Policies", "Detach Governance Policies",
+                "Link Governance Controls", "Detach Governance Controls",]
+
+GOV_COM_LIST = [ "Create Business Imperative", "Update Business Imperative",
+                "Create Regulation Article Definition", "Update Regulation Article Definition",
+                "Create Threat Definition", "Update Threat Definition",
+                "Create Governance Principle", "Update Governance Principle",
+                "Create Governance Obligation", "Update Governance Obligation",
+                "Create Governance Approach", "Update Governance Approach",
+                "Create Governance Strategy", "Update Governance Strategy",
+                "Create Regulation", "Create Regulation Definition", "Update Regulation", "Update Regulation Definition",
+                "Create Governance Control:", "Update Governance Control",
+                "Create Governance Rule:", "Update Governance Rule",
+                "Create Service Level Objective", "Update Service Level Objective",
+                "Create Governance Process", "Update Governance Process",
+                "Create Governance Responsibility", "Update Governance Responsibility",
+                "Create Governance Procedure", "Update Governance Procedure",
+                "Create Security Access Control", "Update Security Access Control",
+                "Create Security Group", "Update Security Group",
+                "Create Naming Standard Rule", "Update Naming Standard Rule",
+                "Create Certification Type", "Update Certification Type",
+                "Create License Type", "Update License Type",]
+
 command_list = ["Provenance", "Create Glossary", "Update Glossary", "Create Term", "Update Term", "List Terms",
                 "List Term Details", "List Glossary Terms", "List Term History", "List Term Revision History",
                 "List Term Update History", "List Glossary Structure", "List Glossaries", "List Categories",
@@ -67,8 +91,7 @@ command_list = ["Provenance", "Create Glossary", "Update Glossary", "Create Term
                 "View Data Specs", "View Data Structures", "View Data Structure", "View Data Fields", "View Data Field",
                 "View Dataa Classes", "View Data Class", "Create Data Class", "Update Data Class",
                 "Create Digital Product", "Create Data Product", "Update Digital Product", "Update Data Product",
-                "Create Agreement", "Create Digital Agreement", "Create Data Agreement",
-                "Update Agreement", "Update Data Agreement", "Update Data Agreement",
+                "Create Agreement", "Update Agreement",
                 "Link Digital Products", "Link Data Products", "Detach Digital Products", "Detach Data Products",
                 "Create Data Sharing Agreement", "Update Data Sharing Agreement",
                 "Create Digital Subscription", "Create Product Subscription", "Update Digital Subscription", "Update Product Subscription",
@@ -81,8 +104,37 @@ command_list = ["Provenance", "Create Glossary", "Update Glossary", "Create Term
                 "Remove Member from Collection","Remove Member from Collection",
                 "View Digital Products", "View Data Products", "List Data Products", "List Digtal Products",
                 "View Agreements", "View Data Sharing Agreements", "List Agreements", "List Data Sharing Agreements",
-                "View Subscriptions", "List Subscriptions",]
-
+                "View Subscriptions", "List Subscriptions", "View Governance Definitions", "View Gov Definitions",
+                 "List Governance Definitions", "List Gov Definitions",
+                "View Governance Definition Context","List Governance Definition Context",
+                "View Governance Def Context", "List Governance Def Context",
+                # "Create Business Imperative", "Update Business Imperative",
+                # "Create Regulation Article Definition", "Update Regulation Article Definition",
+                # "Create Threat Definition", "Update Threat Definition",
+                # "Create Governance Principle", "Update Governance Principle",
+                # "Create Governance Obligation", "Update Governance Obligation",
+                # "Create Governance Approach", "Update Governance Approach",
+                # "Create Governance Strategy", "Update Governance Strategy",
+                # "Create Regulation", "Create Regulation Definition", "Update Regulation", "Update Regulation Definition",
+                # "Create Governance Control:", "Update Governance Control",
+                # "Create Governance Rule:", "Update Governance Rule",
+                # "Create Service Level Objective", "Update Service Level Objective",
+                # "Create Governance Process", "Update Governance Process",
+                # "Create Governance Responsibility", "Update Governance Responsibility",
+                # "Create Governance Procedure", "Update Governance Procedure",
+                # "Create Security Access Control", "Update Security Access Control",
+                # "Create Security Group", "Update Security Group",
+                # "Create Naming Standard Rule", "Update Naming Standard Rule",
+                # "Create Certification Type", "Update Certification Type",
+                # "Create License Type", "Update License Type",
+                # "Link Governance Drivers", "Detach Governance Drivers",
+                # "Link Governance Policies", "Detach Governance Policies",
+                # "Link Governance Controls", "Detach Governance Controls",
+
+                ]
+
+command_list.extend(GOV_COM_LIST)
+command_list.extend(GOV_LINK_LIST)
 
 pre_command = "\n---\n==> Processing object_action:"
 command_seperator = Markdown("\n---\n")

pyegeria/governance_officer_omvs.py

@@ -127,25 +127,6 @@ class GovernanceOfficer(Client):
     #
     #
 
-    def _extract_gov_def_list(self, element: Union[Dict, List[Dict]]) -> List[Dict]:
-        """
-        Normalize governance definition response for a list of dictionaries.
-        Args:
-            element: Dict or List
-
-        Returns:
-            list of Dict
-
-        """
-        if isinstance(element, dict):
-            return [self._extract_gov_def_properties(element)]
-        elif isinstance(element, list):
-            comp_list = []
-            for i in range(len(element)):
-                comp_list.append(self._extract_gov_def_properties(element[i]))
-            return comp_list
-        else:
-            return []
 
     def _extract_gov_def_properties(self, element: dict) -> dict:
         """
@@ -160,6 +141,8 @@ class GovernanceOfficer(Client):
         guid = element['elementHeader'].get("guid", None)
         properties = element['properties']
         properties['GUID'] = guid
+        mermaid = element.get('mermaidGraph', "") or ""
+        properties['Mermaid'] = mermaid
         del properties['class']
 
         #
@@ -179,72 +162,6 @@ class GovernanceOfficer(Client):
 
         return properties
 
-    def _extract_solution_blueprint_properties(self, element: dict) -> dict:
-        """
-        Extract properties from a solution blueprint element.
-
-        Args:
-            element: Dictionary containing element data
-
-        Returns:
-            Dictionary with extracted properties
-        """
-        guid = element['elementHeader'].get("guid", None)
-        element_properties = element['properties']
-        display_name = element_properties.get("displayName", None)
-        description = element_properties.get("description", None)
-        version = element_properties.get("version", None)
-        qualified_name = element_properties.get("qualifiedName", None)
-
-        solution_components = element.get('solutionComponents', None)
-        solution_components_md = ""
-        if solution_components:
-            for solution_component in solution_components:
-                sol_comp_prop = solution_component['solutionComponent']['properties']
-                sol_comp_name = sol_comp_prop.get("displayName", None)
-                sol_comp_desc = sol_comp_prop.get("description", None)
-                solution_components_md += '{' + f" {sol_comp_name}:\t {sol_comp_desc}" + " },\n"
-
-        return {
-            'guid': guid, 'qualified_name': qualified_name, 'display_name': display_name, 'description': description,
-            'version': version, 'solution_components': solution_components_md
-            }
-
-    def _extract_solution_roles_properties(self, element: dict) -> dict:
-        """
-        Extract properties from a solution role element.
-
-        Args:
-            element: Dictionary containing element data
-
-        Returns:
-            Dictionary with extracted properties
-        """
-        guid = element['elementHeader'].get("guid", None)
-        element_properties = element['properties']
-        display_name = element_properties.get("title", None)
-        role_id = element_properties.get("roleId", None)
-        scope = element_properties.get("scope", None)
-        description = element_properties.get("description", None)
-        domain_identifier = element_properties.get("domainIdentifier", None)
-        qualified_name = element_properties.get("qualifiedName", None)
-
-        solution_components = element.get('solutionComponents', None)
-        solution_components_md = ""
-        if solution_components:
-            for solution_component in solution_components:
-                sol_comp_prop = solution_component.get('relationshipProperties', None)
-                if sol_comp_prop:
-                    sol_comp_name = sol_comp_prop.get("role", None)
-                    sol_comp_desc = sol_comp_prop.get("description", None)
-                    solution_components_md += "{" + f" {sol_comp_name}:\t {sol_comp_desc}" + " },\n"
-
-        return {
-            'guid': guid, 'qualified_name': qualified_name, 'display_name': display_name, 'description': description,
-            'role_id': role_id, 'scope': scope, 'domain_identifier': domain_identifier,
-            'solution_components': solution_components_md
-            }
-
     def _extract_gov_def_list(self, element: Union[Dict, List[Dict]]) -> List[Dict]:
         """
         Normalize for a list of dictionaries.
@@ -256,7 +173,7 @@ class GovernanceOfficer(Client):
 
         """
         if isinstance(element, dict):
-            return [self._extract_solution_components_properties(element)]
+            return [self._extract_gov_def_properties(element)]
         elif isinstance(element, list):
             def_list = []
             for i in range(len(element)):
@@ -1048,7 +965,7 @@ class GovernanceOfficer(Client):
 
         url = (
             f"{self.platform_url}/s"
-            f"ervers/{self.view_server}/api/open-metadata/goverance-officer/governance-definitions/"
+            f"ervers/{self.view_server}/api/open-metadata/governance-officer/governance-definitions/"
             f"{definition_guid1}/peer-definitions/{relationship_type}/{definition_guid2}/attach")
 
         await self._async_make_request("POST", url, body_slimmer(body))
@@ -1210,7 +1127,7 @@ class GovernanceOfficer(Client):
                                                    definition_guid2: str, body: dict = None) -> None:
         """ Attach a supporting governance definition. Request body is optional.
             The relationshipTypeNme can be:
-            * GovernanceResponse between governance drivers (GovernanceStrategy, BusinessImperitive, Regulation,
+            * GovernanceResponse between governance drivers (GovernanceStrategy, BusinessImperative, Regulation,
             RegulationArticle, Threat) and governance policies (GovernancePrinciple, GovernanceObligation,
             GovernanceApproach).
             * GovernanceImplementation between governance policies (GovernancePrinciple, GovernanceObligation,
@@ -1276,7 +1193,7 @@ class GovernanceOfficer(Client):
                                       body: dict = None) -> None:
         """ Attach a supporting governance definition. Request body is optional.
             The relationshipTypeNme can be:
-            * GovernanceResponse between governance drivers (GovernanceStrategy, BusinessImperitive, Regulation,
+            * GovernanceResponse between governance drivers (GovernanceStrategy, BusinessImperative, Regulation,
             RegulationArticle, Threat) and governance policies (GovernancePrinciple, GovernanceObligation,
             GovernanceApproach).
             * GovernanceImplementation between governance policies (GovernancePrinciple, GovernanceObligation,
@@ -2275,7 +2192,7 @@ class GovernanceOfficer(Client):
 
         await self._async_make_request("POST", url, body_slimmer(body))
 
-    def detach_implmentation_resource(self, design_desc_guid: str, implementation_guid: str, body: dict = None) -> None:
+    def detach_implementation_resource(self, design_desc_guid: str, implementation_guid: str, body: dict = None) -> None:
         """ Detach a design object such as a solution component or governance definition from one of its implementation
             resources. Request body is optional.
 
@@ -2317,9 +2234,9 @@ class GovernanceOfficer(Client):
         loop = asyncio.get_event_loop()
         loop.run_until_complete(self._async_detach_implementation_resource(design_desc_guid, implementation_guid, body))
 
-    async def _async_get_gov_def_in_context(self, guid: str, body: dict, output_format: str, start_from: int = 0,
+    async def _async_get_gov_def_in_context(self, guid: str, body: dict = None, output_format: str = "JSON", start_from: int = 0,
                                             page_size: int = 0) -> list[dict] | str:
-        """ Get governance definition in context.
+        """ Get governance definition in context. Brings back the graph.
             Async version.
 
             Parameters
@@ -2382,16 +2299,14 @@ class GovernanceOfficer(Client):
         else:
             response = await self._async_make_request("POST", url)
 
-        element = response.json().get("elements", NO_ELEMENTS_FOUND)
-        if element == NO_ELEMENTS_FOUND:
-            return NO_ELEMENTS_FOUND
+        element = response.json().get("element", NO_ELEMENTS_FOUND)
         if output_format != 'JSON':  # return a simplified markdown representation
-            return self.generate_governance_definitions_output(element, guid, output_format)
-        return response.json().get("elements", NO_ELEMENTS_FOUND)
+            return self.generate_governance_definition_output(element, "", output_format)
+        return response.json().get("element", NO_ELEMENTS_FOUND)
 
-    def get_gov_def_in_context(self, guid: str, body: dict, output_format: str, start_from: int = 0,
+    def get_gov_def_in_context(self, guid: str, body: dict = None, output_format: str = "JSON", start_from: int = 0,
                                page_size: int = 0) -> list[dict] | str:
-        """ Get governance definition in context.
+        """ Get governance definition in context. Brings back the graph.
 
             Parameters
             ----------

pyegeria/output_formatter.py

@@ -1,7 +1,7 @@
 from datetime import datetime
 import re
 from typing import Any, Callable, Dict, List, Optional, Tuple, Union
-
+from pyegeria.utils import (camel_to_title_case)
 from markdown_it import MarkdownIt
 from rich.console import Console
 
@@ -126,7 +126,8 @@ def make_md_attribute(attribute_name: str, attribute_value: str, output_type: st
         if attribute_name.upper() == "GUID":
             attribute_title = attribute_name.upper()
         else:
-            attribute_title = attribute_name.title()
+            # attribute_title = attribute_name.title()
+            attribute_title = camel_to_title_case(attribute_name)
     else:
         attribute_title = ""
 

pyegeria/utils.py

@@ -205,6 +205,13 @@ def body_slimmer(body: dict) -> dict:
                 slimmed[key] = value
     return slimmed
 
+import re
+
+def camel_to_title_case(input_string):
+    # Add a space before uppercase letters and capitalize each word
+    result = re.sub(r'([a-z])([A-Z])', r'\1 \2', input_string).title()
+    return result
+
 
 if __name__ == "__main__":
     print("Main-Utils")

{pyegeria-5.4.0.dev13.dist-info → pyegeria-5.4.0.dev14.dist-info}/METADATA

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