pyegeria 5.4.3__py3-none-any.whl → 5.4.3.2__py3-none-any.whl

commands/cat/dr_egeria_command_help.py

@@ -17,6 +17,12 @@ from rich.markdown import Markdown
 from rich.prompt import Prompt
 from rich.table import Table
 from rich.text import Text
+from typing import List, Dict, Any
+from html import escape
+try:
+    from markdown_it import MarkdownIt
+except Exception:
+    MarkdownIt = None
 
 from pyegeria import (
     EgeriaTech,
@@ -48,6 +54,40 @@ 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")
 
+def _get_console_width_from_config(default_width: int = EGERIA_WIDTH) -> int:
+    try:
+        from pyegeria.config import settings
+        return int(getattr(settings.Environment, "console_width", default_width) or default_width)
+    except Exception:
+        return default_width
+
+def _get_outbox_dir() -> str:
+    root = os.environ.get("EGERIA_ROOT_PATH", EGERIA_ROOT_PATH)
+    out = os.environ.get("EGERIA_OUTBOX_PATH", EGERIA_OUTBOX_PATH)
+    return os.path.join(root, out)
+
+def _md_to_html(md_text: str) -> str:
+    if not md_text:
+        return ""
+    if MarkdownIt is None:
+        return f"<pre>{escape(md_text)}</pre>"
+    try:
+        return MarkdownIt().render(md_text)
+    except Exception:
+        return f"<pre>{escape(md_text)}</pre>"
+
+def _build_html_table(columns: List[str], rows: List[List[str]]) -> str:
+    ths = ''.join(f'<th>{escape(c)}</th>' for c in columns)
+    body_rows = []
+    for r in rows:
+        tds = []
+        for cell in r:
+            if isinstance(cell, str) and cell.lstrip().startswith('<table'):
+                tds.append(f"<td>{cell}</td>")
+            else:
+                tds.append(f"<td>{escape(cell or '')}</td>")
+        body_rows.append('<tr>' + ''.join(tds) + '</tr>')
+    return '<table>\n<thead><tr>' + ths + '</tr></thead>\n<tbody>\n' + "\n".join(body_rows) + '\n</tbody>\n</table>'
 
 def display_command_terms(
     search_string: str = "*",
@@ -60,6 +100,7 @@ def display_command_terms(
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
     output_format: str = "TABLE",
+    mode: str = "terminal",
 ):
     """Display a table of glossary terms filtered by search_string and glossary, if specified. If no
         filters then all terms are displayed. If glossary_guid or name is specified, then only terms from that
@@ -113,7 +154,7 @@ def display_command_terms(
         elif output_format == "REPORT":
             action = "Report"
         if output_format != "TABLE":
-            file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_OUTBOX_PATH)
+            file_path = _get_outbox_dir()
             file_name = f"Command-Help-{time.strftime('%Y-%m-%d-%H-%M-%S')}-{action}.md"
             full_file_path = os.path.join(file_path, file_name)
             os.makedirs(os.path.dirname(full_file_path), exist_ok=True)
@@ -159,11 +200,11 @@ def display_command_terms(
             page_size=500,
         )
 
-        if type(terms) is str:
+        if isinstance(terms, str):
             print(f"No commands found - this was not the command you were looking for?! - {search_string} : {glossary_guid} ")
             sys.exit(0)
         sorted_terms = sorted(
-            terms, key=lambda k: k["properties"].get("displayName","---")
+            terms, key=lambda k: (k.get("properties") or {}).get("displayName","---")
         )
         style = "bright_white on black"
         if type(terms) is str:
@@ -221,6 +262,62 @@ def display_command_terms(
         g_client.close_session()
         return table
 
+    # Shared fetch for md modes
+    if mode in ("md", "md-html"):
+        try:
+            terms = g_client.find_glossary_terms(search_string, page_size=500)
+        except Exception:
+            terms = []
+        if isinstance(terms, str) and terms == "NO_TERMS_FOUND":
+            print(f"\n==> No commands found for search string '{search_string}'")
+            return
+        # Build outputs
+        out_dir = _get_outbox_dir()
+        os.makedirs(out_dir, exist_ok=True)
+        stamp = time.strftime('%Y-%m-%d-%H-%M-%S')
+        if mode == "md":
+            # Simple sections per term
+            lines: List[str] = []
+            lines.append(f"# Dr.Egeria Commands (search: `{search_string}`)")
+            lines.append("")
+            sorted_terms = sorted(terms, key=lambda t: (t.get("properties") or {}).get("displayName", "---"))
+            for term in sorted_terms:
+                props = term.get("properties") or {}
+                name = props.get("displayName", "---") or "---"
+                desc = props.get("description", "") or ""
+                usage = props.get("usage", "") or ""
+                lines.append(f"## {name}")
+                lines.append("")
+                lines.append("### Description\n")
+                lines.append(desc if desc.strip() else "_No description_")
+                lines.append("")
+                if usage.strip():
+                    lines.append("### Usage\n")
+                    lines.append(usage)
+                    lines.append("")
+                lines.append("---\n")
+            content = "\n".join(lines)
+            file_name = f"Command-Help-{stamp}-md.md"
+        else:
+            # md-html nested tables
+            columns = ["Command", "Description", "Usage"]
+            rows: List[List[str]] = []
+            sorted_terms = sorted(terms, key=lambda t: (t.get("properties") or {}).get("displayName", "---"))
+            for term in sorted_terms:
+                props = term.get("properties") or {}
+                name = props.get("displayName", "---") or "---"
+                desc = props.get("description", "") or ""
+                usage_md = props.get("usage", "") or ""
+                usage_html = _md_to_html(usage_md).strip()
+                rows.append([name, desc, usage_html])
+            content = f"# Dr.Egeria Commands (search: `{search_string}`)\n\n" + _build_html_table(columns, rows) + "\n"
+            file_name = f"Command-Help-{stamp}-md-html.md"
+        full_file_path = os.path.join(out_dir, file_name)
+        with open(full_file_path, 'w', encoding='utf-8') as f:
+            f.write(content)
+        print(f"\n==> Help written to {full_file_path}")
+        return
+
     try:
         with console.pager(styles=True):
             console.print(generate_table(search_string, glossary_guid))
@@ -241,6 +338,8 @@ def main():
     parser.add_argument("--userid", help="User Id")
     parser.add_argument("--password", help="User Password")
     parser.add_argument("--guid", help="GUID of glossary to search")
+    parser.add_argument("--mode", choices=["terminal","md","md-html"], default="terminal", help="Output mode: terminal (default) prints Rich table; md writes Markdown; md-html writes Markdown with HTML tables.")
+    parser.add_argument("--search", help="Search string for commands", default=None)
 
     args = parser.parse_args()
 
@@ -253,13 +352,17 @@ def main():
     guid = args.guid if args.guid is not None else EGERIA_HOME_GLOSSARY_GUID
 
     try:
-        search_string = Prompt.ask("Enter the command you are searching for:", default="*")
+        search_default = args.search or "*"
+        search_string = args.search or Prompt.ask("Enter the command you are searching for:", default=search_default)
 
-        output_format = Prompt.ask("What output format do you want?", choices=["TABLE", "LIST", "REPORT"], default="TABLE")
+        if args.mode == "terminal":
+            output_format = Prompt.ask("What output format do you want?", choices=["TABLE", "LIST", "REPORT"], default="TABLE")
+        else:
+            output_format = "TABLE"
 
         display_command_terms(
-        search_string, guid, 'Egeria-Markdown', server, url,
-            userid, user_pass, output_format= output_format
+            search_string, guid, 'Egeria-Markdown', server, url,
+            userid, user_pass, output_format=output_format, mode=args.mode
         )
 
     except KeyboardInterrupt:

md_processing/__init__.py

@@ -34,15 +34,10 @@ from md_processing.md_commands.data_designer_commands import (process_data_field
                                                               process_data_class_list_command,
                                                               process_data_structure_upsert_command)
 
-from md_processing.md_commands.glossary_commands import (process_glossary_upsert_command, process_glossary_list_command,
-                                                         process_glossary_structure_command,
-                                                         process_category_upsert_command, update_category_parent,
-                                                         process_category_list_command, update_term_categories,
+from md_processing.md_commands.glossary_commands import (process_glossary_upsert_command,
                                                          process_term_upsert_command,
-                                                         process_create_term_term_relationship_command,
-                                                         process_term_list_command, process_term_details_command,
-                                                         process_term_history_command,
-                                                         process_term_revision_history_command)
+                                                         process_link_term_term_relationship_command,
+                                                         )
 from md_processing.md_commands.project_commands import (process_project_upsert_command, process_link_project_dependency_command,
                                                         process_link_project_hierarchy_command)
 # Re-export all functions from the original md_processing_utils.py to maintain backward compatibility
@@ -53,9 +48,9 @@ from md_processing.md_processing_utils.common_md_utils import (render_markdown,
                                                                is_present, find_key_with_value,
                                                                process_provenance_command, set_delete_request_body,
                                                                set_rel_request_body, set_filter_request_body,
-                                                               set_update_body, set_peer_gov_def_request_body,
-                                                                set_gov_prop_body, set_prop_body, set_create_body,
-                                                                GOVERNANCE_POLICIES, GOVERNANCE_CONTROLS, GOVERNANCE_DRIVERS
+                                                               set_update_body, set_peer_gov_def_request_body, set_rel_prop_body,
+                                                               set_gov_prop_body, set_element_prop_body, set_create_body,
+                                                               GOVERNANCE_POLICIES, GOVERNANCE_CONTROLS, GOVERNANCE_DRIVERS
                                                                )
 from md_processing.md_processing_utils.extraction_utils import (extract_command_plus, extract_command,
                                                                 extract_attribute, process_simple_attribute,

md_processing/data/commands.json

@@ -1,6 +1,6 @@
 {
   "Command Specifications": {
-    "exported": "Aug 31, 2025 at 12:03:20 PM",
+    "exported": "Sep 1, 2025 at 7:09:27 AM",
     "Create Governance Driver": {
       "display_name": "Governance Driver",
       "qn_prefix": "GovDriver",
@@ -24270,7 +24270,7 @@
     "Create Collection": {
       "display_name": "Collection",
       "qn_prefix": "Collection",
-      "alternate_names": "Create Root Collection; Create Folder",
+      "alternate_names": "Create Root Collection;Create Folder",
       "family": "Digital Product Manager",
       "description": "Create or update a generic collection. While it can be used to create specific kinds of collections, you cannot set the collection-specific properties - so use the appropriate Dr.Egeria command to set all of the properties.",
       "verb": "Create",
@@ -39945,10 +39945,10 @@
       "Journal Entry": "",
       "Attributes": [
         {
-          "Term  1": {
+          "Term 1": {
             "variable_name": "term_1",
             "inUpdate": true,
-            "attr_labels": "Term Name 1",
+            "attr_labels": "Term Name 1; Term1",
             "examples": "",
             "default_value": "",
             "valid_values": "",
@@ -39969,10 +39969,10 @@
           }
         },
         {
-          "Term  2": {
+          "Term 2": {
             "variable_name": "term_2",
             "inUpdate": true,
-            "attr_labels": "Term Name 2",
+            "attr_labels": "Term Name 2; Term2",
             "examples": "",
             "default_value": "",
             "valid_values": "",
@@ -40015,6 +40015,150 @@
             "level": "Basic",
             "Journal Entry": ""
           }
+        },
+        {
+          "Description": {
+            "variable_name": "description",
+            "inUpdate": true,
+            "attr_labels": "",
+            "examples": "",
+            "default_value": "",
+            "valid_values": "",
+            "existing_element": "",
+            "description": "A description of the Relationship.",
+            "qualified_name_pattern": "",
+            "generated": false,
+            "style": "Simple",
+            "user_specified": true,
+            "unique": false,
+            "input_required": false,
+            "isParent": false,
+            "isAnchor": false,
+            "min_cardinality": 0,
+            "max_cardinality": 1,
+            "level": "Basic",
+            "Journal Entry": ""
+          }
+        },
+        {
+          "Expression": {
+            "variable_name": "expression",
+            "inUpdate": true,
+            "attr_labels": "",
+            "examples": "",
+            "default_value": "",
+            "valid_values": "",
+            "existing_element": "",
+            "description": "An expression describing the relationship.",
+            "qualified_name_pattern": "",
+            "generated": false,
+            "style": "Simple",
+            "user_specified": true,
+            "unique": false,
+            "input_required": false,
+            "isParent": false,
+            "isAnchor": false,
+            "min_cardinality": 1,
+            "max_cardinality": 1,
+            "level": "Advance",
+            "Journal Entry": ""
+          }
+        },
+        {
+          "Confidence": {
+            "variable_name": "confidence",
+            "inUpdate": true,
+            "attr_labels": "",
+            "examples": "",
+            "default_value": "",
+            "valid_values": "",
+            "existing_element": "",
+            "description": "Percent confidence in the relationship.",
+            "qualified_name_pattern": "",
+            "generated": false,
+            "style": "Simple Int",
+            "user_specified": true,
+            "unique": false,
+            "input_required": false,
+            "isParent": false,
+            "isAnchor": false,
+            "min_cardinality": 0,
+            "max_cardinality": 1,
+            "level": "Advanced",
+            "Journal Entry": ""
+          }
+        },
+        {
+          "Status": {
+            "variable_name": "",
+            "inUpdate": true,
+            "attr_labels": "",
+            "examples": "",
+            "default_value": "",
+            "valid_values": "",
+            "existing_element": "",
+            "description": "",
+            "qualified_name_pattern": "",
+            "generated": false,
+            "style": "Simple",
+            "user_specified": true,
+            "unique": false,
+            "input_required": false,
+            "isParent": false,
+            "isAnchor": false,
+            "min_cardinality": 1,
+            "max_cardinality": 1,
+            "level": "Basic",
+            "Journal Entry": ""
+          }
+        },
+        {
+          "Steward": {
+            "variable_name": "steward",
+            "inUpdate": true,
+            "attr_labels": "",
+            "examples": "",
+            "default_value": "",
+            "valid_values": "",
+            "existing_element": "",
+            "description": "Steward responsible.",
+            "qualified_name_pattern": "",
+            "generated": false,
+            "style": "Simple",
+            "user_specified": true,
+            "unique": false,
+            "input_required": false,
+            "isParent": false,
+            "isAnchor": false,
+            "min_cardinality": 0,
+            "max_cardinality": 1,
+            "level": "Advance",
+            "Journal Entry": ""
+          }
+        },
+        {
+          "Source": {
+            "variable_name": "source",
+            "inUpdate": true,
+            "attr_labels": "",
+            "examples": "",
+            "default_value": "",
+            "valid_values": "",
+            "existing_element": "",
+            "description": "Source of the relationship",
+            "qualified_name_pattern": "",
+            "generated": false,
+            "style": "Simple",
+            "user_specified": true,
+            "unique": false,
+            "input_required": false,
+            "isParent": false,
+            "isAnchor": false,
+            "min_cardinality": 0,
+            "max_cardinality": 1,
+            "level": "Advance",
+            "Journal Entry": ""
+          }
         }
       ]
     },

md_processing/dr_egeria.py

@@ -20,13 +20,11 @@ from rich import print
 from rich.console import Console
 
 from md_processing import (extract_command, process_glossary_upsert_command, process_term_upsert_command,
-                           process_category_upsert_command, process_provenance_command, get_current_datetime_string,
+                            process_provenance_command, get_current_datetime_string,
                            process_project_upsert_command, command_list, process_blueprint_upsert_command,
                            process_solution_component_upsert_command, process_component_link_unlink_command,
-                           process_term_list_command,
-                           process_category_list_command, process_glossary_list_command, process_term_history_command,
-                           process_glossary_structure_command, process_term_revision_history_command,
-                           process_create_term_term_relationship_command, process_term_details_command,
+
+                           process_link_term_term_relationship_command,
                            process_information_supply_chain_upsert_command,
                            process_information_supply_chain_link_unlink_command, process_sol_arch_list_command,
                            process_digital_product_upsert_command, process_agreement_upsert_command,
@@ -123,7 +121,7 @@ def process_md_file(input_file: str, output_folder:str, directive: str, server:
             elif potential_command in ["Create Term", "Update Term"]:
                 result = process_term_upsert_command(client, current_block, directive)
             elif potential_command in ["Create Term-Term Relationship", "Update Term-Term Relationship"]:
-                result = process_create_term_term_relationship_command(client, current_block, directive)
+                result = process_link_term_term_relationship_command(client, current_block, directive)
              #
             elif potential_command in LIST_COMMANDS:
                 result = process_output_command(client, current_block, directive)
@@ -132,6 +130,9 @@ def process_md_file(input_file: str, output_folder:str, directive: str, server:
             elif potential_command in ["List Glossaries", "List Terms", "List Glossary Terms", "View Glossaries"
                                        "View Terms", "View Glossary Terms"]:
                 result = process_output_command(client, current_block, directive)
+            elif potential_command in ["Link Termss", "Detach Terms",
+                                       "Link Term-Term Relationship", "Detach Term-Term Relationship"]:
+                result = process_link_term_term_relationship_command(client, current_block, directive)
             elif potential_command in PROJECT_COMMANDS:
                 result = process_project_upsert_command(client, current_block, directive)
             elif potential_command in ["Link Parent Project", "Attach Parent Project", "Detach Parent Project"]:

md_processing/dr_egeria_inbox/glossary_test1.md

@@ -1,3 +1,18 @@
+# Don't Link Term-Term Relationship
+## Term 1
+Term::Calico::2
+
+## Term2
+Term::Siamese::3
+
+## Relationship
+Synonym
+
+## Description
+I'm not sure why they are related
+
+____
+
 # Don't List Glossaries
 ## Output Format
 LIST
@@ -22,7 +37,7 @@ True
 ____
 
 
-# Create Glossary
+# Don't Create Glossary
 
 ## Glossary Name
 
@@ -72,7 +87,7 @@ About Cats
 Dr.Egeria Test
 ____
 
-# Create Term
+# Don't Update Term
 
 ## Glossary
 
@@ -120,7 +135,7 @@ Calico
 About Cats
 ___
 
-# Don't Update Term
+# Don't Create Term
 
 ## Glossary Name
 

md_processing/dr_egeria_inbox/product.md

@@ -1,5 +1,5 @@
 ____
-#  Don't Update Root Collection
+#  Don't Create Root Collection
 ## Name
 GeoSpatial Root
 
@@ -13,7 +13,7 @@ GeoSpatial
 
 ____
 
-#  Don't Update Folder
+# Don't Create Folder
 ## Name
 Digital Products MarketPlace
 
@@ -82,7 +82,7 @@ GeoSpatial
 
 ____
 
-#  Don't Create Digital Product
+# Don't Update Digital Product
 ## Name
 Sentinel-2a
 
@@ -127,12 +127,12 @@ A folder for digital product subscriptions.
 GeoSpatial
 
 ____
-#  Don't Create Digital Subscription
+#  Don't Update Digital Subscription
 ## Name
 GeoSpatial Data Products Subscription
 
 # Qualified Name
-Subscription::GeoSpatial-Data-Products-Subscription
+Subscription::GeoSpatial Data Products Subscription
 
 ## Description
 A general subscription agreement for GeoSpatial Data Products
@@ -145,7 +145,7 @@ Best Effort
 ____
 
 ____
-#  Don't Create Agreement
+#  Don't Update Agreement
 ## Name
 A test agreement
 
@@ -162,7 +162,7 @@ ____
 
 # Don't Link Agreement->Item
 ##  Agreement Name
-Subscription::GeoSpatial-Data-Products-Subscription
+GeoSpatial Data Products Subscription
 
 ## Item Name
 DigitalProduct::Sentinel-2a
@@ -183,11 +183,11 @@ Sentinel-2a-Subscription
 { "Attribution" : "Required"}
 ____
 
-#  Link Subscriber->Subscription
+# Link Subscriber->Subscription
 ##  Subscription
-Subscription::GeoSpatial-Data-Products-Subscription
+Subscription::GeoSpatial Data Products Subscription
 
-## Subscriber
+## Subscriber Id
 Agreement::A-test-agreement
 
 ___
@@ -198,7 +198,7 @@ LIST
 
 ___
 
-#  Don't View Data Sharing Agreements
+# Don't View Data Sharing Agreements
 ## Output Format
 REPORT
 ___