pyegeria 0.7.45__tar.gz → 0.8.0__tar.gz

{pyegeria-0.7.45 → pyegeria-0.8.0}/PKG-INFO

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

{pyegeria-0.7.45 → pyegeria-0.8.0}/examples/widgets/cat/list_cert_types.py

@@ -26,35 +26,49 @@ from pyegeria import (
     UserNotAuthorizedException,
     print_exception_response,
     AssetCatalog,
-    ClassificationManager
+    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'))
+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"))
 
 
 disable_ssl_warnings = True
 
 
-def display_certifications(search_string: str, server: str, url: str, username: str, user_password: str, time_out: int = 60,
-                   jupyter: bool = EGERIA_JUPYTER, width: int = EGERIA_WIDTH):
+def display_certifications(
+    search_string: str,
+    server: str,
+    url: str,
+    username: str,
+    user_password: str,
+    time_out: int = 60,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
     console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
-    if (search_string is None) or ((len(search_string) < 3)) and (search_string != '*'):
-        raise ValueError("Invalid Search String - must be greater than four characters long")
-    g_client = ClassificationManager(server, url, user_id=username,user_pwd=user_password)
+    if (search_string is None) or ((len(search_string) < 3)) and (search_string != "*"):
+        raise ValueError(
+            "Invalid Search String - must be greater than four characters long"
+        )
+    g_client = ClassificationManager(
+        server, url, user_id=username, user_pwd=user_password
+    )
     token = g_client.create_egeria_bearer_token(username, user_password)
 
-
-    def generate_table(search_string:str = None) -> Table:
+    def generate_table(search_string: str = None) -> Table:
         """Make a new table."""
         table = Table(
             title=f"Certifications Types  @ {time.asctime()}",
@@ -66,10 +80,10 @@ def display_certifications(search_string: str, server: str, url: str, username:
             show_lines=True,
             box=box.ROUNDED,
             caption=f"View Server '{server}' @ Platform - {url}",
-            expand=True
+            expand=True,
         )
         table.add_column("Title", max_width=15)
-        table.add_column('summary')
+        table.add_column("summary")
         table.add_column("domainID")
         table.add_column("Unique Name")
         table.add_column("Scope")
@@ -78,34 +92,33 @@ def display_certifications(search_string: str, server: str, url: str, username:
         table.add_column("Details")
         table.add_column("Related Elements")
 
-
         certs = g_client.get_elements(search_string, page_size=100, time_out=time_out)
         if type(certs) is str:
             return table
 
         for element in certs:
-            properties = element['properties']
-            summary = properties.get('summary',"---")
-            domain = properties.get("domainIdentifier",'---')
-            unique_name = properties.get('qualifiedName','---')
-            scope = properties.get('scope','---')
-            description = properties.get('description','---')
-            details = properties.get('details','---')
-            title = properties.get('title','---')
-            cert_guid = element['elementHeader']['guid']
+            properties = element["properties"]
+            summary = properties.get("summary", "---")
+            domain = properties.get("domainIdentifier", "---")
+            unique_name = properties.get("qualifiedName", "---")
+            scope = properties.get("scope", "---")
+            description = properties.get("description", "---")
+            details = properties.get("details", "---")
+            title = properties.get("title", "---")
+            cert_guid = element["elementHeader"]["guid"]
 
             related = g_client.get_all_related_elements(cert_guid)
             if (len(related) > 0) and (type(related) is list):
-                rel_md = ''
+                rel_md = ""
                 for rel in related:
-                    rel_type = rel['relationshipHeader']['type']['typeName']
-                    rel_element_props = rel['relatedElement']['properties']
+                    rel_type = rel["relationshipHeader"]["type"]["typeName"]
+                    rel_element_props = rel["relatedElement"]["properties"]
                     rel_el_md = f"* Rel Type: {rel_type}\n"
                     for key in rel_element_props.keys():
                         rel_el_md += f"* {key}: {rel_element_props[key]}\n"
                     rel_md += f"----\n{rel_el_md}\n"
             else:
-                rel_md = '---'
+                rel_md = "---"
 
             # match_tab = Table(expand=True)
             # match_tab.add_column("Type Name")
@@ -122,9 +135,8 @@ def display_certifications(search_string: str, server: str, url: str, username:
             #     match_details_out = Markdown(match_details_md)
             #     match_tab.add_row(match_type_name, matching_guid, match_details_out)
 
-
             table.add_row(
-                title, summary, domain, unique_name,scope,description,details, rel_md
+                title, summary, domain, unique_name, scope, description, details, rel_md
             )
 
         g_client.close_session()
@@ -140,13 +152,18 @@ def display_certifications(search_string: str, server: str, url: str, username:
         with console.pager(styles=True):
             console.print(generate_table(search_string), soft_wrap=True)
 
-
-    except (InvalidParameterException, PropertyServerException, UserNotAuthorizedException) as e:
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
         console.print_exception()
         sys.exit(1)
 
     except ValueError as e:
-        console.print(f"\n\n====> Invalid Search String - must be greater than four characters long")
+        console.print(
+            f"\n\n====> Invalid Search String - must be greater than four characters long"
+        )
         sys.exit(1)
 
 
@@ -167,10 +184,11 @@ def main():
     time_out = args.time_out if args.time_out is not None else 60
     try:
         # search_string = Prompt.ask("Enter an asset search string:", default="*")
-        search_string = 'CertificationType'
+        search_string = "CertificationType"
         display_certifications(search_string, server, url, userid, user_pass, time_out)
-    except(KeyboardInterrupt):
+    except KeyboardInterrupt:
         pass
 
+
 if __name__ == "__main__":
-    main()
+    main()

{pyegeria-0.7.45 → pyegeria-0.8.0}/examples/widgets/cat/list_projects.py

@@ -59,7 +59,7 @@ def display_project_list(
 ):
     p_client = ProjectManager(server, url, user_id=username)
     token = p_client.create_egeria_bearer_token(username, user_pass)
-    c_client = ClassificationManager(server, url, token)
+    c_client = ClassificationManager(server, url, token=token)
 
     def generate_table(project_name: str) -> Table:
         """Make a new table."""

{pyegeria-0.7.45 → pyegeria-0.8.0}/examples/widgets/cli/egeria.py

@@ -352,6 +352,22 @@ def list_element_info(ctx, om_type):
     )
 
 
+@show.command("list-processes")
+@click.pass_context
+def list_element_info(ctx):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    list_elements(
+        "GovernanceActionProcess",
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
 @show.command("guid-info")
 @click.argument("guid", nargs=1)
 @click.pass_context
@@ -827,9 +843,9 @@ def show_projects(ctx, search_string):
         ["OPEN", "IN_PROGRESS", "WAITING", "COMPLETE", "ABANDONED", "None"],
         case_sensitive="False",
     ),
-    help="Enter an optional status filter",
+    help="Enter an optional status filter, default='OPEN'",
     required=False,
-    default=None,
+    default="OPEN",
 )
 @click.pass_context
 def show_todos(ctx, search_string, status):

pyegeria-0.8.0/examples/widgets/cli/egeria_tech.py

@@ -0,0 +1,454 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+A command line interface for Egeria Data techs.
+
+This is an emerging capability based on the **click** package. Feedback welcome!
+
+"""
+import click
+from trogon import tui
+
+from examples.widgets.cat.list_tech_types import display_tech_types
+from examples.widgets.cli.ops_config import Config
+from examples.widgets.tech.get_guid_info import display_guid
+from examples.widgets.tech.get_tech_details import tech_details_viewer
+from examples.widgets.tech.list_asset_types import display_asset_types
+from examples.widgets.tech.list_registered_services import display_registered_svcs
+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.cat.get_tech_type_template import template_viewer
+from examples.widgets.tech.list_elements import list_elements
+from examples.widgets.tech.get_element_info import display_elements
+from examples.widgets.tech.list_related_specification import (
+    display_related_specification,
+)
+
+
+# from pyegeria import ServerOps
+
+
+# class Config(object):
+#     def __init__(self, server: str = None, url: str = None, userid:str = None, password:str = None,
+#                  timeout:int = 30, paging: bool = False):
+#         self.server = server
+#         self.url = url
+#         self.userid = userid
+#         self.password = password
+#         self.timeout = timeout
+#         self.paging = paging
+#
+#
+# pass_config = click.make_pass_decorator(Config)
+
+
+# @tui
+# @tui('menu', 'menu', 'A textual command line interface')
+@tui()
+@click.version_option("0.0.1", prog_name="egeria_ops")
+@click.group()
+@click.option(
+    "--server",
+    default="active-metadata-store",
+    envvar="EGERIA_METADATA_STORE",
+    help="Egeria metadata store to work with",
+)
+@click.option(
+    "--url",
+    default="https://localhost:9443",
+    envvar="EGERIA_PLATFORM_URL",
+    help="URL of Egeria metadata store platform to connect to",
+)
+@click.option(
+    "--integration-daemon",
+    default="integration-daemon",
+    envvar="EGERIA_INTEGRATION_DAEMON",
+    help="Egeria integration daemon to work with",
+)
+@click.option(
+    "--integration_daemon_url",
+    default="https://localhost:9443",
+    envvar="EGERIA_INTEGRATION_DAEMON_URL",
+    help="URL of Egeria integration daemon platform to connect to",
+)
+@click.option(
+    "--view_server",
+    default="view-server",
+    envvar="EGERIA_VIEW_SERVER",
+    help="Egeria view server to work with",
+)
+@click.option(
+    "--view_server_url",
+    default="https://localhost:9443",
+    envvar="EGERIA_VIEW_SERVER_URL",
+    help="URL of Egeria view server platform to connect to",
+)
+@click.option(
+    "--engine_host",
+    default="engine-host",
+    envvar="EGERIA_ENGINE_HOST",
+    help="Egeria engine host to work with",
+)
+@click.option(
+    "--engine_host_url",
+    default="https://localhost:9443",
+    envvar="EGERIA_ENGINE_HOST_URL",
+    help="URL of Egeria engine host platform to connect to",
+)
+@click.option(
+    "--admin_user",
+    default="garygeeke",
+    envvar="EGERIA_ADMIN_USER",
+    help="Egeria admin user",
+)
+@click.option(
+    "--admin_user_password",
+    default="secret",
+    envvar="EGERIA_ADMIN_PASSWORD",
+    help="Egeria admin password",
+)
+@click.option(
+    "--userid", default="erinoverview", envvar="EGERIA_USER", help="Egeria user"
+)
+@click.option(
+    "--password",
+    default="secret",
+    envvar="EGERIA_PASSWORD",
+    help="Egeria user password",
+)
+@click.option("--timeout", default=60, help="Number of seconds to wait")
+@click.option("--verbose", is_flag=True, default=False, help="Enable verbose mode")
+@click.option(
+    "--paging",
+    is_flag=True,
+    default=False,
+    help="Enable paging snapshots vs live updates",
+)
+@click.option(
+    "--jupyter",
+    is_flag=True,
+    default=False,
+    envvar="EGERIA_JUPYTER",
+    help="Enable for rendering in a Jupyter terminal",
+)
+@click.option(
+    "--width",
+    default=200,
+    envvar="EGERIA_WIDTH",
+    help="Screen width, in characters, to use",
+)
+@click.pass_context
+def cli(
+    ctx,
+    server,
+    url,
+    view_server,
+    view_server_url,
+    integration_daemon,
+    integration_daemon_url,
+    engine_host,
+    engine_host_url,
+    admin_user,
+    admin_user_password,
+    userid,
+    password,
+    timeout,
+    paging,
+    verbose,
+    jupyter,
+    width,
+):
+    """An Egeria Command Line interface for Operations"""
+    ctx.obj = Config(
+        server,
+        url,
+        view_server,
+        view_server_url,
+        integration_daemon,
+        integration_daemon_url,
+        engine_host,
+        engine_host_url,
+        admin_user,
+        admin_user_password,
+        userid,
+        password,
+        timeout,
+        paging,
+        verbose,
+        jupyter,
+        width,
+    )
+    ctx.max_content_width = 200
+    ctx.ensure_object(Config)
+    if verbose:
+        click.echo(f"we are in verbose mode - server is {server}")
+
+
+@cli.group("show")
+@click.pass_context
+def show(ctx):
+    """Display an Egeria Object"""
+    pass
+
+
+@show.command("guid-info")
+@click.argument("guid", nargs=1)
+@click.pass_context
+def show_guid_infos(ctx, guid):
+    """Display a live status view of known platforms
+
+    Usage: show guid-info <a guid>
+
+    """
+    c = ctx.obj
+    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")
+@click.pass_context
+def show_tech_types(ctx, search_string):
+    """List deployed technology types
+
+    Usage: show tech-types <optional search-string>
+
+    All tech-types will be returned if no search-string is specified.
+
+    """
+
+    c = ctx.obj
+    display_tech_types(
+        search_string, c.view_server, c.view_server_url, c.userid, c.password
+    )
+
+
+@show.command("tech-details")
+@click.argument("tech-name")
+@click.pass_context
+def show_tech_details(ctx, tech_name):
+    """Display a live status view of Egeria servers for the specified Egeria platform
+
+    Usage: show tech-details <tech-name>
+
+           tech-name is a valid technology name (see 'show tech-types')
+    """
+    c = ctx.obj
+    tech_details_viewer(
+        tech_name,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("asset-types")
+@click.pass_context
+def show_asset_types(ctx):
+    """Display engine-host status information"""
+    c = ctx.obj
+    display_asset_types(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("registered-services")
+@click.option(
+    "--services",
+    type=click.Choice(
+        [
+            "all",
+            "access-services",
+            "common-services",
+            "engine-services",
+            "governance-services",
+            "integration-services",
+            "view-services",
+        ],
+        case_sensitive=False,
+    ),
+    default="all",
+    help="Which service group to display",
+)
+@click.pass_context
+def show_registered_services(ctx, services):
+    """Show information about a registered services"""
+    c = ctx.obj
+    display_registered_svcs(
+        services,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("relationship-types")
+@click.option(
+    "--rel-type",
+    default="AssetOwner",
+    help="Relationship type to get information about",
+)
+@click.pass_context
+def show_relationship_types(ctx, rel_type):
+    """Show information about the specified relationship type"""
+    c = ctx.obj
+    display_relationship_types(
+        rel_type,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        False,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("tech-templates")
+@click.pass_context
+@click.option(
+    "--search-string", default="*", help="Technology type to get information about"
+)
+def tech_templates(ctx, search_string):
+    """Display template information about the specified technology."""
+    c = ctx.obj
+    template_viewer(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("tech-template-spec")
+@click.pass_context
+@click.option(
+    "--search-string", default="*", help="Technology type to get information about"
+)
+def tech_template_spec(ctx, search_string):
+    """Display template specification information about the specified technology."""
+    c = ctx.obj
+    display_templates_spec(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("valid-metadata-values")
+@click.pass_context
+@click.option("--property", default="projectHealth", help="Metadata property to query")
+@click.option("--type-name", default="Project", help="Metadata type to query")
+def valid_metadata_values(ctx, property, type_name):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    display_metadata_values(
+        property,
+        type_name,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        False,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("list-elements")
+@click.pass_context
+@click.option("--om_type", default="Organization", help="Metadata type to query")
+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("list-processes")
+@click.pass_context
+def list_element_info(ctx):
+    """Display the valid metadata values for a property and type"""
+    c = ctx.obj
+    list_elements(
+        "GovernanceActionProcess",
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@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 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,
+    )
+
+
+#
+#  Tell
+#
+
+
+@cli.group("tell")
+@click.pass_context
+def tell(ctx):
+    """Perform actions an Egeria Objects"""
+    pass
+
+
+if __name__ == "__main__":
+    cli()