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

pyegeria/__init__.py

@@ -61,7 +61,7 @@ from .project_manager import ProjectManager
 from .registered_info import RegisteredInfo
 from .runtime_manager_omvs import RuntimeManager
 from .server_operations import ServerOps
-from .solution_architect_omvs import SolutionArchitect
+from .solution_architect import SolutionArchitect
 from .utils import body_slimmer, print_response, to_pascal_case, to_camel_case, camel_to_title_case
 from .valid_metadata_omvs import ValidMetadataManager
 from .x_action_author_omvs import ActionAuthor

pyegeria/_client_new.py

@@ -360,18 +360,20 @@ class Client2:
         """Retrieve and return the bearer token"""
         return self.text_headers["Authorization"]
 
-    def get_platform_origin(self):
-        """Validate platform connectivity"""
+    def get_platform_origin(self) -> str:
+        """Return the platform origin string if reachable.
+        
+        Historically this method returned a boolean; tests and helpers expect the actual origin text.
+        """
         origin_url = f"{self.platform_url}/open-metadata/platform-services/users/{self.user_id}/server-platform/origin"
         response = self.make_request("GET", origin_url, is_json=False)
         if response.status_code == 200:
-            logger.success(f"Got response from {origin_url}\n Response: {response.text}")
-            if response.text.split()[0] == "Egeria":
-                return True
-            else:
-                return False
+            text = response.text.strip()
+            logger.success(f"Got response from {origin_url}\n Response: {text}")
+            return text
         else:
             logger.info(f"Got response from {origin_url}\n status_code: {response.status_code}")
