pyegeria 5.4.0.28__py3-none-any.whl → 5.5.3.3__py3-none-any.whl

commands/cat/list_categories.py

@@ -1,192 +0,0 @@
-#!/usr/bin/env python3
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-
-List categories for a category.
-
-
-A simple display for category terms
-"""
-import argparse
-import os
-import sys
-import time
-
-from rich import box
-from rich.console import Console
-from rich.prompt import Prompt
-from rich.table import Table
-from rich.text import Text
-
-from pyegeria import (
-    EgeriaTech,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response,
-)
-
-disable_ssl_warnings = True
-
-EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
-EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9092")
-EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
-EGERIA_VIEW_SERVER = os.environ.get("EGERIA_VIEW_SERVER", "view-server")
-EGERIA_VIEW_SERVER_URL = os.environ.get(
-    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
-)
-EGERIA_INTEGRATION_DAEMON = os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon")
-EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
-EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
-EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
-EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
-EGERIA_JUPYTER = bool(os.environ.get("EGERIA_JUPYTER", "False"))
-EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "150"))
-EGERIA_category_PATH = os.environ.get("EGERIA_category_PATH", None)
-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 display_categories(
-    search_string: str = "*",
-    view_server: str = EGERIA_VIEW_SERVER,
-    view_url: str = EGERIA_VIEW_SERVER_URL,
-    user: str = EGERIA_USER,
-    user_pass: str = EGERIA_USER_PASSWORD,
-    jupyter: bool = EGERIA_JUPYTER,
-    width: int = EGERIA_WIDTH,
-    output_format: str = "TABLE",
-):
-    """Display either a specified category or all categories if the search_string is '*'.
-    Parameters
-    ----------
-    search_string : str, default is '*'
-        The string used to search for categories.
-    view_server : str
-        The view server name or address where the Egeria services are hosted.
-    view_url : str
-        The URL of the platform the view server is on.
-    user : str
-        The user ID for authentication with the Egeria server.
-    user_pass : str
-        The password for authentication with the Egeria server.
-    jupyter : bool, optional
-        A boolean indicating whether the output is intended for a Jupyter notebook (default is EGERIA_JUPYTER).
-    width : int, optional
-        The width of the console output (default is EGERIA_WIDTH).
-    output_format: str, optional, default is 'JSON'
-        One of  FORM, REPORT, TABLE
-    """
-    m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
-    token = m_client.create_egeria_bearer_token()
-
-
-    try:
-        if output_format == "FORM":
-            action = "Update-Form"
-        elif output_format == "REPORT":
-            action = "Report"
-        if output_format != "TABLE":
-            file_path = os.path.join(EGERIA_ROOT_PATH, EGERIA_OUTBOX_PATH)
-            file_name = f"Categories-{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 = m_client.find_glossary_categories(search_string, output_format=output_format)
-            if output == "NO_CATEGORIES_FOUND":
-                print(f"\n==> No categories found for search string '{search_string}'")
-                return
-            with open(full_file_path, 'w') as f:
-                f.write(output)
-            print(f"\n==> Categories output written to {full_file_path}")
-            return
-
-        table = Table(
-            title=f"Category List @ {time.asctime()}",
-            style="bright_white on black",
-            header_style="bright_white on dark_blue",
-            title_style="bold white on black",
-            caption_style="white on black",
-            show_lines=True,
-            box=box.ROUNDED,
-            caption=f"View Server '{view_server}' @ Platform - {view_url}",
-            expand=True,
-        )
-        table.add_column("Category Name")
-        table.add_column(
-            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
-        )
-        table.add_column("Description")
-        table.add_column("In Glossary")
-        table.add_column("Parent Category")
-
-        categories = m_client.find_glossary_categories(search_string)
-        if type(categories) is list:
-            sorted_category_list = sorted(
-                categories, key=lambda k: k["glossaryCategoryProperties"]["displayName"]
-            )
-            for category in sorted_category_list:
-                display_name = category["glossaryCategoryProperties"].get("displayName",'---')
-                qualified_name = category["glossaryCategoryProperties"]["qualifiedName"]
-                category_guid = category["elementHeader"]["guid"]
-                q_name = Text(f"{qualified_name}\n&\n{category_guid}", justify="center")
-                description = category["glossaryCategoryProperties"].get("description",'---')
-                classification_props = category["elementHeader"]['classifications'][0].get('classificationProperties',None)
-                glossary_qualified_name = '---'
-                if classification_props is not None:
-                    glossary_guid = classification_props.get('anchorScopeGUID','---')
-                    glossary_qualified_name = (
-                        m_client.get_glossary_by_guid(glossary_guid))['glossaryProperties']['qualifiedName']
-                cat_info = m_client.get_category_parent(category_guid)
-                if type(cat_info) is dict:
-                    parent_qn = cat_info['glossaryCategoryProperties']['qualifiedName']
-                else:
-                    parent_qn = '---'
-
-
-                table.add_row(display_name, q_name, description, glossary_qualified_name, parent_qn)
-            console = Console(
-                style="bold bright_white on black",
-                width=width,
-                force_terminal=not jupyter,
-            )
-            console.print(table)
-
-    except (InvalidParameterException, PropertyServerException) as e:
-        print_exception_response(e)
-    finally:
-        m_client.close_session()
-
-
-def main():
-    parser = argparse.ArgumentParser()
-    parser.add_argument("--server", help="Name of the server to display status for")
-    parser.add_argument("--url", help="URL Platform to connect to")
-    parser.add_argument("--userid", help="User Id")
-    parser.add_argument("--password", help="User Password")
-
-    args = parser.parse_args()
-
-    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
-    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
-    userid = args.userid if args.userid is not None else EGERIA_USER
-    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
-
-    try:
-        search_string = Prompt.ask(
-            "Enter the category you are searching for or '*' for all:", default="*"
-        )
-        output_format = Prompt.ask("What output format do you want?", choices=["TABLE", "FORM", "REPORT"],
-                                   default="TABLE")
-
-        display_categories(search_string, server, url, userid,
-                           user_pass, output_format = output_format)
-
-    except KeyboardInterrupt:
-        pass
-
-
-if __name__ == "__main__":
-    main()

commands/cat/logs/pyegeria.log

@@ -1,4 +0,0 @@
-2025-08-19 08:03:29 | INFO | main:399 - view server @ https://localhost:9443-{}
-2025-08-19 08:03:31 | SUCCESS | get_platform_origin:367 - Got response from https://localhost:9443/open-metadata/platform-services/users/erinoverview/server-platform/origin
- Response: Egeria OMAG Server Platform (version 5.4-SNAPSHOT)-{}
-2025-08-19 08:03:31 | INFO | __init__:133 - CollectionManager initialized, platform origin is: True-{}

commands/cli/txt_custom_v2.tcss

@@ -1,19 +0,0 @@
-.uprompt {
-    width: auto;
-    height: auto;
-}
-.uimput {
-    border: solid white;
-    height: auto;
-    width: auto;
-}
-.DataTable {
-    color: black
-}
-.DataTable.Row {
-    width: 20%;
-    height: auto;
-}
-#table {
-    color: black
-}

commands/my/README.md

@@ -1,17 +0,0 @@
-<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-<!-- Copyright Contributors to the Egeria project. -->
-
-# Personal Organizer
-
-These widgets display different kinds of information about the projects, tasks and todos. Widgets
-will continue to be added over time to cover more facets of catalog use.
-
-* get_my_profiles.py - gets profile information about an individual.
-* list_projects.py - lists information about a specified project or projects containing the search string.
-* list_todos.py - lists information about a specified todo item or all todos containing the search string
-* view_my_todos.py - view live status information about an individual's todos.
-* view_open_todos.py - view live status information about open todos.
-
-----
-License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
-Copyright Contributors to the Egeria project.

commands/ops/README.md

@@ -1,24 +0,0 @@
-<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-<!-- Copyright Contributors to the Egeria project. -->
-
-# Operational
-
-These widgets display different kinds of information useful to monitor the status of different elements of an Egeria deployment.
-Widgets will continue to be added over time to cover more facets of catalog use.
-
-* get_eng_action_status.py - lists assets containing the user provided search string in the display name or qualified name. Search string must be a minimum of three characters.
-* get_tech_type_elements.py - shows a tree view for the details of a supported technology type.
-* get_tech_type_template.py - shows a tree view of the template associated with a supported technology type.
-* view_coco_status.py - provides a tree view of a collection with all nested collections and items within the collection.
-* view_eng_action_status.py - provides a live view of the status of engine actions.
-* view_gov_eng_status.py - provides a live view of a governance engine status.
-* view_integ_daemeon_status.py - provides a live view of an integration daemon status.
-* view_platform_status.py - provides a live status view of the known servers on known platforms.
-* view_server_list.py - provides a more detailed live status view of the servers on a single platform.
-* view_server_status.py - provides a minimal live status view of the servers on a single platform.
-* view_asset_changes.py - experiment in progress
-* view_asset_events.py - experiment in progress
-
-----
-License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
-Copyright Contributors to the Egeria project.

commands/ops/monitor_asset_events.py

@@ -1,108 +0,0 @@
-#!/usr/bin/env python3
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-
-Display the status of cataloged platforms and servers.
-"""
-import argparse
-import json
-import os
-import time
-from datetime import datetime
-
-from confluent_kafka import Consumer, KafkaException
-from rich.console import Console
-from rich.live import Live
-from rich.markdown import Markdown
-from rich.prompt import Prompt
-from rich.table import Table
-
-EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
-EGERIA_KAFKA_ENDPOINT = os.environ.get("KAFKA_ENDPOINT", "localhost:9192")
-EGERIA_PLATFORM_URL = os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443")
-EGERIA_VIEW_SERVER = os.environ.get("EGERIA_VIEW_SERVER", "view-server")
-EGERIA_VIEW_SERVER_URL = os.environ.get(
-    "EGERIA_VIEW_SERVER_URL", "https://localhost:9443"
-)
-EGERIA_INTEGRATION_DAEMON = os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon")
-EGERIA_ADMIN_USER = os.environ.get("ADMIN_USER", "garygeeke")
-EGERIA_ADMIN_PASSWORD = os.environ.get("ADMIN_PASSWORD", "secret")
-EGERIA_USER = os.environ.get("EGERIA_USER", "erinoverview")
-EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
-EGERIA_JUPYTER = os.environ.get("EGERIA_JUPYTER", False)
-EGERIA_WIDTH = os.environ.get("EGERIA_WIDTH", 200)
-
-
-def main(ep: str = EGERIA_KAFKA_ENDPOINT):
-    disable_ssl_warnings = True
-    console = Console(width=200)
-    now = datetime.now()
-    current_time = now.strftime("%H:%M:%S")
-
-    earliest_latest = Prompt.ask("Msgs from earliest or latest:", default="earliest")
-
-    # Define the Kafka consumer configuration.
-    config = {
-        "bootstrap.servers": ep,  # replace with your Kafka broker(s)
-        "group.id": f"view_asset_events:{current_time}",  # replace with your consumer group
-        "auto.offset.reset": earliest_latest,  # can be set to 'earliest' or 'latest'
-    }
-    print(f"Kafka config is {json.dumps(config)}")
-    # Initialize a Kafka consumer.
-    consumer = Consumer(config)
-
-    # Subscribe to a Kafka topic.
-    consumer.subscribe(
-        ["egeria.omag.server.active-metadata-store.omas.assetconsumer.outTopic"]
-    )  # replace with your Kafka topic
-
-    try:
-        while True:
-            msg = consumer.poll(2.0)  # timeout set to 1 second
-
-            if msg is None:
-                continue
-            elif msg.error():
-                raise KafkaException(msg.error())
-            else:
-                event = json.loads(msg.value())
-                event_time = event["eventTime"]
-                event_type = event["eventType"]
-                guid = event["elementHeader"]["guid"]
-
-                type_name = event["elementHeader"]["type"]["typeName"]
-                origin = event["elementHeader"]["origin"]["sourceServer"]
-
-                element_properties = event["elementProperties"]
-                element_properties_keys = element_properties.keys()
-                props = " "
-                for key in element_properties_keys:
-                    value = element_properties[key]
-                    props += f"* {key}: {value}\n"
-                console.rule(style="[bold red]")
-                console.rule(
-                    f"\tMessage TimeStamp: {event_time}\t eventType: {event_type}\t typeName: {type_name}\t guid: {guid}"
-                )
-                msg = f"properties: \n[bright white on black]{props}\n\n"
-                msg = Markdown(msg)
-
-                console.print(msg)
-
-    except KeyboardInterrupt:
-        pass
-
-    finally:
-        # Close down consumer to commit final offsets.
-        consumer.close()
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser()
-
-    parser.add_argument("--ep", help="Endpoint to connect to")
-    args = parser.parse_args()
-
-    ep = args.ep if args.ep is not None else EGERIA_KAFKA_ENDPOINT
-
-    main(ep)

