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

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.

pyegeria/README.md

@@ -1,35 +0,0 @@
-<!-- SPDX-License-Identifier: CC-BY-4.0 -->
-<!-- Copyright Contributors to the ODPi Egeria project. -->
-
-![Egeria Logo](https://egeria-project.org/assets/images/egeria-header.png)
-
-[![GitHub](https://img.shields.io/github/license/odpi/egeria)](LICENSE)
-
-
-# pyegeria: a python client for Egeria
-
-This is a package for easily using the Egeria
-open metadata environment from python. Details about the
-open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
-
-This package is in active development. There is initial
-support for many of Egeria's services including configuration and operation.  This client depends on 
-This release supports Egeria 5.1 and above - although most of the functions may work on earlier versions of Egeria as well. 
-
-The code is organized to mimic the existing Egeria Java Client structure.
-
-WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and 
-evolve.
-
-All feedback is welcome. Please engage via our [community](http://egeria-project.org/guides/community/), 
-team calls, or via github issues in this repo. If interested in contributing,
-you can engage via the community or directly reach out to
-[dan.wolfson\@pdr-associates.com](mailto:dan.wolfson@pdr-associates.com?subject=pyegeria).
-
-This is a learning experience.
-
-
-
-----
-License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
-Copyright Contributors to the ODPi Egeria project.

pyegeria/_globals.py

@@ -1,47 +0,0 @@
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-"""
-
-"""
-This common file is used to set some global values and enumerations used by the overall package. 
-
-"""
-
-
-is_debug = False
-disable_ssl_warnings = True
-enable_ssl_check = False
-max_paging_size = 500
-default_time_out = 30
-DEBUG_LEVEL = "quiet"
-comment_types = (
-    "ANSWER",
-    "OTHER",
-    "QUESTION",
-    "STANDARD_COMMENT",
-    "SUGGESTION",
-    "USAGE_EXPERIENCE",
-)
-star_ratings = (
-    "FIVE_STARS",
-    "FOUR_STARS",
-    "NO_RECOMMENDATION",
-    "ONE_STAR",
-    "THREE_STARS",
-    "TWO_STARS",
-)
-
-TEMPLATE_GUIDS: dict = {}
-INTEGRATION_GUIDS: dict = {}
-
-NO_ELEMENTS_FOUND = "No elements found"
-NO_ASSETS_FOUND = "No assets found"
-NO_SERVERS_FOUND = "No servers found"
-NO_CATALOGS_FOUND = "No catalogs found"
-NO_GLOSSARIES_FOUND = "No glossaries found"
-NO_TERMS_FOUND = "No terms found"
-NO_CATEGORIES_FOUND = "No categories found"
-NO_ELEMENT_FOUND = "No element found"
-NO_PROJECTS_FOUND = "No projects found"
-NO_COLLECTION_FOUND = "No collection found"

pyegeria/_validators.py

@@ -1,385 +0,0 @@
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-"""
-
-import inspect
-import json
-from json import JSONDecodeError
-
-import validators
-
-from pyegeria._exceptions import InvalidParameterException, OMAGCommonErrorCode
-
-"""
-This package contains internally used validators.
-
-"""
-
-
-def validate_user_id(user_id: str) -> bool:
-    """
-    Validate that the provided user id is neither null nor empty.
-
-    Parameters
-    ----------
-    user_id : str  The user id string to validate
-
-    Returns
-    -------
-    bool: True if valid, If invalid an InvalidParameterException is raised.
-
-    Raises
-    ------
-    InvalidParameterException
-        If the provided user id is null or empty
-    """
-    if (user_id is None) or len(user_id) == 0:
-        msg = str(OMAGCommonErrorCode.NULL_USER_ID.value["message_template"]).format(
-            "user_id"
-        )
-        calling_frame = inspect.currentframe().f_back
-        caller_method = inspect.getframeinfo(calling_frame).function
-
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": user_id,
-                "exceptionSystemAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"user_id": user_id},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def validate_server_name(server_name: str) -> bool:
-    """
-    Validate that the provided server name is neither null nor empty.
-
-    Parameters
-    ----------
-    server_name : str  The user id string to validate
-
-    Returns
-    -------
-    bool - True if valid, If invalid an InvalidParameterException is raised.
-
-    """
-    calling_frame = inspect.currentframe().f_back
-    caller_method = inspect.getframeinfo(calling_frame).function
-
-    if (server_name is None) or (len(server_name) == 0):
-        msg = str(
-            OMAGCommonErrorCode.SERVER_NAME_NOT_SPECIFIED.value["message_template"]
-        )
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": server_name,
-                "exceptionSystemAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"view_server": server_name},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def validate_guid(guid: str) -> bool:
-    """
-    Validate that the provided guid is neither null nor empty.
-
-    Parameters
-    ----------
-    guid : str  The user id string to validate
-
-    Returns
-    -------
-    bool - True if valid, If invalid an InvalidParameterException is raised.
-
-    """
-    calling_frame = inspect.currentframe().f_back
-    caller_method = inspect.getframeinfo(calling_frame).function
-
-    if (guid is None) or (len(guid) == 0) or (type(guid) is not str):
-        msg = str(OMAGCommonErrorCode.NULL_GUID.value["message_template"])
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": guid,
-                "exceptionSystemAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"guid": guid},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def validate_name(name: str) -> bool:
-    """
-    Validate that the provided name is neither null nor empty.
-
-    Parameters
-    ----------
-    name: str  The user id string to validate
-
-    Returns
-    -------
-    bool - True if valid, If invalid an InvalidParameterException is raised.
-
-    """
-    calling_frame = inspect.currentframe().f_back
-    caller_method = inspect.getframeinfo(calling_frame).function
-
-    if (name is None) or (len(name) == 0):
-        msg = str(OMAGCommonErrorCode.NULL_NAME.value["message_template"])
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": name,
-                "exceptionSystemAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"name": name},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def validate_search_string(search_string: str) -> bool:
-    """
-    Validate that the provided search string is neither null nor empty.
-
-    Parameters
-    ----------
-    search_string : str  The user id string to validate
-
-    Returns
-    -------
-    bool - True if valid, If invalid an InvalidParameterException is raised.
-
-    """
-    calling_frame = inspect.currentframe().f_back
-    caller_method = inspect.getframeinfo(calling_frame).function
-
-    if (search_string is None) or (len(search_string) == 0):
-        msg = str(
-            OMAGCommonErrorCode.NULL_SEARCH_STRING.value["message_template"].format(
-                "search_string", caller_method
-            )
-        )
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": [search_string, caller_method],
-                "exceptionSystemAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"search_string": search_string},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def validate_public(is_public: bool) -> bool:
-    """
-    Validate that the provided flag is boolean.
-
-    Parameters
-    ----------
-    is_public : bool  The flag must be boolean
-
-    Returns
-    -------
-    bool - True if valid, If invalid an InvalidParameterException is raised.
-
-    """
-    calling_frame = inspect.currentframe().f_back
-    caller_method = inspect.getframeinfo(calling_frame).function
-
-    if is_public is None:
-        msg = str(OMAGCommonErrorCode.NULL_OBJECT.value["message_template"])
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": is_public,
-                "exceptionSystemAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.NULL_USER_ID.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"is_public": is_public},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def validate_url(url: str) -> bool:
-    """
-    Validate that the provided url is neither null nor empty. The syntax of the url
-    string is also checked to see that it conforms to standards.
-
-    Parameters
-    ----------
-    url : str  The url string to validate.
-
-    Returns
-    -------
-    bool - True if valid, If invalid an InvalidParameterException is raised.
-
-    """
-    calling_frame = inspect.currentframe().f_back
-    caller_method = inspect.getframeinfo(calling_frame).function
-
-    if (url is None) or (len(url) == 0):
-        msg = str(
-            OMAGCommonErrorCode.SERVER_URL_NOT_SPECIFIED.value["message_template"]
-        )
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.SERVER_URL_MALFORMED.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": url,
-                "exceptionSystemAction": OMAGCommonErrorCode.SERVER_URL_MALFORMED.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.SERVER_URL_MALFORMED.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"url": url},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-
-    # The following hack allows localhost to be used as a hostname - which is disallowed by the
-    # validations package
-    if ("localhost" in url) and ("localhost." not in url):
-        url = url.replace("localhost", "127.0.0.1")
-
-    result = validators.url(url)
-    if result is not True:
-        msg = OMAGCommonErrorCode.SERVER_URL_MALFORMED.value["message_template"].format(
-            url
-        )
-        exc_msg = json.dumps(
-            {
-                "class": "VoidResponse",
-                "relatedHTTPCode": 400,
-                "exceptionClassName": "InvalidParameterException",
-                "actionDescription": caller_method,
-                "exceptionErrorMessage": msg,
-                "exceptionErrorMessageId": OMAGCommonErrorCode.SERVER_URL_MALFORMED.value[
-                    "message_id"
-                ],
-                "exceptionErrorMessageParameters": url,
-                "exceptionSystemAction": OMAGCommonErrorCode.SERVER_URL_MALFORMED.value[
-                    "system_action"
-                ],
-                "exceptionUserAction": OMAGCommonErrorCode.SERVER_URL_MALFORMED.value[
-                    "user_action"
-                ],
-                "exceptionProperties": {"url": url},
-            }
-        )
-        raise InvalidParameterException(exc_msg)
-    else:
-        return True
-
-
-def is_json(txt: str) -> bool:
-    """
-    Parameters
-    ----------
-    txt : str
-        The string to check if it is a valid JSON.
-
-    Returns
-    -------
-    bool
-        True if the string is a valid JSON, False otherwise.
-    """
-    try:
-        json.loads(txt)
-        return True
-    except (ValueError, JSONDecodeError) as e:
-        print(e)
-        return False