+            return ""
 
     # @logger.catch
     def make_request(

pyegeria/_output_formats.py

@@ -92,6 +92,7 @@ COMMON_COLUMNS = [
     Column(name='Qualified Name', key='qualified_name', format=True),
     Column(name='Category', key='category'),
     Column(name='Description', key='description', format=True),
+    Column(name='Status', key='status'),
 ]
 
 COMMON_METADATA_COLUMNS = [
@@ -513,13 +514,17 @@ output_format_sets = FormatSetDict({
         )
     ),
 
-    "Data Structure": FormatSet(
+    "Data Structures": FormatSet(
         target_type="Data Structure",
         heading="Data Structure Information",
         description="Attributes useful to Data Structures.",
         aliases=["Data Structure", "DataStructures", "Data Structures", "Data Struct", "DataStructure"],
         annotations={"wikilinks": ["[[Data Structure]]"]},
-        formats=[Format(types=["ALL"], columns=COMMON_COLUMNS)],  # Reusing common formats and columns
+        formats=[Format(types=["ALL"], columns=COMMON_COLUMNS +
+                    [
+                        Column(name="Member Of", key='member_of_collections')
+                    ]
+                )],  # Reusing common formats and columns
         action=ActionParameter(
             function="DataDesigner.find_data_structures",
             required_params=["search_string"],
@@ -540,7 +545,90 @@ output_format_sets = FormatSetDict({
             spec_params={},
         )
     ),
-
+"DataField-DrE": FormatSet(
+        target_type="Data Field",
+        heading="Data Field Information",
+        description="Attributes useful to Data Fields.",
+        aliases=[],
+        annotations={"wikilinks": ["[[Data Field]]"]},
+        formats=[Format(types=["ALL"], columns=COMMON_COLUMNS +
+                        [Column(name='Data Type', key='data_type'),
+                         Column(name='Position', key='position'),
+                         Column(name='Minimum Cardinality', key='min_cardinality'),
+                         Column(name='Maximum Cardinality', key='max_cardinality'),
+                         Column(name='In Data Structure', key='data_structure_qnames'),
+                         Column(name='Data Class', key='data_class'),
+                         Column(name='Glossary Term', key='glossary_term'),
+                         Column(name='Aliases', key='aliases'),
+                         Column(name='Name Patterns', key='name_patterns'),
+                         Column(name='Namespaces', key='namespaces'),
+                         Column(name='IsNullable', key='is_nullable'),
+                         Column(name='Minimum Length', key='min_length'),
+                         Column(name='Length', key='length'),
+                         Column(name='Precision', key='precision'),
+                         Column(name='Ordered Values', key='ordered_values'),
+                         Column(name='Units', key='units'),
+                         Column(name='Sort Order', key='sort_order'),
+                         Column(name='Default Value', key='default_value'),
+                         Column(name='Version Identifier', key='version_identifier'),
+                         Column(name='In Data Specification', key='member_of_data_spec_qnames'),
+                         Column(name='In Data Dictionary', key='member_of_data_dicts_qnames'),
+                         Column(name='Parent Data Field', key='parent_data_field'),
+                         Column(name='Qualified Name', key='qualified_name'),
+                         Column(name='GUID', key='GUID'),
+                         Column(name ='Merge Update', key='merge_update'),
+                         Column(name='Additional Properties', key='additional_properties'),
+                         Column(name='Extended Properties', key='extended_properties'),
+                         ])
+                 ],
+        action=ActionParameter(
+            function="DataDesigner.find_data_fields",
+            required_params=["search_string"],
+            spec_params={},
+        )
+    ),
+"DataClass-DrE": FormatSet(
+        target_type="Data Class",
+        heading="Data Class Information",
+        description="Attributes useful to Data Classes.",
+        aliases=[],
+        annotations={"wikilinks": ["[[Data Field]]"]},
+        formats=[Format(types=["ALL"], columns=COMMON_COLUMNS +
+                        [Column(name='Namespaces', key='namespaces'),
+                         Column(name='Match Property Names', key='match_property_names'),
+                         Column(name='Match Threshold', key='match_threshold'),
+                         Column(name='IsCaseSensitive', key='is_case_sensitive'),
+                         Column(name='Specification', key='specification'),
+                         Column(name='Specification Details', key='specification_details'),
+                         Column(name='Data Type', key='data_type'),
+                         Column(name='Allow Duplicate Values', key='allow_duplicate_values'),
+                         Column(name='IsNullable', key='is_nullable'),
+                         Column(name='IsCaseSensitive', key='is_case_sensitive'),
+                         Column(name='Default Value', key='default_value'),
+                         Column(name='Average Value', key='average_value'),
+                         Column(name='Value List', key='value_list'),
+                         Column(name='Value Range From', key='value_range_from'),
+                         Column(name='Value Range To', key='value_range_to'),
+                         Column(name='Sample Values', key='sample_values'),
+                         Column(name='Data Patterns', key='data_patterns'),
+                         Column(name='Glossary Term', key='glossary_term'),
+                         Column(name='In Data Dictionary', key='in_data_dictionary'),
+                         Column(name='Containing Data Class', key='containing_data_class'),
+                         Column(name='Specialized Data Class', key='specialized_data_class'),
+                         Column(name='Version Identifier', key='version_identifier'),
+                         Column(name='Qualified Name', key='qualified_name'),
+                         Column(name='GUID', key='GUID'),
+                         Column(name ='Merge Update', key='merge_update'),
+                         Column(name='Additional Properties', key='additional_properties'),
+                         Column(name='Extended Properties', key='extended_properties'),
+                         ])
+                 ],
+        action=ActionParameter(
+            function="DataDesigner.find_data_fields",
+            required_params=["search_string"],
+            spec_params={},
+        )
+    ),
     "Mandy-DataStruct": FormatSet(
         target_type="Data Structure",
         heading="Puddy Approves",
@@ -559,6 +647,39 @@ output_format_sets = FormatSetDict({
             spec_params={"output_format":"DICT"},
         )
     ),
+    "DataStruct-DrE": FormatSet(
+        target_type="Data Structure",
+        heading="Data Structure Information",
+        description="Information used with Dr. Egeria to describe Data Structures.",
+        aliases=[],
+        annotations={"wikilinks": ["[[Data Structure]]"]},
+        formats=[
+            Format(types=["TABLE", "LIST"], columns=COMMON_COLUMNS + [
+                Column(name='Namespace', key='namespace'),
+                Column(name='In Data Specifications', key='member_of_data_spec_qnames'),
+                Column(name='In Data Dictionary', key='member_of_data_dicts_qnames'),
+                Column(name='Glossary Term', key='glossary_term'),
+               ]),
+            Format(types=["DICT", "MD"], columns=COMMON_COLUMNS + [
+                Column(name='Namespace', key='namespace'),
+                Column(name='In Data Specifications', key='member_of_data_spec_qnames'),
+                Column(name='In Data Dictionary', key='member_of_data_dicts_qnames'),
+                Column(name='Glossary Term', key='glossary_term'),
+                Column(name='GUID', key='GUID')]),
+            Format(types=["REPORT", "MERMAID", "HTML"], columns=COMMON_COLUMNS + [
+                Column(name='Namespace', key='namespace'),
+                Column(name='In Data Specifications', key='member_of_data_spec_qnames'),
+                Column(name='In Data Dictionary', key='member_of_data_dicts_qnames'),
+                Column(name='Glossary Term', key='glossary_term'),
+                Column(name='Mermaid', key='mermaid'),
+                Column(name='GUID', key='GUID')])
+        ],
+        action=ActionParameter(
+            function="DataDesigner.find_data_structures",
+            required_params=["search_string"],
+            spec_params={"output_format": "DICT"},
+        )
+    ),
     "Governance Basics": FormatSet(
         target_type="Governance Definition",
         heading="Basic Governance-Definitions Information",

pyegeria/collection_manager.py

@@ -25,7 +25,7 @@ from pyegeria.models import (SearchStringRequestBody, FilterRequestBody, GetRequ
                              get_defined_field_values, PyegeriaModel)
 from pyegeria.output_formatter import (generate_output,
                                        _extract_referenceable_properties, populate_columns_from_properties,
-                                       get_required_relationships)
+                                       get_required_relationships, populate_common_columns)
 from pyegeria.utils import body_slimmer, dynamic_catch
 
 
@@ -2680,7 +2680,7 @@ class CollectionManager(Client2):
             f"{self.platform_url}/servers/"
             f"{self.view_server}/api/open-metadata/collection-manager/collections/digital-products/"
             f"{upstream_digital_prod_guid}/product-dependencies/{downstream_digital_prod_guid}/attach")
-        await self._async_new_relationship_request(url, "InformationSupplyChainLinkProperties", body)
+        await self._async_new_relationship_request(url, ["InformationSupplyChainLinkProperties"], body)
         logger.info(f"Linked {upstream_digital_prod_guid} -> {downstream_digital_prod_guid}")
 
 
@@ -5483,64 +5483,25 @@ class CollectionManager(Client2):
         return added_props
 
     def _extract_collection_properties(self, element: dict, columns_struct: dict) -> dict:
-        """
-        Extract common properties from a collection element and populate into the provided columns_struct.
+        """Populate collection columns for output.
 
-        Args:
-            element (dict): The collection element
-            columns_struct (dict): The columns structure to populate
+        Uses `populate_common_columns` to fill standard fields and derive requested relationships.
 
-        Returns:
-            dict: columns_struct with column 'value' fields populated
-        """
-        # First, populate from element.properties using the utility
-        col_data = populate_columns_from_properties(element, columns_struct)
-
-        columns_list = col_data.get("formats", {}).get("columns", [])
-
-        # Populate header-derived values
-        header_props = _extract_referenceable_properties(element)
-        for column in columns_list:
-            key = column.get('key')
-            if key in header_props:
-                column['value'] = header_props.get(key)
-            elif isinstance(key, str) and key.lower() == 'guid':
-                column['value'] = header_props.get('GUID')
-
-        # Derived/computed fields
-        # collectionCategories are classifications
-        classification_names = ""
-        classifications = element.get('elementHeader', {}).get("collectionCategories", [])
-        for classification in classifications:
-            classification_names += f"{classification['classificationName']}, "
-        if classification_names:
-            for column in columns_list:
-                if column.get('key') == 'classifications':
-                    column['value'] = classification_names[:-2]
-                    break
-
-        # Populate requested relationship-based columns generically from top-level keys
-        col_data = get_required_relationships(element, col_data)
-
-        # Subject area classification
-        subject_area = element.get('elementHeader', {}).get("subjectArea", "") or ""
-        subj_val = ""
-        if isinstance(subject_area, dict):
-            subj_val = subject_area.get("classificationProperties", {}).get("subjectAreaName", "")
-        for column in columns_list:
-            if column.get('key') == 'subject_area':
-                column['value'] = subj_val
-                break
-
-        # Mermaid graph
-        mermaid_val = element.get('mermaidGraph', "") or ""
-        for column in columns_list:
-            if column.get('key') == 'mermaid':
-                column['value'] = mermaid_val
-                break
+        Parameters
+        ----------
+        element : dict
+            Raw element from the OMVS.
+        columns_struct : dict
+            Format-set structure whose columns' `value` fields will be populated.
 
+        Returns
+        -------
+        dict
+            The same columns_struct with populated values.
+        """
+        # Use centralized common population
+        col_data = populate_common_columns(element, columns_struct)
         logger.trace(f"Extracted/Populated columns: {col_data}")
-
         return col_data
 
 

pyegeria/config.py

@@ -25,6 +25,7 @@ import inspect
 import os
 import json
 from typing import List, Optional, Union, Dict, Any
+import sys
 
 from loguru import logger
 from pydantic import BaseModel, Field, validator, ConfigDict
@@ -36,6 +37,12 @@ logger.disable("pyegeria")
 # --- Pydantic Settings for Environment Variables ---
 
 class PyegeriaSettings(BaseSettings):
+    """Top-level environment settings for pyegeria.
+
+    This class centralizes discovery of important filesystem paths and default
+    configuration values. It can be constructed directly or via `with_env_file`
+    to load overrides from a specific .env-like file.
+    """
     """
     Settings loaded from environment variables using pydantic-settings.
     This class is used to load environment variables from the .env file.
@@ -89,6 +96,7 @@ class PyegeriaSettings(BaseSettings):
 # --- Pydantic Models for Configuration ---
 
 class EnvironmentConfig(BaseModel):
+    """Runtime environment parameters that influence formatting and behavior."""
     """Environment configuration settings"""
     console_width: int = Field(default=200, alias="Console Width")
     dr_egeria_inbox: str = Field(default="md_processing/dr-egeria-inbox", alias="Dr.Egeria Inbox")
@@ -149,6 +157,7 @@ class UserProfileConfig(BaseModel):
 
 
 class AppConfig(BaseModel):
+    """Aggregated application configuration used by pyegeria components."""
     """Main application configuration"""
     Environment: EnvironmentConfig
     Debug: DebugConfig
@@ -333,7 +342,7 @@ def load_app_config(env_file: str | None = None):
     )
     log["logging_file_format"] = os.getenv(
         "PYEGERIA_LOGGING_FILE_FORMAT",
-        log.get("logging_file_format", " {time:YYYY-MM-DD HH:mm:ss} | {level} | {function}:{line} - {message }-{extra}"),
+        log.get("logging_file_format", " {time:YYYY-MM-DD HH:mm:ss} | {level} | {function}:{line} - {message}-{extra}"),
     )
 
     # User Profile