pyegeria 5.4.3.3__py3-none-any.whl → 5.4.4__py3-none-any.whl

md_processing/family_docs/Solution Architect.md

@@ -1,490 +0,0 @@
-
-# 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/old_project_commands.py

@@ -1,164 +0,0 @@
-"""
-This file contains project-related object_action functions for processing Egeria Markdown
-"""
-
-from rich.markdown import Markdown
-
-from md_processing.md_processing_utils.common_md_utils import (debug_level, print_msg, is_valid_iso_date)
-from md_processing.md_processing_utils.extraction_utils import (extract_command, process_simple_attribute)
-from md_processing.md_processing_utils.md_processing_constants import ALWAYS, ERROR, INFO, pre_command
-from pyegeria._globals import NO_PROJECTS_FOUND
-from pyegeria.project_manager import ProjectManager
-
-def process_per_proj_upsert_command(egeria_client: ProjectManager, txt: str, directive: str = "display") -> str | None:
-    """
-    Processes a personal project create or update object_action by extracting key attributes such as
-    glossary name, language, description, and usage from the given cell.
-
-    :param txt: A string representing the input cell to be processed for
-        extracting glossary-related attributes.
-    :param directive: an optional string indicating the directive to be used - display, validate or execute
-    :return: A string summarizing the outcome of the processing.
-    """
-    from md_processing.md_processing_utils.common_md_utils import set_debug_level
-
-    command = extract_command(txt)
-    print(Markdown(f"# {command}\n"))
-
-    object = command.split()
-    object_type = f"{object[1]} {object[2]}"
-    object_action = object[0]
-    set_debug_level(directive)
-
-    project_name = process_simple_attribute(txt, ['Project Name'])
-    description = process_simple_attribute(txt, ['Description'])
-    project_identifier = process_simple_attribute(txt, ['Project Identifier'])
-    project_status = process_simple_attribute(txt, ['Status'])
-    project_phase = process_simple_attribute(txt, ['Project Phase'])
-    project_health = process_simple_attribute(txt, ['Project Health'])
-    start_date = process_simple_attribute(txt, ['Start Date'])
-    planned_end_date = process_simple_attribute(txt, ['Planned End Date'])
-    print(Markdown(f"{pre_command} `\'{command}\'` for project: `{project_name}` with directive: `{directive}` "))
-
-    project_display = (f"\n* Command: {command}\n\t* Project: {project_name}\n\t"
-                       f"* Status: {project_status}\n\t* Description: {description}\n\t"
-                       f"* Phase: {project_phase}\n\t* Health: {project_health}\n\t"
-                       f"* Start Date: {start_date}\n\t* Planned End Date: {planned_end_date}\n")
-
-    def validate_project(obj_action: str) -> tuple[bool, bool, str, str]:
-        valid = True
-        msg = ""
-        known_guid = None
-        known_q_name = None
-
-        project_details = egeria_client.get_projects_by_name(project_name)
-        if project_details == NO_PROJECTS_FOUND:
-            project_exists = False
-        else:
-            project_exists = True
-
-        if project_name is None:
-            msg = f"* {ERROR}Project name is missing\n"
-            valid = False
-        if project_status is None:
-            msg += f"* {INFO}No Project status found\n"
-
-        if description is None:
-            msg += f"* {INFO}No Description found\n"
-
-        if project_identifier is None:
-            msg += f"* {INFO}No Project Identifier found\n"
-
-        if project_phase is None:
-            msg += f"* {INFO}No Project Phase found\n"
-
-        if project_health is None:
-            msg += f"* {INFO}No Project Health found\n"
-
-        if start_date is None:
-            msg += f"* {INFO}No Start Date found\n"
-        elif not is_valid_iso_date(start_date):
-            msg += f"* {ERROR}Start Date is not a valid ISO date of form  YYYY-MM-DD\n"
-            valid = False
-
-        if planned_end_date is None:
-            msg += f"* {INFO} No Planned End Date found\n"
-        elif not is_valid_iso_date(planned_end_date):
-            msg += f"* {ERROR}Planned End Date is not a valid ISO date of form  YYYY-MM-DD\n"
-            valid = False
-
-        if obj_action == "Update":
-            q_name = process_simple_attribute(txt, 'Qualified Name')
-
-            if not project_exists:
-                msg += f"* {ERROR}Project {project_name} does not exist\n"
-                valid = False
-            if len(project_details) > 1 and project_exists:
-                msg += f"* {ERROR}More than one project with name {project_name} found\n"
-                valid = False
-            if len(project_details) == 1:
-                known_guid = project_details[0]['elementHeader'].get('guid', None)
-                known_q_name = project_details[0]['glossaryProperties'].get('qualifiedName', None)
-            if q_name is None:
-                msg += f"* {INFO}Qualified Name is missing => can use known qualified name of {known_q_name}\n"
-                valid = True
-            elif q_name != known_q_name:
-                msg += (f"* {ERROR}Project {project_name} qualifiedName mismatch between {q_name} and {known_q_name}\n")
-                valid = False
-            if valid:
-                msg += project_display
-                msg += f"* -->Project {project_name} exists and can be updated\n"
-            else:
-                msg += f"* --> validation failed\n"
-            msg += '---'
-            print(Markdown(msg))
-            return valid, project_exists, known_guid, known_q_name
-
-        elif obj_action == "Create":
-            if project_exists:
-                msg += f"\n{ERROR}Project {project_name} already exists"
-            else:
-                msg += f"\n-->It is valid to create Project \'{project_name}\' with:\n"
-            print(Markdown(msg))
-            return valid, project_exists, known_guid, known_q_name
-
-    if directive == "display":
-        print(Markdown(project_display))
-        return None
-    elif directive == "validate":
-        valid, project_exists, known_guid, known_q_name = validate_project(object_action)
-        return valid
-    elif directive == "process":
-        valid, project_exists, known_guid, known_q_name = validate_project(object_action)
-        if valid:
-            if object_action == "Create":
-                if project_exists:
-                    print(f"\n{ERROR}Project {project_name} already exists\n")
-                    return None
-                else:
-                    project_guid = egeria_client.create_personal_project(project_name, description, project_identifier,
-                                                                         project_status, project_phase, project_health,
-                                                                         start_date, planned_end_date)
-                    if project_guid:
-                        print_msg(ALWAYS, f"Created Project {project_name} with GUID {project_guid}", debug_level)
-                        return egeria_client.get_project_by_guid(project_guid, output_format='MD')
-                    else:
-                        print_msg(ERROR, f"Failed to create Project {project_name}", debug_level)
-                        return None
-            elif object_action == "Update":
-                if not project_exists:
-                    print(f"\n{ERROR}Project {project_name} does not exist\n")
-                    return None
-                else:
-                    project_guid = egeria_client.update_personal_project(known_guid, project_name, description,
-                                                                         project_identifier, project_status,
-                                                                         project_phase, project_health, start_date,
-                                                                         planned_end_date)
-                    if project_guid:
-                        print_msg(ALWAYS, f"Updated Project {project_name} with GUID {project_guid}", debug_level)
-                        return egeria_client.get_project_by_guid(project_guid, output_format='MD')
-                    else:
-                        print_msg(ERROR, f"Failed to update Project {project_name}", debug_level)
-                        return None
-        else:
-            return None