pyegeria 0.7.16__tar.gz → 0.7.18__tar.gz

{pyegeria-0.7.16 → pyegeria-0.7.18}/PKG-INFO

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

{pyegeria-0.7.16 → pyegeria-0.7.18}/examples/widgets/cli/egeria.py

@@ -52,7 +52,8 @@ 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.tech.list_elements import list_elements
-from examples.widgets.tech.list_related_elements import display_related_elements
+from examples.widgets.tech.get_element_info import display_elements
+from examples.widgets.tech.list_related_specification import display_related_specification
 
 
 @tui()
@@ -199,11 +200,20 @@ def show(ctx):
     pass
 
 
-@show.command("list-elements")
+@show.command("get-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"""
+    """Display the elements for an Open Metadata 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 list_element_info(ctx, om_type):
+    """Display the elements for an Open Metadata Type"""
     c = ctx.obj
     list_elements(om_type, c.view_server, c.view_server_url,
                             c.userid, c.password,  c.jupyter, c.width)
@@ -277,15 +287,13 @@ def show_registered_services(ctx, services):
     display_registered_svcs(services, c.view_server, c.view_server_url,
                             c.userid, c.password, c.jupyter, c.width)
 
-@show.command('related-elements')
+@show.command('related-specifications')
 @click.pass_context
 @click.argument('element-guid')
-@click.option('--rel-type',default = 'SpecificationPropertyAssignment',
-              help="Relationship type to find related elements of")
-@click.option('--om_type', default = None, help="Optional Open Metadata Type to filter by.")
-def show_related_elements(ctx, element_guid, rel_type, om_type):
+def show_related_specifications(ctx, element_guid):
+    """List specifications related to the given Element"""
     c = ctx.obj
-    display_related_elements(element_guid,rel_type,om_type, c.view_server, c.view_server_url,
+    display_related_specification(element_guid, c.view_server, c.view_server_url,
                             c.userid, c.password, c.jupyter, c.width)
 
 

{pyegeria-0.7.16 → pyegeria-0.7.18}/examples/widgets/cli/egeria_tech.py

@@ -23,7 +23,8 @@ 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.list_elements import list_elements
-from examples.widgets.tech.list_related_elements import display_related_elements
+from examples.widgets.tech.get_element_info import display_elements
+from examples.widgets.tech.list_related_specification import display_related_specification
 
 
 
@@ -111,6 +112,16 @@ def show_guid_infos(ctx, guid):
     display_guid(guid, c.server, c.url,
                  c.userid, c.password, c.jupyter, c.width)
 
+@show.command('related-specifications')
+@click.pass_context
+@click.argument('element-guid')
+def show_related_specifications(ctx, element_guid):
+    """List specifications related to the given Element"""
+    c = ctx.obj
+    display_related_specification(element_guid,c.view_server, c.view_server_url,
+                            c.userid, c.password, c.jupyter, c.width)
+
+
 
 @show.command('tech-types')
 @click.option('--search-string', default='*', help='Tech type to search for')
@@ -211,22 +222,21 @@ def valid_metadata_values(ctx, property, type_name):
 @show.command('list-elements')
 @click.pass_context
 @click.option('--om_type', default='Organization', help='Metadata type to query')
-def get_element_info(ctx, om_type):
+def list_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('related-elements')
+@show.command("get-elements")
 @click.pass_context
-@click.argument('element-guid')
-@click.option('--rel-type',default = 'SpecificationPropertyAssignment',
-              help="Relationship type to find related elements of")
-@click.option('--om_type', default = None, help="Optional Open Metadata Type to filter by.")
-def show_related_elements(ctx, element_guid, rel_type, om_type):
+@click.option('--om_type', default='Project', help='Metadata type to query')
+def get_element_info(ctx, om_type):
+    """Display the elements for an Open Metadata Type"""
     c = ctx.obj
-    display_related_elements(element_guid,rel_type,om_type, c.view_server, c.view_server_url,
-                            c.userid, c.password, c.jupyter, c.width)
+    display_elements(om_type, c.view_server, c.view_server_url,
+                            c.userid, c.password,  c.jupyter, c.width)
+
 
 #
 #  Tell

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

@@ -0,0 +1,119 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+A simple display of elements for an Open Metadata Type in tree form.
+"""
+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.18/examples/widgets/tech/list_related_specification.py

@@ -0,0 +1,144 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+List elements related to given element guid by the specified relationship type. Optionally filter by a specified
+open metadata type.
+
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich import box
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+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 display_related_specification(element_guid: 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()
+    rel_el = c_client.get_related_elements(element_guid, 'SpecificationPropertyAssignment', None)
+
+    if type(rel_el) is str:
+        print(f"\n\nDid not find related specifications for {element_guid}\n\n")
+        sys.exit(0)
+
+    related_elements: dict = {}
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(title=f"Specifications related to: {element_guid}  @ {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, caption=f"Elements from Server '{server}' @ Platform - {url}",
+            expand=True, # width=500
+        )
+
+        table.add_column("Name", justify='center', style="bold bright_white")
+        table.add_column("Specification", justify='center', style="bold bright_white")
+
+        for element in rel_el:
+            relationship_props = element["relationshipProperties"]['propertyType']
+            related_elements[relationship_props] = []
+
+        for element in rel_el:
+            relationship_props = element["relationshipProperties"]['propertyType']
+
+            rel_element = element['relatedElement']
+            el = rel_element["properties"]
+            re: dict = {}
+
+            re['case'] = el.get("isCaseSensitive", '---')
+            re['name'] = el.get("preferredValue", '---')
+            re['description'] = el.get("description", '---')
+            add = el.get("additionalProperties", '---')
+            if type(add) is str:
+                re['additional'] = add
+            else:
+                add_md = ""
+                for k in add.keys():
+                    add_md += f"* {k}: {add[k]}\n"
+                re['additional'] = Markdown(add_md)
+
+            related_elements[relationship_props].append(re)
+
+        for kind in related_elements.keys():
+
+            spec_table = Table(expand=False, show_lines=True)
+            spec_table.add_column('Name')
+            spec_table.add_column('Case Sensitive?')
+            spec_table.add_column('Description')
+            spec_table.add_column('Additional Properties')
+
+            for spec_row in related_elements[kind]:
+                name = spec_row['name']
+                case = spec_row['case']
+                desc = spec_row['description']
+                additional_props = spec_row['additional']
+                spec_table.add_row(name, case, desc, additional_props)
+
+            table.add_row(kind, spec_table)
+
+        return table
+
+    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
+    guid = None
+
+    try:
+        element_guid = Prompt.ask("Enter an Element GUID find relationships for")
+
+        display_related_specification(element_guid, server, url, userid, password)
+    except(KeyboardInterrupt):
+        pass
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.7.16 → pyegeria-0.7.18}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "0.7.16"
+version = "0.7.18"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -100,6 +100,6 @@ pytest = "^8.2.2"
     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_related_elements = "examples.widgets.tech.list_related_elements:main"
+    list_related_specification = "examples.widgets.tech.list_related_specification:main"
 
     list_valid_metadata_values = "examples.widgets.tech.list_valid_metadata_values:main"