pyegeria 0.7.5__tar.gz → 0.7.7__tar.gz

{pyegeria-0.7.5 → pyegeria-0.7.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.7.5
+Version: 0.7.7
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0

{pyegeria-0.7.5 → pyegeria-0.7.7}/examples/widgets/cli/egeria.py

@@ -50,7 +50,8 @@ from examples.widgets.tech.list_registered_services import display_registered_sv
 from examples.widgets.tech.list_relationship_types import display_relationship_types
 from examples.widgets.tech.list_tech_templates import display_templates_spec
 from examples.widgets.tech.list_valid_metadata_values import display_metadata_values
-
+from examples.widgets.tech.get_element_info import display_elements
+from examples.widgets.tech.list_elements import list_elements
 
 @tui()
 # @tui('menu', 'menu', 'A textual command line interface')
@@ -195,6 +196,25 @@ def show(ctx):
     """Display an Egeria Object"""
     pass
 
+@show.command("get-element-info")
+@click.pass_context
+@click.option('--om_type', default='Project', help='Metadata type to query')
+def get_element_info(ctx, om_type):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    display_elements(om_type, c.view_server, c.view_server_url,
+                            c.userid, c.password,  c.jupyter, c.width)
+
+@show.command("list-elements")
+@click.pass_context
+@click.option('--om_type', default='Project', help='Metadata type to query')
+def get_element_info(ctx, om_type):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    list_elements(om_type, c.view_server, c.view_server_url,
+                            c.userid, c.password,  c.jupyter, c.width)
+
+
 
 @show.command('guid-info')
 @click.argument('guid', nargs=1)

{pyegeria-0.7.5 → pyegeria-0.7.7}/examples/widgets/cli/egeria_tech.py

@@ -22,6 +22,9 @@ from examples.widgets.tech.list_relationship_types import display_relationship_t
 from examples.widgets.tech.list_tech_templates import display_templates_spec
 from examples.widgets.tech.list_valid_metadata_values import display_metadata_values
 from examples.widgets.cat.get_tech_type_template import template_viewer
+from examples.widgets.tech.get_element_info import display_elements
+from examples.widgets.tech.list_elements import list_elements
+
 
 
 # from pyegeria import ServerOps
@@ -204,6 +207,25 @@ def valid_metadata_values(ctx, property, type_name):
     display_metadata_values(property, type_name, c.view_server, c.view_server_url,
                             c.userid, c.password, False, c.jupyter, c.width)
 
+@show.command("get-element-info")
+@click.pass_context
+@click.option('--om_type', default='Project', help='Metadata type to query')
+def get_element_info(ctx, om_type):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    display_elements(om_type, c.view_server, c.view_server_url,
+                            c.userid, c.password,  c.jupyter, c.width)
+
+@show.command("list-elements")
+@click.pass_context
+@click.option('--om_type', default='Project', help='Metadata type to query')
+def get_element_info(ctx, om_type):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    list_elements(om_type, c.view_server, c.view_server_url,
+                            c.userid, c.password,  c.jupyter, c.width)
+
+
 
 #
 #  Tell

pyegeria-0.7.7/examples/widgets/tech/get_element_info.py

@@ -0,0 +1,121 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-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 argparse
+import json
+import os
+import sys
+
+from rich import print, box
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+
+from rich.prompt import Prompt
+from rich.text import Text
+from rich.tree import Tree
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    Client, ClassificationManager
+)
+
+
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get('KAFKA_ENDPOINT', 'localhost:9092')
+EGERIA_PLATFORM_URL = os.environ.get('EGERIA_PLATFORM_URL', 'https://localhost:9443')
+EGERIA_VIEW_SERVER = os.environ.get('VIEW_SERVER', 'view-server')
+EGERIA_VIEW_SERVER_URL = os.environ.get('EGERIA_VIEW_SERVER_URL', 'https://localhost:9443')
+EGERIA_INTEGRATION_DAEMON = os.environ.get('INTEGRATION_DAEMON', 'integration-daemon')
+EGERIA_ADMIN_USER = os.environ.get('ADMIN_USER', 'garygeeke')
+EGERIA_ADMIN_PASSWORD = os.environ.get('ADMIN_PASSWORD', 'secret')
+EGERIA_USER = os.environ.get('EGERIA_USER', 'erinoverview')
+EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
+EGERIA_JUPYTER = bool(os.environ.get('EGERIA_JUPYTER', 'False'))
+EGERIA_WIDTH = int(os.environ.get('EGERIA_WIDTH', '200'))
+
+
+def display_elements(om_type: str, server: str, url: str, username: str, user_password: str,
+                 jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH
+                 ):
+    c = ClassificationManager(server, url, user_id=username, user_pwd=user_password)
+
+    bearer_token = c.create_egeria_bearer_token(username, user_password)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter, style="bold white on black")
+        r = c.get_elements(om_type)
+        if type(r) is not list:
+            print(f"\n\n\tno elements found: {r}")
+            sys.exit(1)
+
+        tree = Tree(f"Elements for Open Metadata Type:{om_type}\n* There are {len(r)} elements", style="bold bright_white on black",
+                    guide_style="bold bright_blue")
+        t = tree.add(f"Elements for {om_type}", style="bold bright_white on black")
+        for element in r:
+            header = element['elementHeader']
+            el_type = header["type"]['typeName']
+            el_home = header['origin']['homeMetadataCollectionName']
+            el_create_time = header['versions']['createTime']
+            el_guid = header['guid']
+
+            el_md = (f"#### Element Basics\n"
+                     f"* **Type**: {el_type}\n"
+                     f"* **Home**: {el_home}\n"
+                     f"* **Created**: {el_create_time}\n"
+                     f"* **GUID**: {el_guid}\n ---\n")
+            for prop in element['properties'].keys():
+                el_md += f"* **{prop}**: {element['properties'][prop]}\n"
+
+            el_out = Markdown(el_md)
+            p = Panel.fit(el_out, title=element['properties']['qualifiedName'],
+                  style = "bold white on black")
+            t = tree.add(p)
+
+        print(tree)
+
+        c.close_session()
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException, ValueError) as e:
+        if type(e) is str:
+            console.print_exception()
+        else:
+            # console.print_exception(show_locals=True)
+            console.print(f"\n ===> Looks like the type {om_type} isn't known...\n")
+
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+
+    # parser.add_argument("--sponsor", help="Name of sponsor to search")
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_VIEW_SERVER_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        om_type = Prompt.ask("Enter the Open Metadata Type to find Elements for", default=None)
+        display_elements(om_type, server, url, userid, user_pass)
+    except (KeyboardInterrupt):
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria-0.7.7/examples/widgets/tech/list_elements.py

