pyegeria 5.4.7.9__tar.gz → 5.4.8__tar.gz

{pyegeria-5.4.7.9/pyegeria.egg-info → pyegeria-5.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyegeria
-Version: 5.4.7.9
+Version: 5.4.8
 Summary: A python client for Egeria
 Author-email: Dan Wolfson <dan.wolfson@pdr-associates.com>
 License-Expression: Apache-2.0
@@ -19,7 +19,7 @@ Requires-Dist: jupyter
 Requires-Dist: click
 Requires-Dist: trogon
 Requires-Dist: mermaid-py
-Requires-Dist: psycopg2-binary
+Requires-Dist: psycopg2-binary>=2.9.11
 Requires-Dist: jupyter-notebook-parser
 Requires-Dist: loguru
 Requires-Dist: inflect
@@ -30,6 +30,9 @@ Requires-Dist: wcwidth
 Requires-Dist: altair
 Requires-Dist: modelcontextprotocol
 Requires-Dist: mcp>=1.15.0
+Requires-Dist: markers>=0.3.0
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
 
 <!-- SPDX-License-Identifier: CC-BY-4.0 -->
@@ -57,6 +60,9 @@ to visualize and use Egeria. The commands also serve as useful examples.
 
 An examples folder holds some useful examples showing different facets of using pyegeria.
 
+For detailed guidance on report formats (selection, dynamic loading, runtime registration, and migration from columns→attributes), see:
+- examples/doc_samples/report_formats.md
+
 WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and 
 evolve.
 
@@ -142,10 +148,34 @@ print(cfg.Logging.enable_logging)
   python scripts/validate_env.py --env config/env
   python scripts/validate_env.py               # auto-detects ./config/env or ./.env
 
-- Run tests (requires Poetry):
+### Testing
+
+By default, running pytest executes unit tests that use monkeypatching/fakes and do not contact a live Egeria.
+
+- Run unit tests (recommended default):
   poetry install
   poetry run pytest -v
 
+You can also run tests live against a local Egeria instance. Enable live mode with either a CLI flag or an environment variable. In live mode, tests marked as `unit` are skipped and live tests run using a real Client2 connection.
+
+- Enable live mode via CLI:
+  poetry run pytest -q --live-egeria
+
+- Or enable via environment variable:
+  PYEG_LIVE_EGERIA=1 poetry run pytest -q
+
+Default live connection parameters (can be overridden via env):
+- server_name = "qs-view-server"           (override with PYEG_SERVER_NAME)
+- platform_url = "https://localhost:9443" (override with PYEG_PLATFORM_URL)
+- user_id = "peterprofile"                (override with PYEG_USER_ID)
+- user_pwd = "secret"                      (override with PYEG_USER_PWD)
+
+Notes:
+- SSL verification is controlled by pyegeria._globals.enable_ssl_check, which defaults to False in this repo to support localhost/self-signed certs.
+- See tests/conftest.py for the live test fixtures and switches.
+
+### Troubleshooting
+
 ### Troubleshooting
 
 - If your env doesn’t seem to apply, confirm which config.json is used (the loader checks PYEGERIA_CONFIG_DIRECTORY first, then PYEGERIA_ROOT_PATH, then ./config.json).

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/README.md

@@ -23,6 +23,9 @@ to visualize and use Egeria. The commands also serve as useful examples.
 
 An examples folder holds some useful examples showing different facets of using pyegeria.
 
+For detailed guidance on report formats (selection, dynamic loading, runtime registration, and migration from columns→attributes), see:
+- examples/doc_samples/report_formats.md
+
 WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and 
 evolve.
 
@@ -108,10 +111,34 @@ print(cfg.Logging.enable_logging)
   python scripts/validate_env.py --env config/env
   python scripts/validate_env.py               # auto-detects ./config/env or ./.env
 
-- Run tests (requires Poetry):
+### Testing
+
+By default, running pytest executes unit tests that use monkeypatching/fakes and do not contact a live Egeria.
+
+- Run unit tests (recommended default):
   poetry install
   poetry run pytest -v
 
+You can also run tests live against a local Egeria instance. Enable live mode with either a CLI flag or an environment variable. In live mode, tests marked as `unit` are skipped and live tests run using a real Client2 connection.
+
+- Enable live mode via CLI:
+  poetry run pytest -q --live-egeria
+
+- Or enable via environment variable:
+  PYEG_LIVE_EGERIA=1 poetry run pytest -q
+
+Default live connection parameters (can be overridden via env):
+- server_name = "qs-view-server"           (override with PYEG_SERVER_NAME)
+- platform_url = "https://localhost:9443" (override with PYEG_PLATFORM_URL)
+- user_id = "peterprofile"                (override with PYEG_USER_ID)
+- user_pwd = "secret"                      (override with PYEG_USER_PWD)
+
+Notes:
+- SSL verification is controlled by pyegeria._globals.enable_ssl_check, which defaults to False in this repo to support localhost/self-signed certs.
+- See tests/conftest.py for the live test fixtures and switches.
+
+### Troubleshooting
+
 ### Troubleshooting
 
 - If your env doesn’t seem to apply, confirm which config.json is used (the loader checks PYEGERIA_CONFIG_DIRECTORY first, then PYEGERIA_ROOT_PATH, then ./config.json).

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/commands/cat/dr_egeria_command_help.py

@@ -151,7 +151,7 @@ def display_command_terms(
             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)
-            output = g_client.find_glossary_terms(search_string,  output_format=output_format, output_format_set="Help-Terms")
+            output = g_client.find_glossary_terms(search_string,  output_format=output_format, report_spec="Help-Terms")
             if output == "NO_TERMS_FOUND":
                 print(f"\n==> No commands found for search string '{search_string}'")
                 return

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/commands/cat/list_collections.py

@@ -36,7 +36,7 @@ config_logging()
 out_struct = {
             "formats": {
                 "types": ["ALL"],
-                "columns": [
+                "attributes": [
                     {'name': 'display_name', 'key': 'display_name'},
                     {'name': 'qualified_name', 'key': 'qualified_name', 'format': True},
                     {'name': 'description', 'key': 'description', 'format': True},
@@ -139,7 +139,7 @@ def display_collections(
 
         collections = m_client.find_collections(
             search_string.strip(), None, ["Collection"],True, False, ignore_case=True,
-            output_format = "DICT", output_format_set=out_struct
+            output_format = "DICT", report_spec=out_struct
         )
         if type(collections) is list:
 

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/commands/cat/run_report.py

@@ -3,7 +3,7 @@
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-A command that takes an output format set name, looks up the format set using select_output_format_set,
+A command that takes an output format set name, looks up the format set using select_report_spec,
 and invokes the specified function with parameters filled from command line arguments.
 
 This command works with any format set defined in output_formatter.py that has an "action" property.
@@ -55,12 +55,12 @@ from pyegeria import (
     NO_ELEMENTS_FOUND, GovernanceOfficer, GlossaryManager, print_validation_error,
 )
 from pyegeria.config import settings
-from pyegeria.external_references import ExternalReferences
+from pyegeria.external_links import ExternalReferences
 from pyegeria.logging_configuration import config_logging
 from pyegeria._output_format_models import load_format_sets_from_json
-from pyegeria._output_formats import (select_output_format_set, get_output_format_set_heading,
-                                      load_user_format_sets, load_output_format_sets,
-                                       get_output_format_set_description)
+from pyegeria.base_report_formats import (select_report_format, get_report_format_heading,
+                                          load_user_report_specs, load_report_specs,
+                                          get_report_format_description)
 from pyegeria._exceptions_new import PyegeriaException, print_exception_response
 
 # pydevd_pycharm.settrace('host.docker.internal',  # Use 'host.docker.internal' to connect to the host machine
@@ -122,7 +122,7 @@ def execute_format_set_action(
     # Get the output format set
     # logger.info(f"Entering execute_format_set_action, format set name: {format_set_name}, search_string: {kwargs.get('search_string',"meow")}")
     # logger.info(json.dumps(kwargs, indent=2))
-    format_set = select_output_format_set(format_set_name, output_format)
+    format_set = select_report_format(format_set_name, output_format)
     if not format_set:
         print(f"Error: Output format set '{format_set_name}' does not have a format compatible with output format '{output_format}'.")
         return
@@ -154,7 +154,7 @@ def execute_format_set_action(
     params.update(spec_params)
 
     params['output_format'] = output_format
-    params['output_format_set'] = format_set_name
+    params['report_spec'] = format_set_name
 
     # Determine the appropriate client class based on the format set name or function
     client_class = None
@@ -206,8 +206,8 @@ def execute_format_set_action(
     client.create_egeria_bearer_token()
 
     # Get heading and description information
-    heading = get_output_format_set_heading(format_set_name)
-    desc = get_output_format_set_description(format_set_name)
+    heading = get_report_format_heading(format_set_name)
+    desc = get_report_format_description(format_set_name)
     preamble = f"# {heading}\n{desc}\n\n" if heading and desc else ""
 
     try:
@@ -366,14 +366,14 @@ def main():
 
     # Get the format set to determine parameters
     format_set_name = initial_args.report
-    format_set = select_output_format_set(format_set_name, "ANY")
+    format_set = select_report_format(format_set_name, "ANY")
 
     # Check if the format set exists
     if not format_set:
         print(f"Error: Format set for '{format_set_name}' not found.")
         print("Available format sets:")
-        from pyegeria._output_formats import output_format_set_list
-        for name in output_format_set_list():
+        from pyegeria.base_report_formats import report_spec_list
+        for name in report_spec_list():
             print(f"  - {name}")
         return
     

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/commands/ops/list_archives.py

@@ -81,9 +81,7 @@ def display_archive_list(
         open_metadata_type_name = None
         property_value = "omarchive"
         property_names = ["fileExtension"]
-        archives = c_client.get_elements_by_property_value(
-            property_value, property_names, open_metadata_type_name
-        )
+        archives = c_client.get_elements_by_property_value(property_value, property_names, open_metadata_type_name)
 
         if type(archives) != list:
             raise ValueError("--> No archives found")

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/examples/GeoSpatial Products Example.py

@@ -25,7 +25,7 @@ from pyegeria import (
 )
 from pyegeria.config import settings, get_app_config
 from pyegeria.logging_configuration import config_logging
-from pyegeria._output_formats import (select_output_format_set, get_output_format_set_heading, get_output_format_set_description)
+from pyegeria.base_report_formats import (select_report_spec, get_report_spec_heading, get_report_spec_description)
 from pyegeria._exceptions_new import (PyegeriaException, print_basic_exception, print_validation_error,
                                       PyegeriaInvalidParameterException, PyegeriaConnectionException,
                                       PyegeriaAPIException, PyegeriaUnknownException, print_exception_table
@@ -92,7 +92,7 @@ try:
     qualified_name = client.__create_qualified_name__("Folder", display_name)
 
     props_body = {
-        "class": "CollectionProperties",
+        "class": "DigitalProductCatalogProperties",
         "qualifiedName": qualified_name,
         "displayName": display_name,
         "description": description,
@@ -115,7 +115,7 @@ try:
         marketplace_guid = marketplace[0]['elementHeader']['guid']
         print(f"Found marketplace guid of {marketplace_guid}")
     else:
-        marketplace_guid = client.create_folder_collection(body=request_body)
+        marketplace_guid = client.create_digital_product_catalog(body=request_body)
         logger.success(f"Created folder collection for marketplace: {marketplace_guid}")
     #
     # GeoSpatial Products folder
@@ -126,7 +126,7 @@ try:
     qualified_name = client.__create_qualified_name__("Folder", display_name)
 
     props_body = {
-        "class": "CollectionProperties",
+        "class": "DigitalProductCatalogProperties",
         "qualifiedName": qualified_name,
         "displayName": display_name,
         "description": description,
@@ -148,7 +148,7 @@ try:
         geo_prods_guid = geo_prods[0]['elementHeader']['guid']
         print(f"Found geo_prods guid of {geo_prods_guid}")
     else:
-        geo_prods_guid = client.create_folder_collection(body=request_body)
+        geo_prods_guid = client.create_digital_product_catalog(body=request_body)
         logger.success(f"Created folder collection for geoprods: {geo_prods_guid}")
     #
     #   Agricultural Products Folder
@@ -160,7 +160,7 @@ try:
 
     props_body = {
 
-        "class": "CollectionProperties",
+        "class": "DigitalProductCatalogProperties",
         "qualifiedName": qualified_name,
         "displayName": display_name,
         "description": description,
@@ -183,7 +183,7 @@ try:
         ag_prods_guid = ag_prods[0]['elementHeader']['guid']
         print(f"Found ag_prods guid of {ag_prods_guid}")
     else:
-        ag_prods_guid = client.create_folder_collection(body=request_body)
+        ag_prods_guid = client.create_digital_product_catalog(body=request_body)
         logger.success(f"Created folder collection for  ag products: {ag_prods_guid}")
     #
     #   Folder to hold Prepared Imagery Products
@@ -194,7 +194,7 @@ try:
     qualified_name = client.__create_qualified_name__("Folder", display_name)
 
     props_body = {
-        "class": "CollectionProperties",
+        "class": "DigitalProductCatalogProperties",
         "qualifiedName": qualified_name,
         "displayName": display_name,
         "description": description,
@@ -216,7 +216,7 @@ try:
         prepared_imagery_guid = prepared_imagery[0]['elementHeader']['guid']
         print(f"Found prepared_imagery guid of {prepared_imagery_guid}")
     else:
-        prepared_imagery_guid = client.create_folder_collection(body=request_body)
+        prepared_imagery_guid = client.create_digital_product_catalog(body=request_body)
         logger.success(f"Created folder for prepared imagery products: {prepared_imagery_guid}")
     #
     #   A digital product covering NDVI - derived from Sentinel 2
@@ -266,7 +266,7 @@ try:
     qualified_name = client.__create_qualified_name__("Folder", display_name)
 
     props_body = {
-        "class": "CollectionProperties",
+        "class": "DigitalProductCatalogProperties",
         "qualifiedName": qualified_name,
         "displayName": display_name,
         "description": description,
@@ -288,7 +288,7 @@ try:
         raw_imagery_guid = raw_imagery[0]['elementHeader']['guid']
         print(f"Found raw_imagery guid of {raw_imagery_guid}")
     else:
-        raw_imagery_guid = client.create_folder_collection(body=request_body)
+        raw_imagery_guid = client.create_digital_product_catalog(body=request_body)
         logger.success(f"Created folder for raw imagery products: {raw_imagery_guid}")
     #
     #   A digital product providing Sentinel-2a imagery

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/examples/format_sets/all_format_sets.json

@@ -9,7 +9,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -129,7 +129,7 @@
         "types": [
           "DICT"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -176,7 +176,7 @@
         "types": [
           "TABLE"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -203,7 +203,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -255,7 +255,7 @@
         "types": [
           "DICT"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -302,7 +302,7 @@
         "types": [
           "TABLE"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -351,7 +351,7 @@
         "types": [
           "REPORT"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -444,7 +444,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -487,7 +487,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -542,7 +542,7 @@
           "REPORT",
           "HTML"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -574,7 +574,7 @@
         "types": [
           "MERMAID"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -591,7 +591,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -647,7 +647,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -699,7 +699,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -747,7 +747,7 @@
         "types": [
           "TABLE"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -780,7 +780,7 @@
           "DICT",
           "LIST"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -814,7 +814,7 @@
           "MERMAID",
           "HTML"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -856,7 +856,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/examples/format_sets/custom_format_sets.json

@@ -12,7 +12,7 @@
         "types": [
           "TABLE"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "ID",
             "key": "id",
@@ -35,7 +35,7 @@
           "DETAIL",
           "FORM"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "ID",
             "key": "id",
@@ -78,7 +78,7 @@
           "TECHNICAL",
           "DICT"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "ID",
             "key": "id",
@@ -135,7 +135,7 @@
         "types": [
           "TABLE"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "ID",
             "key": "id",
@@ -158,7 +158,7 @@
           "DETAIL",
           "FORM"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "ID",
             "key": "id",
@@ -201,7 +201,7 @@
           "FULL",
           "REPORT"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "ID",
             "key": "id",

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/examples/format_sets/subset_format_sets.json

@@ -23,7 +23,7 @@
         "types": [
           "DICT"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -70,7 +70,7 @@
         "types": [
           "TABLE"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -97,7 +97,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",
@@ -148,7 +148,7 @@
         "types": [
           "ALL"
         ],
-        "columns": [
+        "attributes": [
           {
             "name": "Display Name",
             "key": "display_name",

{pyegeria-5.4.7.9 → pyegeria-5.4.8}/examples/format_sets_save_load_example.py

@@ -22,12 +22,12 @@ from pathlib import Path
 sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 
 from pyegeria._output_format_models import Column, Format, ActionParameter, FormatSet, FormatSetDict
-from pyegeria._output_formats import (
-    output_format_sets,
-    save_output_format_sets,
-    load_output_format_sets,
+from pyegeria.base_report_formats import (
+    report_specs,
+    save_report_specs,
+    load_report_specs,
     USER_FORMAT_SETS_DIR,
-    select_output_format_set,
+    select_report_spec,
 )
 
 def create_custom_format_sets():
@@ -143,7 +143,7 @@ def save_format_sets_example(custom_format_sets):
     
     # Save all format sets to a file
     all_format_sets_path = os.path.join(example_dir, "all_format_sets.json")
-    save_output_format_sets(all_format_sets_path)
+    save_report_specs(all_format_sets_path)
     print(f"Saved all format sets to {all_format_sets_path}")
     
     # Save only the custom format sets to a file
@@ -153,7 +153,7 @@ def save_format_sets_example(custom_format_sets):
     
     # Save a subset of the predefined format sets to a file
     subset_format_sets_path = os.path.join(example_dir, "subset_format_sets.json")
-    save_output_format_sets(subset_format_sets_path, format_set_names=["Collections", "DataDictionary"])
+    save_report_specs(subset_format_sets_path, format_set_names=["Collections", "DataDictionary"])
     print(f"Saved subset of format sets to {subset_format_sets_path}")
     
     return custom_format_sets_path
@@ -199,12 +199,12 @@ def use_loaded_format_sets(loaded_format_sets):
     """
     print("\n=== Using Loaded Format Sets ===")
     
-    # Add the loaded format sets to the global output_format_sets
+    # Add the loaded format sets to the global report_specs
     for name, format_set in loaded_format_sets.items():
-        output_format_sets[name] = format_set
+        report_specs[name] = format_set
     
-    # Use the select_output_format_set function to get a format set by name
-    product_format_set = select_output_format_set("Product", "TABLE")
+    # Use the select_report_spec function to get a format set by name
+    product_format_set = select_report_spec("Product", "TABLE")
     if product_format_set:
         print(f"Found format set for 'Product' with output type 'TABLE'")
         print(f"  Heading: {product_format_set['heading']}")
@@ -213,8 +213,8 @@ def use_loaded_format_sets(loaded_format_sets):
     else:
         print("Format set for 'Product' not found")
     
-    # Use the select_output_format_set function to get a format set by alias
-    customer_format_set = select_output_format_set("Customers", "DETAIL")
+    # Use the select_report_spec function to get a format set by alias
+    customer_format_set = select_report_spec("Customers", "DETAIL")
     if customer_format_set:
         print(f"Found format set for 'Customers' with output type 'DETAIL'")
         print(f"  Heading: {customer_format_set['heading']}")
@@ -257,14 +257,14 @@ def user_format_sets_directory_example(custom_format_sets):
     print(f"Saved user custom format set to {user_format_sets_path}")
     
     # Load the user format sets
-    from pyegeria._output_formats import load_user_format_sets
-    load_user_format_sets()
+    from pyegeria.base_report_formats import load_user_report_specs
+    load_user_report_specs()
     
     # Check if the user format set was loaded
-    if "UserCustomFormatSet" in output_format_sets:
+    if "UserCustomFormatSet" in report_specs:
         print("User custom format set was successfully loaded")
-        print(f"  Heading: {output_format_sets['UserCustomFormatSet'].heading}")
-        print(f"  Description: {output_format_sets['UserCustomFormatSet'].description}")
+        print(f"  Heading: {report_specs['UserCustomFormatSet'].heading}")
+        print(f"  Description: {report_specs['UserCustomFormatSet'].description}")
     else:
         print("User custom format set was not loaded")