pyegeria 0.3.8__tar.gz → 0.3.9__tar.gz

{pyegeria-0.3.8/src/pyegeria.egg-info → pyegeria-0.3.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.3.8
+Version: 0.3.9
 Summary: A python client for Egeria
 Home-page: https://egeria-project.org/egeria-python
 Author: Dan Wolfson
@@ -18,8 +18,6 @@ Requires-Dist: requests~=2.31.0
 Requires-Dist: validators~=0.22.0
 Requires-Dist: pytest~=7.4.2
 Requires-Dist: urllib3~=1.26.15
-Requires-Dist: tabulate~=0.9.0
-Requires-Dist: pandas~=2.2.0
 Requires-Dist: rich~=13.7.1
 Requires-Dist: httpx~=0.26.0
 Provides-Extra: tests

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/Coco_config/config_cocoView1.py

@@ -21,7 +21,8 @@ from pyegeria.platform_services import Platform
 disable_ssl_warnings = True
 
 view_server = "cocoView1"
-platform_url = dataLakePlatformURL
+# platform_url = dataLakePlatformURL
+platform_url = corePlatformURL
 admin_user = "garygeeke"
 view_server_user_id = "cocoView1npa"
 view_server_password = "cocoView1passw0rd"

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/README.md

@@ -6,6 +6,8 @@ The applications are invoked using the python3 command - for instance:
 Running them may require that you have pyegeria installed. pyegeria can be installed using:
 'pip install pyegeria'
 
+Some of the widgets are "live" - that is running continuously until ctrl-c is issued to interrupt it.
+
 The functions are:
 
 * server_status_widget: provide a live view of servers running on a platform.
@@ -19,8 +21,12 @@ The functions are:
 * view_my_profile: view an Egeria profile
 * list_asset_types: list the types of assets that have been configured in Egeria
 * multi-server_status: show the status from two platforms concurrently
-* coco_statys.py: example showing the status of the Coco Pharmacutical platforms from the Jupyter Labs.
+* coco_status.py: example showing the status of the Coco Pharmacutical platforms from the Jupyter Labs.
 * get_relationship_types.py: display the different types of relationships for a given Entity type.
 * get_valid_metadata_values.py: retrieve the currently defined valid metadata values for a given attribute and entity
 * open_todos.py: list the open todo items
-* project_list_viewer.py: List defined projects
+* project_list_viewer.py: List defined projects
+* collection_viewer.py: Shows a collection hierarchy
+* get_registered_services.py: shows the services registered on the platform
+* get_tech_details.py: get the details of a technology type
+* get_tech_types.py: get a list of the technology types

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/coco_status.py

@@ -6,7 +6,7 @@ Copyright Contributors to the ODPi Egeria project.
 Unit tests for the Utils helper functions using the Pytest framework.
 
 
-A simple server status display
+A simple server status display for the Coco Pharmaceuticals Configuration
 """
 
 import argparse
@@ -39,7 +39,6 @@ def test_display_status(server: str, url: str, username: str):
     p_client2 = ServerOps('Datalake Catalog', "https://localhost:9444", username)
     p_client3 = ServerOps('DevCatalog', "https://localhost:9445", username)
 
-
     def generate_table(p_client) -> Table:
         """Make a new table."""
         table = Table(
@@ -80,7 +79,6 @@ def test_display_status(server: str, url: str, username: str):
                 time.sleep(2)
                 live.update(layout)
 
-
     except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/collection_viewer.py

@@ -7,43 +7,25 @@ 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, InvalidParameterException
+from pyegeria._exceptions import (
+    print_exception_response,
+)
 
 disable_ssl_warnings = True
 
-platform = "https://127.0.0.1:9443"
-user = "erinoverview"
-view_server = "view-server"
 
-
-def collection_viewer(root: str, server_name:str, platform_url:str, user:str):
-
-    def walk_collection_hierarchy(collection_client: CollectionManager, root_collection_name: str, tree: Tree) -> Tree:
+def collection_viewer(root: str, server_name: str, platform_url: str, user: str):
+    """ A simple collection viewer"""
+    def walk_collection_hierarchy(collection_client: CollectionManager, root_collection_name: str, tree: Tree) -> None:
         """Recursively build a Tree with collection contents."""
         members = collection_client.get_member_list(root_collection_name)
         if members:
@@ -56,7 +38,7 @@ def collection_viewer(root: str, server_name:str, platform_url:str, user:str):
                 text_collection_type = Text(f"* Collection Type: {member['collectionType']}", "cyan")
                 text_description = Text(f"* Description: {member['description']}", "cyan")
                 p = Panel.fit(f"[white]{text_collection_name}[green]\n{text_qualified_name}\n{text_guid}\n"
-                          f"{text_collection_type}\n{text_description}")
+                              f"{text_collection_type}\n{text_description}")
                 tt = tree.add(p, style=style)
 
                 children = collection_client.get_collection_members(member['guid'])
@@ -64,14 +46,13 @@ def collection_viewer(root: str, server_name:str, platform_url:str, user:str):
                     branch = tt.add(f"[bold magenta]Members", style=style, guide_style=style)
                     walk_collection_hierarchy(collection_client, member['qualifiedName'], branch),
 
-
     try:
         tree = Tree(f"[bold bright green]{root}", guide_style="bold bright_blue")
-        c_client = CollectionManager(view_server, platform,
+        c_client = CollectionManager(server_name, platform_url,
                                      user_id=user)
 
         token = c_client.create_egeria_bearer_token(user, "secret")
-        walk_collection_hierarchy(c_client,root,tree)
+        walk_collection_hierarchy(c_client, root, tree)
         print(tree)
 
     except (
@@ -95,4 +76,4 @@ if __name__ == "__main__":
     userid = args.userid if args.userid is not None else 'erinoverview'
 
     root_collection = Prompt.ask("Enter the Root Collection to start from:", default="Digital Products Root")
-    collection_viewer(root_collection,server, url, userid)
+    collection_viewer(root_collection, server, url, userid)

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/engine_action_status.py

@@ -11,52 +11,31 @@ A simple status display for Engine Actions
 
 import argparse
 import json
-import time
 import sys
+import time
 
 from rich import box
-from rich.live import Live
-from rich.table import Table
 from rich.console import Console
+from rich.table import Table
 
+from pyegeria import AutomatedCuration
 from pyegeria import (
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
     print_exception_response,
 )
-from pyegeria import GovEng, AutomatedCuration
 
 disable_ssl_warnings = True
 
-good_platform1_url = "https://127.0.0.1:9443"
-good_platform2_url = "https://egeria.pdr-associates.com:7443"
-bad_platform1_url = "https://localhost:9443"
-
-# good_platform1_url = "https://127.0.0.1:30080"
-# good_platform2_url = "https://127.0.0.1:30081"
-# bad_platform1_url = "https://localhost:9443"
 
-good_user_1 = "garygeeke"
-good_user_2 = "erinoverview"
-bad_user_1 = "eviledna"
-bad_user_2 = ""
-
-good_server_1 = "active-metadata-store"
-good_server_2 = "simple-metadata-store"
-good_server_3 = "view-server"
-good_server_4 = "engine-host"
-bad_server_1 = "coco"
-bad_server_2 = ""
-
-
-def display_status_engine_actions(server: str = good_server_3, url: str = good_platform1_url, user: str = good_user_1):
+def display_status_engine_actions(server: str, url: str, user: str):
     g_client = AutomatedCuration(server, url, user, user_pwd="secret")
 
     def generate_table() -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Engine Action Status for Platform {good_platform1_url} @ {time.asctime()}",
+            title=f"Engine Action Status for Platform {url} @ {time.asctime()}",
             # style = "black on grey66",
             header_style="white on dark_blue",
             show_lines=True,
@@ -103,7 +82,7 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
                 else:
                     action_status = f"[red]{action['actionStatus']}"
 
-                target= action.get("actionTargetElements","Empty")
+                target= action.get("actionTargetElements", "Empty")
                 if type(target) is list:
                     target_element = json.dumps(target[0]["targetElement"]["elementProperties"]["propertiesAsStrings"])
                 else:
@@ -119,7 +98,7 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
         else:
             print("Egeria integration daemon not running")
             sys.exit()
-        # g_client.close_session()
+
         return table
 
     try:
@@ -130,6 +109,8 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
     except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
+    finally:
+        g_client.close_session()
 
 
 if __name__ == "__main__":

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/find_todos.py

@@ -10,51 +10,24 @@ Unit tests for the Utils helper functions using the Pytest framework.
 A simple display for glossary terms
 """
 
-import time
-import json
 import argparse
+import time
+
+from rich import box
+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.my_profile_omvs import MyProfile
 
-from pyegeria.server_operations import ServerOps
-from pyegeria.gov_engine import GovEng
-from pyegeria.glossary_omvs import GlossaryBrowser
-disable_ssl_warnings = True
-
-good_platform1_url = "https://127.0.0.1:9443"
-good_platform2_url = "https://egeria.pdr-associates.com:7443"
-bad_platform1_url = "https://localhost:9443"
-
-# good_platform1_url = "https://127.0.0.1:30080"
-# good_platform2_url = "https://127.0.0.1:30081"
-# bad_platform1_url = "https://localhost:9443"
-
-good_user_1 = "garygeeke"
-good_user_2 = "erinoverview"
-bad_user_1 = "eviledna"
-bad_user_2 = ""
-
-good_server_1 = "active-metadata-store"
-good_server_2 = "simple-metadata-store"
-good_server_3 = "view-server"
-good_server_4 = "engine-host"
-bad_server_1 = "coco"
-bad_server_2 = ""
-
 
-def display_to_dos(search_string: str, guid: str=None, server: str = good_server_3, url: str = good_platform1_url, username: str = good_user_2):
+def display_to_dos(search_string: str, guid:str, server: str, url: str, username: str):
 
     m_client = MyProfile(server, url, user_id=username)
     token = m_client.create_egeria_bearer_token(username, "secret")
@@ -62,7 +35,7 @@ def display_to_dos(search_string: str, guid: str=None, server: str = good_server
     def generate_table(search_string:str = '*') -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Open ToDos for Platform {good_platform1_url} @ {time.asctime()}",
+            title=f"Open ToDos for Platform {url} @ {time.asctime()}",
             # style = "black on grey66",
             header_style="white on dark_blue",
             show_lines=True,
@@ -134,7 +107,6 @@ def display_to_dos(search_string: str, guid: str=None, server: str = good_server
         assert e.related_http_code != "200", "Invalid parameters"
 
 if __name__ == "__main__":
-    sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
     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")
@@ -145,7 +117,6 @@ if __name__ == "__main__":
     server = args.server if args.server is not None else "view-server"
     url = args.url if args.url is not None else "https://localhost:9443"
     userid = args.userid if args.userid is not None else 'erinoverview'
-    # guid = args.guid if args.guid is not None else None
     guid = None
 
     search_string = Prompt.ask("Enter the ToDo you are searching for:", default="*")

pyegeria-0.3.9/examples/widgets/get_registered_services.py

@@ -0,0 +1,135 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple widget to retrieve the registered services.
+
+"""
+
+import argparse
+import sys
+import time
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    RegisteredInfo,
+)
+
+
+def display_registered_svcs(service: str, server: str , url: str,
+                            username: str, password: str ):
+    """ Display the registered services list
+    Parameters
+    ----------
+    service : str, optional
+        The type of service to display information for. Default is "help".
+
+    server : str, optional
+        The server to connect to. Default is `default_server`.
+
+    url : str, optional
+        The platform URL. Default is `default_platform`.
+
+    username : str, optional
+        The username for authentication. Default is `default_user`.
+
+    password : str, optional
+        The password for authentication. Default is `default_password`.
+    """
+    def generate_table(svc_list) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Technology Types for: {url} @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"Registered Services from Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+        table.add_column("Service Id")
+        table.add_column("Service Name")
+        table.add_column("Service  Development Status")
+        table.add_column("URL Marker")
+        table.add_column("Description")
+        table.add_column("Wiki")
+        table.add_column("Server Type")
+        table.add_column("Partner Service Name")
+        table.add_column("Partner Service Type")
+
+        if type(svc_list) is list:
+            for svc in svc_list:
+                svc_id = str(svc.get("serviceId", " "))
+                svc_name = svc.get("serviceName", "b")
+                svc_dev_status = svc.get("serviceDevelopmentStatus", " ")
+                svc_url_marker = svc.get("serviceUrlMarker", " ")
+                svc_description = svc.get("serviceDescription", " ")
+                svc_wiki = svc.get("serviceWiki", " ")
+                svc_partner_svc_name = svc.get("partnerServiceName", " ")
+                svc_partner_svc_type = svc.get("partnerServiceType", " ")
+
+                table.add_row(
+                    svc_id, svc_name, svc_dev_status, svc_url_marker, svc_description, svc_wiki,
+                    svc_partner_svc_name, svc_partner_svc_type
+                )
+            return table
+        elif type(svc_list) is str:
+            help = """
+            The kinds of services that you can get more information include:
+                all.....................lists all registered services
+                access-services.........lists all registered access services
+                common-services.........lists all registered common services
+                engine-services.........lists all registered engine services
+                governance-services.....lists all registered governance services
+                integration-services....lists all registered integration services
+                view-services...........lists all registered view services
+                
+                Pass in a parameter from the left-hand column into the function to 
+                get more details on the specified service category.
+            """
+            console.print(help)
+
+        else:
+            print("Unknown service type")
+            sys.exit(1)
+
+    console = Console()
+    try:
+        a_client = RegisteredInfo(server, url, username)
+        # token = a_client.create_egeria_bearer_token(username, password)
+        svc_list = a_client.list_registered_svcs(service)
+
+        with console.pager():
+            console.print(generate_table(svc_list))
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        console.print_exception(show_locals=True)
+    finally:
+        a_client.close_session()
+
+
+if __name__ == "__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="Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else "active-metadata-store"
+    url = args.url if args.url is not None else "https://localhost:9443"
+    userid = args.userid if args.userid is not None else 'garygeeke'
+    password = args.password if args.password is not None else 'secret'
+
+    svc_kind = Prompt.ask("Enter the service type you are searching for:", default="all")
+
+    display_registered_svcs(svc_kind, server, url, userid, password=password)

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/get_relationship_types.py

@@ -8,41 +8,26 @@ Copyright Contributors to the ODPi Egeria project.
 Get valid relationship types.
 """
 
-import time
-import json
 import argparse
+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, ProjectManager
-
-disable_ssl_warnings = True
-
-good_platform1_url = "https://127.0.0.1:9443"
-
-
-# good_platform1_url = "https://127.0.0.1:30080"
-# good_platform2_url = "https://127.0.0.1:30081"
-# bad_platform1_url = "https://localhost:9443"
+from pyegeria import ValidMetadataManager
 
-good_user_1 = "garygeeke"
-good_user_2 = "erinoverview"
-good_server_3 = "view-server"
 
-
-
-def display_list(type_name:str, server: str = good_server_3, url: str = good_platform1_url,
-                   username: str = good_user_2,  save_output: bool = False):
+def display_list(type_name:str, server: str, url: str ,
+                   username: str, save_output: bool = False):
 
     p_client = ValidMetadataManager(server, url, user_id=username)
     token = p_client.create_egeria_bearer_token(username, "secret")
@@ -63,15 +48,14 @@ def display_list(type_name:str, server: str = good_server_3, url: str = good_pla
         # table.add_column("GUID", no_wrap=True,)
         table.add_column("Status")
         table.add_column("Description")
-        table.add_column("Description Wiki")
+        table.add_column("Description Wiki", no_wrap=True)
         table.add_column("Attribute Name")
         table.add_column("Attribute Status")
         table.add_column("Attribute Type")
-        # table.add_column("Attribute Type")
         table.add_column("Attribute Description")
 
         types_list = p_client.get_valid_relationship_types(type_name)
-        # print(json.dumps(types_list, indent=4))
+
         print(type(types_list))
         if types_list is None:
             name = " "
@@ -106,10 +90,7 @@ def display_list(type_name:str, server: str = good_server_3, url: str = good_pla
         return table
 
     try:
-        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
-        #     while True:
-        #         time.sleep(2)
-        #         live.update(generate_table())
+
         console = Console(record=True)
         with console.pager():
             console.print(generate_table(type_name))
@@ -129,13 +110,13 @@ if __name__ == "__main__":
     parser.add_argument("--url", help="URL Platform to connect to")
     parser.add_argument("--userid", help="User Id")
     parser.add_argument("--save-output", help="Save output to file?")
-    # parser.add_argument("--sponsor", help="Name of sponsor to search")
+
     args = parser.parse_args()
 
     server = args.server if args.server is not None else "view-server"
     url = args.url if args.url is not None else "https://localhost:9443"
     userid = args.userid if args.userid is not None else 'erinoverview'
     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="*")
+    type_name = Prompt.ask("Enter the Type Name to retrieve:", default="AssetOwner")
 
     display_list(type_name, server, url, userid, save_output)

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/glossary_view.py

@@ -28,8 +28,8 @@ from rich.console import Console
 
 
 from pyegeria.server_operations import ServerOps
-from pyegeria.gov_engine import GovEng
-from pyegeria.glossary_omvs import GlossaryBrowser
+from pyegeria._deprecated_gov_engine import GovEng
+from pyegeria.glossary_browser_omvs import GlossaryBrowser
 disable_ssl_warnings = True
 
 good_platform1_url = "https://127.0.0.1:9443"

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/gov_engine_status.py

@@ -25,7 +25,6 @@ from rich import box
 from rich import console
 
 from pyegeria.server_operations import ServerOps
-from pyegeria.gov_engine import GovEng
 
 disable_ssl_warnings = True
 

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/list_asset_types.py

@@ -24,38 +24,16 @@ from pyegeria import (
     RegisteredInfo
 )
 
-disable_ssl_warnings = True
 
-good_platform1_url = "https://127.0.0.1:9443"
-good_platform2_url = "https://egeria.pdr-associates.com:7443"
-bad_platform1_url = "https://localhost:9443"
-
-# good_platform1_url = "https://127.0.0.1:30080"
-# good_platform2_url = "https://127.0.0.1:30081"
-# bad_platform1_url = "https://localhost:9443"
-
-good_user_1 = "garygeeke"
-good_user_2 = "erinoverview"
-bad_user_1 = "eviledna"
-bad_user_2 = ""
-
-good_server_1 = "active-metadata-store"
-good_server_2 = "simple-metadata-store"
-good_server_3 = "view-server"
-good_server_4 = "engine-host"
-bad_server_1 = "coco"
-bad_server_2 = ""
-
-
-def display_asset_types(server: str = good_server_3, url: str = good_platform1_url, username: str = good_user_2):
+def display_asset_types(server: str, url: str, username: str):
     r_client = RegisteredInfo(server, url, username)
-    token = r_client.create_egeria_bearer_token(good_user_2, "secret")
+    token = r_client.create_egeria_bearer_token(username, "secret")
     asset_types = r_client.list_asset_types()
 
     def generate_table() -> Table:
         """Make a new table."""
         table = Table(
-            title=f"Asset Types for: {good_platform1_url} @ {time.asctime()}",
+            title=f"Asset Types for: {url} @ {time.asctime()}",
             # style = "black on grey66",
             header_style="white on dark_blue",
             show_lines=True,

{pyegeria-0.3.8 → pyegeria-0.3.9}/examples/widgets/my_todos.py

@@ -24,7 +24,7 @@ from pyegeria import (
     UserNotAuthorizedException,
     print_exception_response,
 )
-from pyegeria.gov_engine import GovEng
+from pyegeria._deprecated_gov_engine import GovEng
 from pyegeria.my_profile_omvs import MyProfile
 disable_ssl_warnings = True