pyegeria 5.4.8.2__py3-none-any.whl → 5.4.8.4__py3-none-any.whl

md_processing/dr_egeria.py

@@ -8,16 +8,13 @@ from datetime import datetime
 from loguru import logger
 from pydantic import ValidationError
 
-from .md_commands.project_commands import process_link_project_dependency_command
+from md_processing.md_commands.project_commands import process_link_project_dependency_command
+
 
-log_format = "{time} | {level} | {function} | {line} | {message} | {extra}"
-logger.remove()
-logger.add(sys.stderr, level="ERROR", format=log_format, colorize=True)
-logger.add("debug_log.log", rotation="1 day", retention="1 week", compression="zip", level="INFO", format=log_format,
-           colorize=True)
 
 from rich import print
 from rich.console import Console
+from md_processing.md_commands.product_manager_commands import process_csv_element_upsert_command
 
 from md_processing import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
                            process_provenance_command, get_current_datetime_string,
@@ -69,6 +66,11 @@ 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")
 
+log_format = "{time} | {level} | {function} | {line} | {message} | {extra}"
+logger.remove()
+logger.add(sys.stderr, level="ERROR", format=log_format, colorize=True)
+logger.add("debug_log.log", rotation="1 day", retention="1 week", compression="zip", level="INFO", format=log_format,
+           colorize=True)
 
 @logger.catch
 def process_md_file(input_file: str, output_folder:str, directive: str, server: str, url: str, userid: str,

md_processing/md_commands/solution_architect_commands.py

@@ -1,8 +1,10 @@
 """
 This file contains blueprint/solution-related object_action functions for processing Egeria Markdown
 """
+
 import json
 import sys
+from datetime import datetime
 from typing import Optional
 
 from loguru import logger
@@ -13,7 +15,7 @@ from rich.markdown import Markdown
 
 from md_processing.md_processing_utils.common_md_proc_utils import (parse_upsert_command, parse_view_command)
 from md_processing.md_processing_utils.common_md_utils import update_element_dictionary, set_element_prop_body, \
-    set_update_body, set_create_body
+    set_update_body, set_create_body, add_search_keywords, add_note_in_dr_e
 from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, update_a_command)
 from md_processing.md_processing_utils.md_processing_constants import (load_commands)
 from pyegeria import body_slimmer, EgeriaTech, PyegeriaException, print_basic_exception