@@ -0,0 +1,127 @@
+"""This creates a templates guid file from the core metadata archive"""
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+import os
+import argparse
+import time
+import sys
+from rich import box
+from rich.console import Console
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+   ClassificationManager
+)
+
+
+console = Console()
+EGERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+EGERIA_KAFKA_ENDPOINT = os.environ.get('KAFKA_ENDPOINT', 'localhost:9092')
+EGERIA_PLATFORM_URL = os.environ.get('EGERIA_PLATFORM_URL', 'https://localhost:9443')
+EGERIA_VIEW_SERVER = os.environ.get('VIEW_SERVER', 'view-server')
+EGERIA_VIEW_SERVER_URL = os.environ.get('EGERIA_VIEW_SERVER_URL', 'https://localhost:9443')
+EGERIA_INTEGRATION_DAEMON = os.environ.get('INTEGRATION_DAEMON', 'integration-daemon')
+EGERIA_ADMIN_USER = os.environ.get('ADMIN_USER', 'garygeeke')
+EGERIA_ADMIN_PASSWORD = os.environ.get('ADMIN_PASSWORD', 'secret')
+EGERIA_USER = os.environ.get('EGERIA_USER', 'erinoverview')
+EGERIA_USER_PASSWORD = os.environ.get('EGERIA_USER_PASSWORD', 'secret')
+EGERIA_JUPYTER = bool(os.environ.get('EGERIA_JUPYTER', 'False'))
+EGERIA_WIDTH = int(os.environ.get('EGERIA_WIDTH', '200'))
+
+
+
+def list_elements(om_type:str, server: str,
+                       url: str, username: str, password: str, jupyter:bool=EGERIA_JUPYTER, width:int = EGERIA_WIDTH
+):
+
+    c_client = ClassificationManager(server, url, user_id=username, user_pwd=password)
+    token = c_client.create_egeria_bearer_token()
+    elements = c_client.get_elements(om_type)
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            caption=f"Metadata Elements for: {url} - {server} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            title=f"Elements for Open Metadata Type: '{om_type}' ",
+            expand=True,
+            # width=500
+        )
+
+        table.add_column("Qualified Name")
+        table.add_column("Created")
+        table.add_column("Home Store")
+        table.add_column("GUID", width = 38,no_wrap=True)
+        table.add_column("Properties")
+
+
+        if type(elements) is list:
+            for element in elements:
+                header = element['elementHeader']
+                el_q_name = element['properties']['qualifiedName']
+                el_type = header["type"]['typeName']
+                el_home = header['origin']['homeMetadataCollectionName']
+                el_create_time = header['versions']['createTime'][:-10]
+                el_guid = header['guid']
+
+                el_props_md = ""
+                for prop in element['properties'].keys():
+                    el_props_md += f"* **{prop}**: {element['properties'][prop]}\n"
+
+                el_props_out = Markdown(el_props_md)
+                table.add_row(el_q_name, el_create_time, el_home, el_guid, el_props_out)
+
+            return table
+        else:
+            print("Unknown Open Metadata type")
+            sys.exit(1)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+        print_exception_response(e)
+        assert e.related_http_code != "200", "Invalid parameters"
+    finally:
+        c_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    password = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        om_type = Prompt.ask("Enter the Open Metadata Type to find elements of:", default="GlossaryTerm")
+        list_elements(om_type, server, url, userid, password)
+    except(KeyboardInterrupt):
+        pass
+
+
+if __name__ == "__main__":
+    main()
+
+
+

