pyegeria 0.4.1__py3-none-any.whl → 0.5.1__py3-none-any.whl

examples/widgets/catalog_user/README.md

@@ -0,0 +1,15 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+# Catalog User
+
+These widgets display different kinds of information useful to a typical catalog user. Widgets
+will continue to be added over time to cover more facets of catalog use.
+
+* list_assets.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.
+* view_asset_graph.py - shows a tree view of an asset with its nested elements and relationships.
+* view_collection.py - provides a tree view of a collection with all nested collections and items within the collection.
+* view_glossary.py - provides a simple glossary viewer showing terms and related information.
+----
+License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
+Copyright Contributors to the Egeria project.

{pyegeria-0.4.1.data/scripts → examples/widgets/catalog_user}/list_assets.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -118,7 +118,7 @@ def display_assets(search_string: str, guid: str=None, server: str = good_server
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
 
-if __name__ == "__main__":
+def main():
     sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -135,4 +135,7 @@ if __name__ == "__main__":
     guid = sus_guid  if args.sustainability else None
 
     search_string = Prompt.ask("Enter the asset you are searching for:", default="*")
-    display_assets(search_string, guid,server, url, userid)
+    display_assets(search_string, guid,server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/catalog_user}/view_asset_graph.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -229,7 +229,7 @@ def asset_viewer(asset_guid: str, server_name:str, platform_url:str, user:str):
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -243,3 +243,6 @@ if __name__ == "__main__":
 
     asset_guid = Prompt.ask("Enter the Asset GUID to view:", default="8e35b39e-6ee7-4d60-aff5-4b09406c5e79")
     asset_viewer(asset_guid,server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/catalog_user}/view_collection.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -63,7 +63,7 @@ def collection_viewer(root: str, server_name: str, platform_url: str, user: str)
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -77,3 +77,6 @@ if __name__ == "__main__":
 
     root_collection = Prompt.ask("Enter the Root Collection to start from:", default="Digital Products Root")
     collection_viewer(root_collection, server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/catalog_user}/view_glossary.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -115,7 +115,7 @@ def display_glossary_terms(search_string: str, guid: str=None, server: str = goo
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
 
-if __name__ == "__main__":
+def main():
     sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -132,4 +132,7 @@ if __name__ == "__main__":
     guid = sus_guid  if args.sustainability else None
 
     search_string = Prompt.ask("Enter the term you are searching for:", default="*")
-    display_glossary_terms(search_string, guid,server, url, userid)
+    display_glossary_terms(search_string, guid,server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/developer/README.md

@@ -0,0 +1,24 @@
+<!-- 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-0.4.1.data/scripts → examples/widgets/developer}/get_guid_info.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-Lic
 ense-Identifier: Apache-2.0
@@ -11,17 +11,13 @@ A simple display for glossary terms
 """
 
 import argparse
-import httpx
 import json
-import time
 
-from rich import box
 from rich import print
 from rich.console import Console
 from rich.prompt import Prompt
 from rich.text import Text
 from rich.tree import Tree
-from rich.json import JSON
 
 from pyegeria import (
     InvalidParameterException,
@@ -30,7 +26,6 @@ from pyegeria import (
     print_exception_response,
     Client
 )
-from pyegeria import ProjectManager
 
 
 def display_guid(guid: str, server: str, url: str, username: str):
@@ -67,7 +62,7 @@ def display_guid(guid: str, server: str, url: str, username: str):
         else:
             print_exception_response(e)
 
-if __name__ == "__main__":
+def main():
 
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -83,4 +78,7 @@ if __name__ == "__main__":
 
     guid = Prompt.ask("Enter the GUID to retrieve:", default=None)
 
-    display_guid(guid, server, url, userid)
+    display_guid(guid, server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/get_tech_details.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -7,33 +7,19 @@ A simple viewer for collections - provide the root and we display the hierarchy
 
 """
 
-import time
 import argparse
 
-from rich.box import Box
-from rich.markdown import Markdown
+from rich import print
+from rich.panel import Panel
 from rich.prompt import Prompt
-
-from pyegeria._exceptions import (
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response,
-)
-from rich.table import Table
-from rich.live import Live
 from rich.text import Text
 from rich.tree import Tree
-from rich.markdown import Markdown
 
-from rich import print
-from rich.console import Group
-from rich.panel import Panel
-from rich import box, align
-from rich.layout import Layout
-import rich
-from pyegeria import (CollectionManager, UserNotAuthorizedException, PropertyServerException,
+from pyegeria import (UserNotAuthorizedException, PropertyServerException,
                       InvalidParameterException, AutomatedCuration)
+from pyegeria._exceptions import (
+    print_exception_response,
+)
 
 disable_ssl_warnings = True
 
@@ -95,7 +81,7 @@ def tech_viewer(tech: str, server_name:str, platform_url:str, user:str):
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -109,3 +95,6 @@ if __name__ == "__main__":
 
     tech = Prompt.ask("Enter the Technology to start from:", default="PostgreSQL Server")
     tech_viewer(tech,server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/list_asset_types.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -74,7 +74,7 @@ def display_asset_types(server: str, url: str, username: str):
         r_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -89,3 +89,6 @@ if __name__ == "__main__":
     guid = None
 
     display_asset_types(server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/list_registered_services.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -116,7 +116,7 @@ def display_registered_svcs(service: str, server: str , url: str,
         a_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -133,3 +133,6 @@ if __name__ == "__main__":
     svc_kind = Prompt.ask("Enter the service type you are searching for:", default="all")
 
     display_registered_svcs(svc_kind, server, url, userid, password=password)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/list_relationship_types.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-Lic
 ense-Identifier: Apache-2.0
@@ -104,8 +104,7 @@ def display_list(type_name:str, server: str, url: str ,
         else:
             print_exception_response(e)
 
-if __name__ == "__main__":
-
+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")
@@ -120,4 +119,7 @@ if __name__ == "__main__":
     save_output = args.save_output if args.save_output is not None else False
     type_name = Prompt.ask("Enter the Type Name to retrieve:", default="AssetOwner")
 
-    display_list(type_name, server, url, userid, save_output)
+    display_list(type_name, server, url, userid, save_output)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/list_tech_templates.py

@@ -109,7 +109,7 @@ def display_tech_types(search_string:str = "*", server: str = server,
         a_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -128,7 +128,8 @@ if __name__ == "__main__":
 
     display_tech_types(search_string, server, url, userid, password)
 
-
+if __name__ == "__main__":
+    main()
 
 
 

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/list_tech_types.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -23,7 +23,6 @@ from pyegeria import (
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
-    RegisteredInfo,
     AutomatedCuration
 )
 
@@ -106,7 +105,7 @@ def display_tech_types(search_string:str = "*", server: str = good_server_3, url
         a_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -122,3 +121,6 @@ if __name__ == "__main__":
     search_string = Prompt.ask("Enter the technology you are searching for:", default="*")
 
     display_tech_types(search_string, server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/developer}/list_valid_metadata_values.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-Lic
 ense-Identifier: Apache-2.0
@@ -10,22 +10,22 @@ Unit tests for the Utils helper functions using the Pytest framework.
 A simple display for glossary terms
 """
 
-import time
-import json
 import argparse
+import json
+import time
+
+from rich import box
+from rich import print
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+
 from pyegeria import (
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
 )
-from rich.table import Table
-from rich.live import Live
-from rich import box
-from rich.prompt import Prompt
-from rich.tree import Tree
-from rich import print
-from rich.console import Console
 from pyegeria import ValidMetadataManager
 
 disable_ssl_warnings = True
@@ -125,8 +125,7 @@ def display_values(property_name: str, type_name: str=None, server: str = good_s
         else:
             print_exception_response(e)
 
-if __name__ == "__main__":
-
+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")
@@ -141,4 +140,7 @@ if __name__ == "__main__":
     save_output = args.save_output if args.save_output is not None else False
     property_name = Prompt.ask("Enter the Property to retrieve:", default="projectHealth")
     type_name = Prompt.ask("Enter the Metadata Type to filter on:", default="Project")
-    display_values(property_name, type_name,server, url, userid, save_output)
+    display_values(property_name, type_name,server, url, userid, save_output)
+
+    if __name__ == "__main__":
+        main()

examples/widgets/operational/README.md

@@ -0,0 +1,24 @@
+<!-- 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.

examples/widgets/operational/__init__.py

@@ -0,0 +1,7 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+"""
+import pyegeria

{pyegeria-0.4.1.data/scripts → examples/widgets/operational}/get_tech_type_elements.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -121,7 +121,7 @@ def tech_viewer(tech_name: str, server_name:str, platform_url:str, user:str):
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -135,3 +135,6 @@ if __name__ == "__main__":
 
     tech_name = Prompt.ask("Enter the Asset Name to view:", default="Apache Kafka Server")
     tech_viewer(tech_name,server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/operational}/get_tech_type_template.py

@@ -1,16 +1,19 @@
-#!python
+#!/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 sys
-import time
 import argparse
+import sys
 
-from rich import json
+from rich import print
+from rich.console import Console
+from rich.markdown import Markdown
 from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.tree import Tree
 
 from pyegeria import (
     InvalidParameterException,
@@ -19,15 +22,6 @@ from pyegeria import (
     print_exception_response,
     AutomatedCuration
 )
-from rich.table import Table
-from rich.live import Live
-from rich.console import Console
-from rich.markdown import Markdown
-from rich.tree import Tree
-from rich.prompt import Prompt
-from rich.panel import Panel
-from rich.text import Text
-from rich import print
 
 disable_ssl_warnings = True
 console = Console(width=200)
@@ -121,7 +115,7 @@ def tech_viewer(tech_name: str, server_name:str, platform_url:str, user:str):
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -135,3 +129,6 @@ if __name__ == "__main__":
 
     tech_name = Prompt.ask("Enter the Asset Name to view:", default="Apache Kafka Server")
     tech_viewer(tech_name,server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/operational/view_asset_events.py

@@ -0,0 +1,78 @@
+#!/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 json
+import sys
+import time
+import argparse
+from datetime import datetime
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.live import Live
+from rich.console import Console
+from rich.markdown import Markdown
+from confluent_kafka import Consumer, KafkaException
+
+def main():
+
+    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': 'localhost:9092',  # 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'
+    }
+
+    # 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(1.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{props}\n\n")
+                msg = Markdown(msg)
+
+                console.print(msg)
+    finally:
+        # Close down consumer to commit final offsets.
+        consumer.close()
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/operational}/view_coco_status.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -85,7 +85,7 @@ def display_status(server: str, url: str, username: str):
         p_client2.close_session()
         p_client3.close_session()
 
-if __name__ == "__main__":
+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")
@@ -97,3 +97,6 @@ if __name__ == "__main__":
     userid = args.userid if args.userid is not None else 'garygeeke'
 
     display_status(server, url, userid)
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.4.1.data/scripts → examples/widgets/operational}/view_eng_action_status.py

@@ -1,4 +1,4 @@
-#!python
+#!/usr/bin/env python3
 """
 SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
@@ -118,7 +118,7 @@ def display_status_engine_actions(server: str, url: str, user: str):
         g_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -130,3 +130,6 @@ if __name__ == "__main__":
     userid = args.userid if args.userid is not None else 'garygeeke'
     print(f"Starting display_status_engine_actions with {server}, {url}, {userid}")
     display_status_engine_actions(server=server, url=url, user=userid)
+
+if __name__ == "__main__":
+    main()