commands/tech/README.md

@@ -1,24 +0,0 @@
-<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-<!-- Copyright Contributors to the Egeria project. -->
-
-# Developer
-
-These widgets display different kinds of information useful to developers. Widgets
-will continue to be added over time to cover more facets. Useful developer information
-can also be found on [Egeria Project](https://egeria-project.org) and in [Egeria Explorers](https://egeria-project.org/release-notes/june-2024/?h=brain#egeria-explorers).
-
-* get_guid_info.py - lists information about the metadata element specified by the Egeria guid.
-* get_tech_details.py - shows a tree view showing the Egeria support for a particular technology (e.g PostgreSQL Server).
-* list_asset_types.py - provides a tree view of a collection with all nested collections and items within the collection.
-* list_registered_services.py - lists the services available on an Egeria platform.
-* list_relationship_types.py - list the relationships details for a specified Egeria type.
-* list_tech_templates.py - list template details for technology types
-* list_tech_types.py - list the technology types that Egeria currently supports
-* list_valid_metadata_values.py - list valid metadata values for a particular property and category.
-
-
-
-
-----
-License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
-Copyright Contributors to the Egeria project.

md_processing/dr-egeria-outbox/Collections-2025-08-12-13-30-37.md

@@ -1,163 +0,0 @@
-# Common Collection Information
-Attributes generic to all Collections.
-
-# Collections Report - created at 2025-08-12 13:30
-	Collections  found from the search string:  `All`
-
-<a id="39ad6f57-b830-43c1-b494-dc0fd17e8076"></a>
-# Collections Name: Digital Products MarketPlace
-
-## Display Name
-Digital Products MarketPlace
-
-## Qualified Name
-[Folder::Digital-Products-MarketPlace](#39ad6f57-b830-43c1-b494-dc0fd17e8076)
-
-## Category
-GeoSpatial
-
-## Description
-This is the digital products marketplace
-
-[[Commons]]
----
-
-<a id="339104dd-2ad1-4307-aa9f-d258d31979f9"></a>
-# Collections Name: NDVI - Sentinel 2 derived
-
-## Display Name
-NDVI - Sentinel 2 derived
-
-## Qualified Name
-[DigitalProduct::NDVI---Sentinel-2-derived](#339104dd-2ad1-4307-aa9f-d258d31979f9)
-
-## Category
-GeoSpatial
-
-## Description
-NDVI vegetation index calculated from Sentinel 2 imagery
-
-[[Commons]]
----
-
-<a id="ac371edf-2cb0-4aba-8f23-885b6264fa1e"></a>
-# Collections Name: Raw Satellite Imagery Products
-
-## Display Name
-Raw Satellite Imagery Products
-
-## Qualified Name
-[Folder::Raw-Satellite-Imagery-Products](#ac371edf-2cb0-4aba-8f23-885b6264fa1e)
-
-## Category
-GeoSpatial
-
-## Description
-Raw satellite imagery imported from or referenced from satellite data providers
-
-[[Commons]]
----
-
-<a id="69951b65-2bbc-42ea-bfee-a68594c5a4fe"></a>
-# Collections Name: GeoSpatial Root
-
-## Display Name
-GeoSpatial Root
-
-## Qualified Name
-[myLocal::RootCollection::GeoSpatial-Root](#69951b65-2bbc-42ea-bfee-a68594c5a4fe)
-
-## Category
-GeoSpatial
-
-## Description
-This is the root of the GeoSpatial work
-
-[[Commons]]
----
-
-<a id="f977a2e4-4d9a-485d-9640-88fae71b0f13"></a>
-# Collections Name: Agricultural Products
-
-## Display Name
-Agricultural Products
-
-## Qualified Name
-[Folder::Agricultural-Products](#f977a2e4-4d9a-485d-9640-88fae71b0f13)
-
-## Category
-GeoSpatial
-
-## Description
-Agricultural product offerings
-
-[[Commons]]
----
-
-<a id="866a49cf-0cf6-47c9-9cef-4b8f4870770a"></a>
-# Collections Name: Sentinel-2a
-
-## Display Name
-Sentinel-2a
-
-## Qualified Name
-[DigitalProduct::Sentinel-2a](#866a49cf-0cf6-47c9-9cef-4b8f4870770a)
-
-## Category
-GeoSpatial
-
-## Description
-Level 2a (surface level) imagery
-
-[[Commons]]
----
-
-<a id="c2e4b651-c3e9-44a4-97f9-8ac5b293f6b5"></a>
-# Collections Name: GeoSpatial Products
-
-## Display Name
-GeoSpatial Products
-
-## Qualified Name
-[Folder::GeoSpatial-Products](#c2e4b651-c3e9-44a4-97f9-8ac5b293f6b5)
-
-## Category
-GeoSpatial
-
-## Description
-GeoSpatial product offerings
-
-[[Commons]]
----
-
-<a id="76a2bdf8-03c8-4080-9ead-6348c1641764"></a>
-# Collections Name: Prepared Imagery Products
-
-## Display Name
-Prepared Imagery Products
-
-## Qualified Name
-[Folder::Prepared-Imagery-Products](#76a2bdf8-03c8-4080-9ead-6348c1641764)
-
-## Category
-GeoSpatial
-
-## Description
-Imagery products that are ready for consumption
-
-[[Commons]]
----
-
-<a id="533a0346-b047-485a-82ea-05db671ab485"></a>
-# Collections Name: Open Metadata Connector Type Directory
-
-## Display Name
-Open Metadata Connector Type Directory
-
-## Qualified Name
-OpenMetadataConnectorTypeDirectory_09450b83-20ff-4a8b-a8fb-f9b527bbcba6
-
-## Description
-Open Metadata standard connector categories and connector types.
-
-[[Commons]]