{pyegeria-0.7.5 → pyegeria-0.7.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "0.7.5"
+version = "0.7.7"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -86,13 +86,13 @@ pytest = "^8.2.2"
     monitor_open_todos = "examples.widgets.my.monitor_open_todos:main"
     monitor_my_todos = "examples.widgets.my.monitor_my_todos:main"
 
-    egeria_ops = "examples.widgets.cli.egeria_ops:cli"
+    hey_egeria_ops = "examples.widgets.cli.egeria_ops:cli"
 #    egeria_ops_menu = "examples.widgets.cli.egeria_ops:menu"
-    egeria_cat = "examples.widgets.cli.egeria_cat:cli"
+    hey_egeria_cat = "examples.widgets.cli.egeria_cat:cli"
 #    egeria_cat_menu = "examples.widgets.cli.egeria_cat:menu"
-    egeria_tech = "examples.widgets.cli.egeria_cat:cli"
+    hey_egeria_tech = "examples.widgets.cli.egeria_cat:cli"
 #    egeria_tech_menu = "examples.widgets.cli.egeria_cat:menu"
-    egeria_per = "examples.widgets.cli.egeria_per:cli"
+    hey_egeria_per = "examples.widgets.cli.egeria_per:cli"
     hey_egeria = "examples.widgets.cli.egeria:cli"
 
     get_guid_info = "examples.widgets.tech.get_guid_info:main"
@@ -101,5 +101,7 @@ pytest = "^8.2.2"
     list_registered_services = "examples.widgets.tech.list_registered_services:main"
     list_relationship_types = "examples.widgets.tech.list_relationship_types:main"
     list_tech_templates = "examples.widgets.tech.list_tech_templates:main"
+    get_element_info = "examples.widgets.tech.get_element_info:main"
+    list_elements = "examples.widgets.tech.list_elements:main"
 
     list_valid_metadata_values = "examples.widgets.tech.list_valid_metadata_values:main"