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

md_processing/family_docs/Solution Architect.md

@@ -0,0 +1,490 @@
+
+# Family: Solution Architect
+
+## **Create Information Supply Chain**
+>	The flow of a particular type of data across a digital landscape.
+### **Display Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the Information Supply Chain
+
+>	**Alternative Labels**: Name; Display Name; Supply Chain; Supply Chain Name
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the data structure.
+
+
+### **Scope**
+>	**Input Required**: False
+
+>	**Description**: Scope of the supply chain.
+
+
+### **Purposes**
+>	**Input Required**: False
+
+>	**Description**: A list of purposes.
+
+>	**Alternative Labels**: Purpose, Purposes
+
+
+### **Nested Information Supply Chains**
+>	**Input Required**: False
+
+>	**Description**: A list of supply chains that compose this supply chain.
+
+>	**Alternative Labels**: Nested Supply Chains
+
+
+### **In Information Supply Chain**
+>	**Input Required**: False
+
+>	**Description**: Supply chains that this supply chain is in.
+
+>	**Alternative Labels**: In Supply Chain; In Supply Chains; In Information Supply Chains
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+### **Merge Update**
+>	**Input Required**: False
+
+>	**Description**: If true, only those attributes specified in the update will be updated; If false, any attributes not provided during the update will be set to None.
+
+>	**Alternative Labels**: Merge
+
+>	**Default Value**: True
+
+
+___
+
+## **Create Solution Blueprint**
+>	A solution blueprint describes the architecture of a digital service in terms of solution components.
+### **Display Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the Information Supply Chain
+
+>	**Alternative Labels**: Name; Display Name; Blueprint; Blueprint Name
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the data structure.
+
+
+### **Version Identifier**
+>	**Input Required**: False
+
+>	**Description**: A user supplied version identifier.
+
+
+### **Solution Components**
+>	**Input Required**: False
+
+>	**Description**: Solution components that make up the blueprint.
+
+>	**Alternative Labels**: Components; Solution Component; Component
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+___
+
+## **Create Solution Component**
+>	A reusable solution component.
+### **Display Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the solution component.
+
+>	**Alternative Labels**: Name; Display Name; Solution Component Name; Component Name
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the data structure.
+
+
+### **Solution Component Type**
+>	**Input Required**: False
+
+>	**Description**: Type of solution component.
+
+>	**Alternative Labels**: Soln Component Type
+
+
+### **Planned Deployed Implementation Type**
+>	**Input Required**: False
+
+>	**Description**: The planned implementation type for deployment.
+
+>	**Alternative Labels**: Planned Deployed Impl Type
+
+
+### **Initial Status**
+>	**Input Required**: False
+
+>	**Description**: Optional lifecycle status. If not specified, set to ACTIVE. If set to Other then the value in User Defined Status will be used.
+
+>	**Valid Values**: DRAFT; PREPARED; PROPOSED; APPROVED; REJECTED; ACTIVE; DISABLED; DEPRECATED; OTHER
+
+>	**Default Value**: ACTIVE
+
+
+### **In Solution Components**
+>	**Input Required**: False
+
+>	**Description**: Solution components that include this one.
+
+>	**Alternative Labels**: In Solution Component; In Component
+
+
+### **In Solution Blueprints**
+>	**Input Required**: False
+
+>	**Description**: Solution Blueprints that contain this component.
+
+>	**Alternative Labels**: In Solution Blueprints
+
+
+### **In Information Supply Chains**
+>	**Input Required**: False
+
+>	**Description**: The Information Supply Chains that this component is a member of.
+
+>	**Alternative Labels**: In Supply Chains; In Supply Chain; In Information Supply Chain
+
+
+### **Actors**
+>	**Input Required**: False
+
+>	**Description**: Actors associated with this component.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+### **Merge Update**
+>	**Input Required**: False
+
+>	**Description**: If true, only those attributes specified in the update will be updated; If false, any attributes not provided during the update will be set to None.
+
+>	**Alternative Labels**: Merge
+
+>	**Default Value**: True
+
+
+___
+
+## **Create Solution Role**
+>	A collection of data fields that for a data specification for a data source.
+### **Name**
+>	**Input Required**: True
+
+>	**Description**: Name of the role.
+
+>	**Alternative Labels**: Role; Solution Role; Solution Role Name; Role Name
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the data structure.
+
+
+### **Title**
+>	**Input Required**: False
+
+>	**Description**: Title of the role.
+
+
+### **Scope**
+>	**Input Required**: False
+
+>	**Description**: Scope of the role.
+
+
+### **identifier**
+>	**Input Required**: False
+
+>	**Description**: role identifier
+
+
+### **Domain Identifier**
+>	**Input Required**: False
+
+>	**Description**: Governance domain identifier
+
+>	**Default Value**: 0
+
+
+### **Role Type**
+>	**Input Required**: False
+
+>	**Description**: Type of the role.  Currently must be GovernanceRole.
+
+>	**Alternative Labels**: Role Type Name
+
+>	**Default Value**: GovernanceRole
+
+
+### **Qualified Name**
+>	**Input Required**: False
+
+>	**Description**: A unique qualified name for the element. Generated using the qualified name pattern  if not user specified.
+
+
+### **GUID**
+>	**Input Required**: False
+
+>	**Description**: A system generated unique identifier.
+
+>	**Alternative Labels**: Guid; guid
+
+
+___
+
+## **Link Information Supply Chain Peers**
+>	This command can be used to link or unlink information supply chain segments.
+### **Segment1**
+>	**Input Required**: True
+
+>	**Description**: The  first segment to link.
+
+>	**Alternative Labels**: Segment 1; Information Supply Chain Segment 1; Info Supply Chain Segment 1
+
+
+### **Segment2**
+>	**Input Required**: True
+
+>	**Description**: The  second segment to link.
+
+>	**Alternative Labels**: Segment 2; Information Supply Chain Segment 2; Info Supply Chain Segment 2
+
+
+### **Link Label**
+>	**Input Required**: False
+
+>	**Description**: Labels the link between two information supply chain segments.
+
+>	**Alternative Labels**: Label
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the data structure.
+
+
+___
+
+## **Link Solution Component Peers**
+>	This command can be used to link or unlink wires between components.
+### **Component1**
+>	**Input Required**: True
+
+>	**Description**: The  first component to link.
+
+>	**Alternative Labels**: Solution Component 1; Comp 1
+
+
+### **Component2**
+>	**Input Required**: True
+
+>	**Description**: The  second component to link.
+
+>	**Alternative Labels**: Solution Component 2; Comp 2
+
+
+### **Wire Label**
+>	**Input Required**: False
+
+>	**Description**: Labels the link between two components.
+
+>	**Alternative Labels**: Label
+
+
+### **Description**
+>	**Input Required**: False
+
+>	**Description**: A description of the wire.
+
+
+___
+
+## **View Information Supply Chains**
+>	Return information supply chains filtered by the search string.
+### **Search String**
+>	**Input Required**: False
+
+>	**Description**: An optional search string to filter results by.
+
+>	**Alternative Labels**: Filter
+
+>	**Default Value**: *
+
+
+### **Output Format**
+>	**Input Required**: False
+
+>	**Description**: Optional specification of output format for the query.
+
+>	**Alternative Labels**: Format
+
+>	**Valid Values**: LIST; FORM; MD; REPORT; MERMAID; LIST; DICT; HTML
+
+>	**Default Value**: List
+
+
+### **Detailed**
+>	**Input Required**: False
+
+>	**Description**: If true a more detailed set of attributes will be returned.
+
+>	**Default Value**: True
+
+
+___
+
+## **View Solution Blueprints**
+>	Return the data structure details, optionally filtered by the search string.
+### **Search String**
+>	**Input Required**: False
+
+>	**Description**: An optional search string to filter results by.
+
+>	**Alternative Labels**: Filter
+
+>	**Default Value**: *
+
+
+### **Output Format**
+>	**Input Required**: False
+
+>	**Description**: Optional specification of output format for the query.
+
+>	**Alternative Labels**: Format
+
+>	**Valid Values**: List; Form; Report; Dict
+
+>	**Default Value**: List
+
+
+### **Detailed**
+>	**Input Required**: False
+
+>	**Description**: If true a more detailed set of attributes will be returned.
+
+>	**Default Value**: True
+
+
+___
+
+## **View Solution Components**
+>	Return the data structure details, optionally filtered by the search string.
+### **Search String**
+>	**Input Required**: False
+
+>	**Description**: An optional search string to filter results by.
+
+>	**Alternative Labels**: Filter
+
+>	**Default Value**: *
+
+
+### **Output Format**
+>	**Input Required**: False
+
+>	**Description**: Optional specification of output format for the query.
+
+>	**Alternative Labels**: Format
+
+>	**Valid Values**: List; Form; Report; Dict
+
+>	**Default Value**: List
+
+
+### **Detailed**
+>	**Input Required**: False
+
+>	**Description**: If true a more detailed set of attributes will be returned.
+
+>	**Default Value**: True
+
+
+___
+
+## **View Solution Roles**
+>	Return the data structure details, optionally filtered by the search string.
+### **Search String**
+>	**Input Required**: False
+
+>	**Description**: An optional search string to filter results by.
+
+>	**Alternative Labels**: Filter
+
+>	**Default Value**: *
+
+
+### **Output Format**
+>	**Input Required**: False
+
+>	**Description**: Optional specification of output format for the query.
+
+>	**Alternative Labels**: Format
+
+>	**Valid Values**: List; Form; Report; Dict
+
+>	**Default Value**: List
+
+
+### **Detailed**
+>	**Input Required**: False
+
+>	**Description**: If true a more detailed set of attributes will be returned.
+
+>	**Default Value**: True
+
+
+___