@@ -68,7 +70,7 @@ def sync_chain_related_elements(egeria_client: EgeriaTech, guid:str, in_supply_c
 @logger.catch
 def sync_component_related_elements(egeria_client: EgeriaTech, object_type: str,
                                     supply_chain_guids: list, parent_component_guids: list,
-                                    actor_guids: list, in_blueprint_guids: list, guid: str, qualified_name: str,
+                                    actor_guids: list, in_blueprint_guids: list, keywords: list[str], guid: str, qualified_name: str,
                                     display_name: str, merge_update: bool = True) -> None:
     """Sync a components related elements.
 
@@ -81,12 +83,15 @@ def sync_component_related_elements(egeria_client: EgeriaTech, object_type: str,
         as_is_blueprints = set(rel_el_list.get("blueprint_guids", []))
         as_is_parent_components = set(rel_el_list.get("parent_component_guids", []))
         as_is_supply_chains = set(rel_el_list.get("supply_chain_guids", []))
+        as_is_keywords_list = set(rel_el_list.get("keywords_list", {}))
+        as_is_keywords = set(rel_el_list.get("keywords_list", {}).keys())
 
 
         to_be_actors = set(actor_guids) if actor_guids is not None else set()
         to_be_blueprints = set(in_blueprint_guids) if in_blueprint_guids is not None else set()
         to_be_parent_components = set(parent_component_guids) if parent_component_guids is not None else set()
         to_be_supply_chains = set(supply_chain_guids) if supply_chain_guids is not None else set()
+        to_be_keywords_list = set(keywords) if keywords is not None else set()
 
 
         logger.trace(
@@ -94,6 +99,22 @@ def sync_component_related_elements(egeria_client: EgeriaTech, object_type: str,
         logger.trace(f"as_is_actors: {list(as_is_actors)} to_be_actors: {list(to_be_actors)}")
         logger.trace(f"as_is_blueprints: {list(as_is_blueprints)} to_be_blueprints: {list(to_be_blueprints)}")
 
+        keywords_to_add = to_be_keywords_list - as_is_keywords
+        logger.trace(f"keywords_to_add: {list(keywords_to_add)}")
+        if len(keywords_to_add) > 0:
+            for ds in keywords_to_add:
+                egeria_client.add_search_keyword_to_element(guid, ds)
+                msg = f"Added `{ds}` to component `{guid}`"
+                logger.trace(msg)
+
+        keywords_to_remove = as_is_keywords_list - to_be_keywords_list
+        logger.trace(f"keyword_to_remove: {list(keywords_to_remove)}")
+        if len(keywords_to_remove) > 0:
+            for ds in keywords_to_remove: ## change structure of get related elements to return pairs of keywords and guids
+                egeria_client.remove_search_keyword(rel_el_list['keywords_list'][ds])
+                msg = f"Removed `{ds}` from component `{guid}`"
+                logger.trace(msg)
+
         parent_components_to_remove = as_is_parent_components - to_be_parent_components
         logger.trace(f"sub_components_to_remove: {list(parent_components_to_remove)}")
         if len(parent_components_to_remove) > 0:
@@ -102,6 +123,8 @@ def sync_component_related_elements(egeria_client: EgeriaTech, object_type: str,
                 msg = f"Removed `{display_name}` from component `{ds}`"
                 logger.trace(msg)
 
+
+
         parent_components_to_add = to_be_parent_components - as_is_parent_components
         logger.trace(f"parent_components_to_add: {list(parent_components_to_add)}")
         if len(parent_components_to_add) > 0:
@@ -186,6 +209,9 @@ def sync_component_related_elements(egeria_client: EgeriaTech, object_type: str,
                 msg = f"Added `{in_blueprint_guids}` to `{display_name}`"
                 logger.trace(msg)
 
+        if keywords:
+            add_search_keywords(egeria_client, guid, keywords)
+
         if supply_chain_guids:
             body = {
                 "class": "NewRelationshipRequestBody",
@@ -268,7 +294,7 @@ def process_blueprint_upsert_command(egeria_client: EgeriaTech, txt: str, direct
 
     qualified_name = parsed_output.get('qualified_name', None)
     guid = parsed_output.get('guid', None)
-
+    journal_entry = parsed_output.get('Journey Entry', {}.get('value', None))
     print(Markdown(parsed_output['display']))
 
     logger.debug(json.dumps(parsed_output, indent=4))
@@ -276,7 +302,7 @@ def process_blueprint_upsert_command(egeria_client: EgeriaTech, txt: str, direct
     attributes = parsed_output['attributes']
     description = attributes.get('Description', {}).get('value', None)
     display_name = attributes['Display Name'].get('value', None)
-
+    search_keywords = attributes['Search Keywords'].get('value', None)
 
 
 
@@ -328,6 +354,8 @@ def process_blueprint_upsert_command(egeria_client: EgeriaTech, txt: str, direct
                     logger.success(msg)
                     sync_blueprint_related_elements(egeria_client, object_type, component_guids, guid, qualified_name,
                                                     display_name, replace_all_props)
+
+                    journal_entry_guid = add_note_in_dr_e(egeria_client, qualified_name, display_name, journal_entry)
                     logger.success(f"===> Updated {object_type} `{display_name}` related elements\n\n")
                     return egeria_client.get_solution_blueprints_by_name(qualified_name, output_format='MD', report_spec = "Solution-Blueprint-DrE")
 
@@ -360,7 +388,8 @@ def process_blueprint_upsert_command(egeria_client: EgeriaTech, txt: str, direct
                     update_element_dictionary(qualified_name, {
                         'guid': guid, 'display_name': display_name
                         })
-                    msg = f"Created Element `{display_name}` with GUID {guid}\n\n___"
+                    journal_entry_guid = add_note_in_dr_e(egeria_client, qualified_name, display_name, journal_entry)
+                    msg = f"\n\nCreated Element `{display_name}` with GUID {guid}\n\n___"
                     print(Markdown(msg))
                     logger.success(msg)
                     return egeria_client.get_solution_blueprint_by_guid(guid, output_format='MD', report_spec = "Solution-Blueprint-DrE")
@@ -413,6 +442,9 @@ def process_solution_component_upsert_command(egeria_client: EgeriaTech, txt: st
     solution_component_type = attributes.get('Solution Component Type', {}).get('value', None)
     planned_deployed_impl_type = attributes.get('Planned Deployed Implementation Type', {}).get('value', None)
     initial_status = attributes.get('Status', {}).get('value', None)
+    url = attributes.get('URL', {}).get('value', None)
+    search_keywords = attributes.get('Search Keywords', {}).get('value', None)
+    journal_entry = attributes.get('Journal Entry', {}).get('value', None)
     user_defined_status = attributes.get('User Defined Status', {}).get('value', None)
     if initial_status != "OTHER":
         user_defined_status = None
@@ -499,22 +531,27 @@ def process_solution_component_upsert_command(egeria_client: EgeriaTech, txt: st
                         "additionalProperties": additional_properties,
                         "extendedProperties": extended_properties,
                         "effectiveFrom": effective_from,
-                        "effectiveTo": effective_to
+                        "effectiveTo": effective_to,
+                        "URL": url
                         }
                     })
 
                 egeria_client.update_solution_component(guid, body)
-                logger.success(f"==>Updated  {object_type} `{display_name}` with GUID {guid}\n")
+                msg = f"\n==>Updated  {object_type} `{display_name}` with GUID {guid}\n"
+                logger.success(msg)
+                print(Markdown(msg))
                 update_element_dictionary(qualified_name, {
                     'guid': guid, 'display_name': display_name
                     })
                 # Sync Parent Components and Blueprints
                 sync_component_related_elements(egeria_client, object_type ,
                                                 in_supply_chain_guids,parent_component_guids,actor_guids,
-                                                in_blueprint_guids, guid, qualified_name, 
+                                                in_blueprint_guids, search_keywords, guid, qualified_name,
                                                 display_name,
                                                 merge_update)
-                logger.success(f"==>Updated  {object_type} `{display_name}` with related elements")
+
+                if journal_entry:
+                    journal_entry_guid = add_note_in_dr_e(egeria_client, qualified_name, display_name, journal_entry)
                 return egeria_client.get_solution_component_by_guid(guid, output_format='MD', report_spec = "Solution-Component-DrE")
 
 
@@ -551,7 +588,8 @@ def process_solution_component_upsert_command(egeria_client: EgeriaTech, txt: st
                             "additionalProperties": additional_properties,
                             "extendedProperties": extended_properties,
                             "effectiveFrom": effective_from,
-                            "effectiveTo": effective_to
+                            "effectiveTo": effective_to,
+                            "URL": url
                         },
                         "initialStatus": initial_status,
                         "externalSourceGUID": external_source_guid,
@@ -566,8 +604,13 @@ def process_solution_component_upsert_command(egeria_client: EgeriaTech, txt: st
                         update_element_dictionary(qualified_name, {
                             'guid': guid, 'display_name': display_name
                             })
-                        msg = f"Created Element `{display_name}` with GUID {guid}\n\n___"
+                        msg = f"\n\n==> Created Element `{display_name}` with GUID {guid}\n\n___"
                         logger.success(msg)
+                        print(Markdown(msg))
+
+                        if search_keywords:
+                            add_search_keywords(egeria_client, guid, search_keywords)
+
                         if in_component_guids:
                             for comp in in_component_guids:
                                 egeria_client.link_subcomponent(comp, guid, None)
@@ -591,6 +634,8 @@ def process_solution_component_upsert_command(egeria_client: EgeriaTech, txt: st
                                 egeria_client.link_design_to_implementation(isc, guid, None)
                             msg = f"Added  `{display_name}`to supply chain `{in_supply_chain_names}`"
                             logger.trace(msg)
+                        journal_entry_guid = add_note_in_dr_e(egeria_client, qualified_name, display_name,
+                                                              journal_entry)
 
                         return egeria_client.get_solution_component_by_guid(guid, output_format='MD')
                     else:
@@ -762,6 +807,7 @@ def process_information_supply_chain_upsert_command(egeria_client: EgeriaTech, t
     description = attributes.get('Description', {}).get('value', None)
     display_name = attributes['Display Name'].get('value', None)
     version_identifier = attributes.get('Version Identifier', {}).get('value', None)
+    journal_entry = attributes.get('Journal Entry', {}).get('Value', None)
     effective_time = attributes.get('Effective Time', {}).get('value', None)
     effective_from = attributes.get('Effective From', {}).get('value', None)
     effective_to = attributes.get('Effective To', {}).get('value', None)
@@ -836,8 +882,9 @@ def process_information_supply_chain_upsert_command(egeria_client: EgeriaTech, t
                 update_element_dictionary(qualified_name, {
                     'guid': guid, 'display_name': display_name
                     })
+                journal_entry_guid = add_note_in_dr_e(egeria_client, qualified_name, display_name, journal_entry)
 
-                # logger.success(f"===> Updated {object_type} `{display_name}` related elements\n\n")
+                logger.success(f"===> Updated {object_type} `{display_name}` related elements\n\n")
                 return egeria_client.get_info_supply_chain_by_guid(guid, output_format='MD')
 
 
@@ -890,6 +937,8 @@ def process_information_supply_chain_upsert_command(egeria_client: EgeriaTech, t
                         if len(in_supply_chain_guids) > 0:
                             for nested_chain in in_supply_chain_guids:
                                 egeria_client.compose_info_supply_chains(guid, nested_chain)
+                        journal_entry_guid = add_note_in_dr_e(egeria_client, qualified_name, display_name,
+                                                              journal_entry)
 
                         msg = f"==>Created Element `{display_name}` with GUID {guid}\n"
                         logger.success(msg)

md_processing/md_processing_utils/common_md_proc_utils.py

@@ -13,7 +13,7 @@ from rich import print
 from rich.markdown import Markdown
 from rich.console import Console
 from pyegeria.utils import parse_to_dict
-
+from pyegeria.config import settings
 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, )
@@ -33,15 +33,19 @@ from pyegeria import EgeriaTech, select_report_spec, PyegeriaException, print_ba
 
 from pyegeria._globals import DEBUG_LEVEL
 
+debug_level = DEBUG_LEVEL
+global COMMAND_DEFINITIONS
+
+user_config = settings.User_Profile
 
 # Constants
 EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
-EGERIA_USAGE_LEVEL = os.environ.get("EGERIA_USAGE_LEVEL", "Advanced")
+EGERIA_USAGE_LEVEL = os.environ.get("EGERIA_USAGE_LEVEL", user_config.egeria_usage_level)
 LOCAL_QUALIFIER = os.environ.get("EGERIA_LOCAL_QUALIFIER", None)
 console = Console(width=EGERIA_WIDTH)
 
-debug_level = DEBUG_LEVEL
-global COMMAND_DEFINITIONS
+
+
 
 
 @logger.catch

md_processing/md_processing_utils/common_md_utils.py

@@ -11,6 +11,8 @@ from loguru import logger
 from rich import print
 from rich.console import Console
 from rich.markdown import Markdown
+
+from pyegeria import Client2, PyegeriaException, egeria_client
 from pyegeria.utils import (camel_to_title_case, body_slimmer)
 from pyegeria._globals import DEBUG_LEVEL
 from md_processing.md_processing_utils.message_constants import message_types
@@ -538,4 +540,41 @@ def set_object_classifications(object_type: str, attributes: dict, obj_types: li
     if classifications:
         for classification in classifications:
             body[classification] = {"class" : f"{classification}Properties"}
-    return body
+    return body
+
+def add_search_keywords(client: Client2, element_guid: str, keywords: list[str]):
+    """Add a search keyword to an element. Throw an exception if a problem is encountered.
+
+    Args:
+        client (Client2): The Egeria client instance.
+        element_guid (str): The GUID of the element to add the keyword to.
+        keyword (str): The search keyword to add.
+
+    Returns:
+        None
+    """
+    try:
+        for keyword in keywords:
+            client.add_search_keyword_to_element(element_guid, keyword)
+            print("Added keyword `{}` to element `{}`".format(keyword, element_guid))
+
+    except PyegeriaException as e:
+        context = {
+            "readon" : "Exception encountered executing add_search_keyword",
+            "element_guid": element_guid,
+            "keyword": keyword,
+            "exception": str(e)
+        }
+        raise PyegeriaException(context = context)
+
+def add_note_in_dr_e(client: Client2, qualified_name: str, display_name: str, journal_entry: str)-> str:
+    if journal_entry:
+        note_log_qn = f"{qualified_name}-NoteLog"
+        note_log_display_name = f"{display_name}-NoteLog"
+        note_display_name = f"{qualified_name}-Journal-Entry-{datetime.now().strftime('%Y-%m-%d %H:%M')}"
+        journal_entry_guid = client.add_journal_entry(note_log_qn, qualified_name, note_log_display_name, note_display_name,
+                                                             journal_entry)
+        logger.info(f"Added journal entry `{journal_entry_guid}` to `{qualified_name}`")
+        return journal_entry_guid
+    else:
+        return None