pyegeria 0.3.8__tar.gz → 0.4.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.3.8
+Version: 0.4.0
 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
@@ -40,13 +38,16 @@ 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 configuraiton, operation, and use.  This client depends on 
+support for many of Egeria's services including configuration and operation.  This client depends on 
 Egeria 4.4 Snapshot 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.
 
 A new examples folder holds some useful text widgets that help to visualize the status of an Egeria deployment.
 
+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

{pyegeria-0.3.8 → pyegeria-0.4.0}/README.md

@@ -13,13 +13,16 @@ 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 configuraiton, operation, and use.  This client depends on 
+support for many of Egeria's services including configuration and operation.  This client depends on 
 Egeria 4.4 Snapshot 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.
 
 A new examples folder holds some useful text widgets that help to visualize the status of an Egeria deployment.
 
+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

{pyegeria-0.3.8 → pyegeria-0.4.0}/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.4.0/examples/widgets/README.md

@@ -0,0 +1,34 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the Egeria project. -->
+
+The example applications in this directory provide some simple but useful visualization of the Egeria environment. They 
+are built with the **Rich** python package and demonstrate the use of **pyegeria** .
+
+The applications are invoked using the python3 command - for instance:
+`python3 server_status_widget -h` would display the help information for the server_status_widget.
+Running them requires that you have pyegeria installed. pyegeria can be installed using:
+'pip install pyegeria'
+
+Once pyegeria is installed, the scripts may also be run as commands from any directory without having to specify python3 in front such as:
+`view_platform_status.py
+
+Some of the widgets are "live" - that is running continuously until ctrl-c is issued to interrupt it.
+
+As the number of widgets has grown, they have been organized by role into different sub-directories:
+
+* catalog_user - for users of the Egeria environment
+* developer - for those building with, or working on Egeria
+* operational - for visualizing the current state of Egeria - typically for administrators
+* personal_organizer - for visualizing work and individual items
+
+The naming convention for the widgets helps to understand their behaviour:
+Here is a list - if the widget starts with:
+
+* get - it will return details about a single item
+* list - lists elements through a paging interface like "more" - use q to quit.
+* view - provides a live view - typically of a status - use control-c to quit
+
+
+----
+License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
+Copyright Contributors to the Egeria project.

pyegeria-0.4.0/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.0/examples/widgets/catalog_user/list_assets.py

@@ -0,0 +1,138 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for glossary terms
+"""
+
+import time
+import json
+import argparse
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    AssetCatalog
+)
+# import pyegeria.X_asset_catalog_omvs
+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.server_operations import ServerOps
+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"
+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_assets(search_string: str, guid: str=None, server: str = good_server_3, url: str = good_platform1_url, username: str = good_user_2):
+
+    g_client = AssetCatalog(server, url, username)
+    token = g_client.create_egeria_bearer_token(username, "secret")
+
+
+    def generate_table(search_string:str = '*') -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Asset Definitions for assets like  {search_string} @ {time.asctime()}",
+            # style = "black on grey66",
+            header_style="white on dark_blue",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{server}' @ Platform - {url}",
+            expand=True
+        )
+        table.add_column("Display Name")
+        table.add_column("Type Name")
+        table.add_column("GUID", no_wrap=True)
+        table.add_column("Network Address/Path")
+        table.add_column("Qualified Name")
+
+
+        assets = g_client.find_assets_in_domain(search_string, starts_with=False,
+                                             ends_with=False, ignore_case=True, page_size=10)
+        if type(assets) is str:
+            return table
+
+        for element in assets:
+            display_name = element["displayName"]
+            qualified_name = element["qualifiedName"]
+            type_name = element["type"]["typeName"]
+            guid = element["guid"]
+            path_name = element.get("extendedProperties", None)
+            if path_name:
+                path = path_name.get("pathName"," ")
+            else:
+                path = " "
+
+
+
+            table.add_row(
+                display_name, type_name,guid, path, qualified_name
+            )
+
+        g_client.close_session()
+        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()
+        with console.pager():
+            console.print(generate_table(search_string))
+
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        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")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--guid", help="GUID of glossary to search")
+    parser.add_argument("--sustainability", help="Set True for Sustainability Glossary")
+    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 'garygeeke'
+    guid = args.guid if args.guid is not None else None
+    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)

pyegeria-0.4.0/examples/widgets/catalog_user/view_asset_graph.py

@@ -0,0 +1,236 @@
+#!/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
+
+from rich import json
+from rich.panel import Panel
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    AssetCatalog
+)
+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)
+
+platform = "https://127.0.0.1:9443"
+user = "erinoverview"
+view_server = "view-server"
+
+guid_list = []
+
+def asset_viewer(asset_name: str, server_name:str, platform_url:str, user:str):
+
+    def build_classifications(classification: dict) -> Markdown:
+
+        class_md = "-"
+        for c in classification:
+            c_type = c["classificationName"]
+            if c_type == "Anchors":
+                continue
+            class_md += f"* Classification: {c_type}\n"
+            class_props = c["classificationProperties"]
+            for prop in class_props.keys():
+                class_md += f"* {prop}: {class_props[prop]}\n"
+        if class_md == "-":
+            output = None
+        else:
+            output = class_md
+        return output
+
+    def build_nested_elements(nested_element: dict) -> Markdown:
+        ne_md = " "
+
+        ne_created_by = nested_element["versions"]["createdBy"]
+        ne_created_at = nested_element["versions"]["createTime"]
+        ne_guid = nested_element["guid"]
+        guid_list.append(ne_guid)
+
+        ne_type = nested_element["type"]["typeName"]
+        ne_classifications = nested_element["classifications"]
+        ne_class_md = build_classifications(ne_classifications)
+        # ne_class_md = " " if ne_class_md is None else ne_class_md
+        ne_props = nested_element["properties"]
+
+        ne_prop_md = ""
+        for prop in ne_props.keys():
+            ne_prop_md += f"* {prop}: {ne_props[prop]}\n"
+        ne_md = (f"Nested Element of Type: {ne_type} with GUID:  {ne_guid} \n "
+                 f"* created by {ne_created_by} at time {ne_created_at}\n"
+                 f"{ne_prop_md}\n")
+        if ne_class_md is not None:
+            ne_md += f"* {ne_class_md}"
+
+        output = Markdown(ne_md)
+        return output
+
+    try:
+
+        console = Console(width=200)
+
+        a_client = AssetCatalog(view_server, platform,
+                                     user_id=user)
+
+        token = a_client.create_egeria_bearer_token(user, "secret")
+        asset_info = a_client.find_assets_in_domain(asset_name)
+        asset_guid = asset_info[0]['guid']
+        guid_list.append(asset_guid)
+
+        asset_graph = a_client.get_asset_graph(asset_guid)
+        if type(asset_graph) is not dict:
+            print(f"\n No Asset found for {asset_name}")
+            sys.exit(1)
+
+        # print(f"\n{json.dumps(asset_graph, indent =2)}\n")
+        tree = Tree(f"{asset_name} ({asset_guid})", style = "bold bright_white",guide_style="bold bright_blue")
+        style = ""
+
+        asset_name = asset_graph["displayName"]
+        qualified_name = asset_graph["qualifiedName"]
+        resource_name = asset_graph["resourceName"]
+
+        asset_type = asset_graph["type"]["typeName"]
+        asset_origin = asset_graph["origin"]["homeMetadataCollectionName"]
+        asset_creation = asset_graph["versions"]["createTime"]
+        asset_created_by = asset_graph["versions"]["createdBy"]
+        asset_classifications = asset_graph["classifications"]
+        asset_nested_elements = asset_graph["anchoredElements"]
+        asset_relationships = asset_graph["relationships"]
+        asset_class_md = build_classifications(asset_classifications)
+
+
+        asset_properties = asset_graph["extendedProperties"]
+        prop_md = ""
+        for prop in asset_properties:
+            prop_md = f"{prop_md}* {prop}: {asset_properties[prop]}\n"
+
+        core_md = (f"**Type: {asset_type} Created by: {asset_created_by} on {asset_creation}**\n"
+               f"* Qualified Name: {qualified_name}\n "
+               f"* Resource Name: {resource_name}\n"
+               f"* Display Name: {asset_name}\n"
+               f"* Asset Origin: {asset_origin}\n{prop_md}"
+               )
+        core_md = Markdown(core_md)
+        p1 = Panel.fit(core_md, style = "bold bright_white")
+        l2 = tree.add(p1)
+        if asset_class_md is not None:
+            p2 = Panel.fit(Markdown(asset_class_md), style = "bold bright_white")
+            l2 = tree.add(p2)
+
+        #
+        # Nested Assets
+        #
+        l2 = tree.add("Nested Elements", style = "bold white")
+        for el in asset_nested_elements:
+            asset_ne_md = build_nested_elements(el)
+            p3 = Panel.fit(asset_ne_md, style = "bold bright_white", title="Nested Elements")
+            l2.add(p3)
+
+        #
+        # Now work on the Relationships
+        #
+        for relationship in asset_relationships:
+            # Find the end guids - if one isn't in our list then display
+            rel_end1 = relationship["end1"]
+            rel_end1_type = rel_end1["type"]["typeName"]
+            rel_end1_guid = rel_end1["guid"]
+            rel_end1_unique_name = rel_end1["uniqueName"]
+
+            rel_end2 = relationship["end2"]
+            rel_end2_type = rel_end2["type"]["typeName"]
+            rel_end2_guid = rel_end2["guid"]
+            rel_end2_unique_name = rel_end2["uniqueName"]
+
+            if (rel_end1_guid not in guid_list) or (rel_end2_guid not in guid_list):
+                rel_end1_class_md = build_classifications(rel_end1["classifications"])
+                rel_end2_class_md = build_classifications(rel_end2["classifications"])
+
+                relationship_guid = relationship["guid"]
+                relationship_type = relationship["type"]["typeName"]
+                relationship_created_by = relationship["versions"]["createdBy"]
+                relationship_creation_time = relationship["versions"]["createTime"]
+                relationship_properties = relationship.get("properties"," ")
+                relationship_md = (f"Relationship Type {relationship_type}\n"
+                                   f"* GUID: {relationship_guid}\n* Created by: {relationship_created_by} \n"
+                                   f"* Creation Time: {relationship_creation_time}\n"
+                                   f"* Properties: {relationship_properties}\n")
+
+
+                rel_md = (
+                    f"* Relationship Type: {relationship_type}\n"
+                    f"* Relationship GUID: {relationship_guid}\n"
+                    f"* Created by: {relationship_created_by} at time {relationship_creation_time}\n"
+                )
+                rel_end1_md = (
+                    f"* End1:\n"
+                    f"\t* Type: {rel_end1_type}\n"
+                    f"\t* GUID: {rel_end1_guid}\n"
+                    f"\t* Unique Name: {rel_end1_unique_name}\n"
+                    )
+
+                if rel_end1_class_md is not None:
+                    rel_end1_md = rel_end1_md + rel_end1_class_md
+
+                rel_end2_md = (
+                    f"* End1:\n"
+                    f"\t* Type: {rel_end2_type}\n"
+                    f"\t* GUID: {rel_end2_guid}\n"
+                    f"\t* Unique Name: {rel_end2_unique_name}\n"
+                )
+
+                if rel_end2_class_md is not None:
+                    rel_end1_md = rel_end2_md + rel_end2_class_md
+                #
+                # for prop in relationship_properties.keys():
+                #     relationship_md += f"* {prop}: {relationship_properties[prop]}\n"
+
+                relationship_md += rel_end1_md + rel_end2_md
+
+                relationship_panel = Panel.fit(Markdown(relationship_md), style="bold bright_white")
+                tree.add(relationship_panel)
+
+
+        print("\n\n")
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException
+    ) as e:
+        print_exception_response(e)
+
+
+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")
+    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'
+
+    asset_name = Prompt.ask("Enter the Asset Name to view:", default="TransMorg-Clinical-Trials-Weeklies")
+    asset_viewer(asset_name,server, url, userid)

pyegeria-0.3.8/examples/widgets/collection_viewer.py → pyegeria-0.4.0/examples/widgets/catalog_user/view_collection.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/examples/widgets/glossary_view.py → pyegeria-0.4.0/examples/widgets/catalog_user/view_glossary.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.4.0/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.