md_processing/md_commands/data_designer_commands.py

@@ -12,7 +12,7 @@ from rich.console import Console
 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
+from md_processing.md_processing_utils.common_md_utils import update_element_dictionary, setup_log
 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, ERROR)
 from pyegeria import DEBUG_LEVEL, body_slimmer
@@ -41,15 +41,7 @@ load_commands('commands.json')
 debug_level = DEBUG_LEVEL
 
 console = Console(width=int(200))
-
-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)
+setup_log()
 
 
 #
@@ -669,6 +661,7 @@ def process_data_structure_upsert_command(egeria_client: EgeriaTech, txt: str, d
     set_debug_level(directive)
 
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_upsert_command(egeria_client, object_type, object_action, txt, directive)
 
@@ -866,6 +859,7 @@ def process_data_field_upsert_command(egeria_client: EgeriaTech, txt: str, direc
     set_debug_level(directive)
 
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_upsert_command(egeria_client, object_type, object_action, txt, directive)
     attributes = parsed_output['attributes']
@@ -1140,6 +1134,7 @@ def process_data_class_upsert_command(egeria_client: EgeriaTech, txt: str, direc
     """
 
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_upsert_command(egeria_client, object_type, object_action, txt, directive)
 
@@ -1392,6 +1387,7 @@ def process_data_collection_list_command(egeria_client: EgeriaTech, txt: str, di
     :return: A string summarizing the outcome of the processing.
     """
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
     if object_type in ["Data Dictionary", "Data Dictionaries", "DataDict", "DataDictionary"]:
         col_type = "DataDictionary"
     elif object_type in ["Data Specification", "Data Specifications", "Data Specs"]:
@@ -1478,6 +1474,7 @@ def process_data_structure_list_command(egeria_client: EgeriaTech, txt: str, dir
     :return: A string summarizing the outcome of the processing.
     """
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_view_command(egeria_client, object_type, object_action, txt, directive)
 
@@ -1539,6 +1536,7 @@ def process_data_field_list_command(egeria_client: EgeriaTech, txt: str, directi
     :return: A string summarizing the outcome of the processing.
     """
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_view_command(egeria_client, object_type, object_action, txt, directive)
 
@@ -1615,6 +1613,7 @@ def process_data_class_list_command(egeria_client: EgeriaTech, txt: str, directi
     :return: A string summarizing the outcome of the processing.
     """
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     parsed_output = parse_view_command(egeria_client, object_type, object_action, txt, directive)
 

md_processing/md_commands/glossary_commands.py

@@ -12,7 +12,8 @@ from rich.console import Console
 from rich.markdown import Markdown
 
 from md_processing.md_processing_utils.common_md_utils import (debug_level, print_msg, set_debug_level,
-                                                               get_element_dictionary, update_element_dictionary)
+                                                               get_element_dictionary, update_element_dictionary,
+                                                               setup_log)
 from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, extract_command,
                                                                 process_simple_attribute, process_element_identifiers,
                                                                 update_a_command, extract_attribute,
@@ -29,7 +30,7 @@ from pyegeria.egeria_tech_client import EgeriaTech
 
 EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "170"))
 console = Console(width=EGERIA_WIDTH)
-
+setup_log()
 
 def update_term_categories(egeria_client: EgeriaTech, term_guid: str, categories_exist: bool,
                            categories_list: List[str]) -> None:
@@ -107,6 +108,7 @@ def process_glossary_upsert_command(egeria_client: EgeriaTech, txt: str, directi
     """
 
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
     set_debug_level(directive)
 
     glossary_name = process_simple_attribute(txt, GLOSSARY_NAME_LABELS, ERROR)
@@ -239,6 +241,7 @@ def process_category_upsert_command(egeria_client: EgeriaTech, txt: str, directi
     set_debug_level(directive)
 
     command, object_type, object_action = extract_command_plus(txt)
+    print(Markdown(f"# {command}\n"))
 
     category_name = process_simple_attribute(txt, ['Category Name', 'category_name', 'Cat'])
     print(Markdown(f"{pre_command} `{command}` for category: `\'{category_name}\'` with directive: `{directive}` "))
@@ -484,6 +487,8 @@ def process_term_upsert_command(egeria_client: EgeriaTech, txt: str, directive:
     set_debug_level(directive)
     known_q_name = None
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
+
     object_type = command.split(' ')[1].strip()
     object_action = command.split(' ')[0].strip()
 
@@ -678,6 +683,8 @@ Optional[str]:
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
+
     object_type = command.split(' ')[1].strip()
     object_action = command.split(' ')[0].strip()
     term1_guid = None
@@ -735,6 +742,7 @@ def process_term_list_command(egeria_client: EgeriaTech, txt: str, directive: st
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
 
     search_string = process_simple_attribute(txt, SEARCH_LABELS)
     if search_string is None:
@@ -802,6 +810,7 @@ def process_category_list_command(egeria_client: EgeriaTech, txt: str, directive
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
 
     search_string = process_simple_attribute(txt, SEARCH_LABELS, "INFO")
     if search_string is None:
@@ -854,6 +863,7 @@ def process_glossary_structure_command(egeria_client: EgeriaTech, txt: str, dire
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
 
     known_glossary_guid = ""
 
@@ -909,6 +919,7 @@ def process_glossary_list_command(egeria_client: EgeriaTech, txt: str, directive
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
 
     search_string = process_simple_attribute(txt, SEARCH_LABELS, "INFO")
     if search_string is None:
@@ -961,6 +972,7 @@ def process_term_details_command(egeria_client: EgeriaTech, txt: str, directive:
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
     object_type = command.split(' ')[1].strip()
     object_action = command.split(' ')[0].strip()
 
@@ -1011,6 +1023,7 @@ def process_term_history_command(egeria_client: EgeriaTech, txt: str, directive:
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
     object_type = command.split(' ')[1].strip()
     object_action = command.split(' ')[0].strip()
 
@@ -1068,6 +1081,7 @@ def process_term_revision_history_command(egeria_client: EgeriaTech, txt: str, d
     set_debug_level(directive)
     valid = True
     command = extract_command(txt)
+    print(Markdown(f"# {command}\n"))
     object_type = command.split(' ')[1].strip()
     object_action = command.split(' ')[0].strip()
     known_q_name = None