pyegeria 0.7.29__tar.gz → 0.7.31__tar.gz

{pyegeria-0.7.29 → pyegeria-0.7.31}/PKG-INFO

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

{pyegeria-0.7.29 → pyegeria-0.7.31}/examples/widgets/cat/list_relationships.py

@@ -22,37 +22,49 @@ from pyegeria import (
     InvalidParameterException,
     PropertyServerException,
     UserNotAuthorizedException,
-    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 list_relationships(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 list_relationships(
+    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"Relationship List for {search_string}  @ {time.asctime()}",
@@ -64,40 +76,49 @@ def list_relationships(search_string: str, server: str, url: str, username: str,
             show_lines=True,
             box=box.ROUNDED,
             caption=f"View Server '{server}' @ Platform - {url}",
-            expand=True
+            expand=True,
         )
-        table.add_column('End 1 Name')
+        table.add_column("End 1 Name")
         table.add_column("End 1 GUID", no_wrap=True)
-        table.add_column('End 1 Type')
-        table.add_column('End 2 Name')
+        table.add_column("End 1 Type")
+        table.add_column("End 2 Name")
         table.add_column("End 2 GUID", no_wrap=True)
         table.add_column("End 2 Type")
         table.add_column("Properties", min_width=40)
 
-        rel_list = g_client.get_relationships(search_string, page_size=100, time_out=time_out)
+        rel_list = g_client.get_relationships(
+            search_string, page_size=100, time_out=time_out
+        )
         if type(rel_list) is str:
             return table
 
-        for rel  in rel_list:
-            end1_name = rel['end1'].get('uniqueName','---')
-            end1_guid = rel['end1']['guid']
-            end1_type = rel['end1']['type']['typeName']
-            end2_name = rel['end2'].get('uniqueName', '---')
-            end2_guid = rel['end2']['guid']
-            end2_type = rel['end2']['type']['typeName']
+        for rel in rel_list:
+            end1_name = rel["end1"].get("uniqueName", "---")
+            end1_guid = rel["end1"]["guid"]
+            end1_type = rel["end1"]["type"]["typeName"]
+            end2_name = rel["end2"].get("uniqueName", "---")
+            end2_guid = rel["end2"]["guid"]
+            end2_type = rel["end2"]["type"]["typeName"]
 
-            rel_md = ''
-            p_test = rel.get('properties','---')
+            rel_md = ""
+            p_test = rel.get("properties", "---")
             if type(p_test) is str:
-                rel_md = '---'
+                rel_md = "---"
             else:
-                for key in rel['properties'].keys():
+                for key in rel["properties"].keys():
                     rel_md += f"* {key}: {rel['properties'][key]}\n"
 
             rel_out = Markdown(rel_md)
 
             table.add_row(
-                end1_name, end1_guid, end1_type, end1_name, end2_guid, end2_type, rel_out)
+                end1_name,
+                end1_guid,
+                end1_type,
+                end2_name,
+                end2_guid,
+                end2_type,
+                rel_out,
+            )
 
         g_client.close_session()
 
@@ -112,13 +133,18 @@ def list_relationships(search_string: str, server: str, url: str, username: str,
         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)
 
 
@@ -139,10 +165,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 = 'Certification'
+        search_string = "Certification"
         list_relationships(search_string, server, url, userid, user_pass, time_out)
-    except(KeyboardInterrupt):
+    except KeyboardInterrupt:
         pass
 
+
 if __name__ == "__main__":
-    main()
+    main()

{pyegeria-0.7.29 → pyegeria-0.7.31}/examples/widgets/cli/egeria.py

@@ -45,6 +45,7 @@ from examples.widgets.ops.integration_daemon_actions import (
 from examples.widgets.ops.list_catalog_targets import display_catalog_targets
 from examples.widgets.ops.load_archive import load_archive
 from examples.widgets.ops.monitor_engine_activity import display_engine_activity
+from examples.widgets.ops.monitor_engine_activity_c import display_engine_activity_c
 from examples.widgets.ops.monitor_gov_eng_status import display_gov_eng_status
 from examples.widgets.ops.monitor_integ_daemon_status import (
     display_integration_daemon_status,
@@ -988,19 +989,36 @@ def gov_eng_status(ctx, list):
 @click.option(
     "--list", is_flag=True, default=False, help="If True, a paged list will be shown"
 )
+@click.option(
+    "--compressed",
+    type=bool,
+    default=True,
+    help="Compressed combines some attributes into a single column",
+)
 @click.pass_context
-def eng_activity_status(ctx, list):
+def eng_activity_status(ctx, list, compressed):
     """Show Governance Activity in engine-host"""
     c = ctx.obj
-    display_engine_activity(
-        c.view_server,
-        c.view_server_url,
-        c.admin_user,
-        c.admin_user_password,
-        list,
-        c.jupyter,
-        c.width,
-    )
+    if compressed:
+        display_engine_activity_c(
+            c.view_server,
+            c.view_server_url,
+            c.admin_user,
+            c.admin_user_password,
+            list,
+            c.jupyter,
+            c.width,
+        )
+    else:
+        display_engine_activity(
+            c.view_server,
+            c.view_server_url,
+            c.admin_user,
+            c.admin_user_password,
+            list,
+            c.jupyter,
+            c.width,
+        )
 
 
 @show.group("integrations")

pyegeria-0.7.31/examples/widgets/cli/egeria_ops.py

@@ -0,0 +1,443 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+A command line interface for Egeria operations.
+
+This is an emerging capability based on the **click** package. Feedback welcome!
+
+"""
+import click
+from trogon import tui
+
+# from pyegeria import ServerOps
+from examples.widgets.cli.ops_config import Config
+from examples.widgets.ops.engine_actions import (
+    start_daemon as start_engine_host,
+    stop_daemon as stop_engine_host,
+)
+from examples.widgets.ops.integration_daemon_actions import (
+    add_catalog_target,
+    remove_catalog_target,
+    update_catalog_target,
+    stop_server,
+    start_server,
+)
+from examples.widgets.ops.list_catalog_targets import display_catalog_targets
+from examples.widgets.ops.load_archive import load_archive
+from examples.widgets.ops.monitor_engine_activity import display_engine_activity
+from examples.widgets.ops.monitor_engine_activity_c import display_engine_activity_c
+from examples.widgets.ops.monitor_gov_eng_status import display_gov_eng_status
+from examples.widgets.ops.monitor_integ_daemon_status import (
+    display_integration_daemon_status,
+)
+from examples.widgets.ops.monitor_platform_status import (
+    display_status as p_display_status,
+)
+from examples.widgets.ops.monitor_server_list import display_status as display_list
+from examples.widgets.ops.monitor_server_status import (
+    display_status as s_display_status,
+)
+from examples.widgets.ops.refresh_integration_daemon import refresh_connector
+from examples.widgets.ops.restart_integration_daemon import restart_connector
+
+
+# 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')
+@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.group("platforms")
+@click.pass_context
+def show_platform(ctx):
+    """Group of commands to show information about Egeria platforms"""
+    pass
+
+
+@show_platform.command("status")
+@click.pass_context
+def show_platform_status(ctx):
+    """Display a live status view of known platforms"""
+    c = ctx.obj
+    p_display_status(
+        c.view_server, c.view_server_url, c.admin_user, c.admin_user_password
+    )
+
+
+@show.group("servers")
+@click.pass_context
+def show_server(ctx):
+    """Group of commands to show information about Egeria servers"""
+    pass
+
+
+@show_server.command("status")
+@click.option(
+    "--full",
+    is_flag=True,
+    default=False,
+    help="If True, full server descriptions will be shown",
+)
+@click.pass_context
+def show_server_status(ctx, full):
+    """Display a live status view of Egeria servers for the specified Egeria platform"""
+    c = ctx.obj
+    if full:
+        display_list(
+            c.metadata_store,
+            c.metadata_store_url,
+            c.admin_user,
+            c.admin_user_password,
+            c.jupyter,
+            c.width,
+        )
+    else:
+        s_display_status(
+            c.metadata_store,
+            c.metadata_store_url,
+            c.admin_user,
+            c.admin_user_password,
+            c.jupyter,
+            c.width,
+        )
+
+
+@show.group("engines")
+@click.pass_context
+def engine_host(ctx):
+    """Group of commands to show information about Egeria engines"""
+    pass
+
+
+@engine_host.command("status")
+@click.option(
+    "--list", is_flag=True, default=False, help="If True, a paged list will be shown"
+)
+@click.pass_context
+def gov_eng_status(ctx, list):
+    """Display engine-host status information"""
+    c = ctx.obj
+    display_gov_eng_status(
+        c.engine_host, c.engine_host_url, c.userid, c.password, list, c.jupyter, c.width
+    )
+
+
+@engine_host.command("activity")
+@click.option(
+    "--compressed",
+    type=bool,
+    default=True,
+    help="Compressed combines some attributes into a single column",
+)
+@click.option(
+    "--list", is_flag=True, default=False, help="If True, a paged list will be shown"
+)
+@click.pass_context
+def eng_activity_status(ctx, list, compressed):
+    """Show Governance Activity in engine-host"""
+    c = ctx.obj
+    if compressed:
+        display_engine_activity_c(
+            c.view_server,
+            c.view_server_url,
+            c.admin_user,
+            c.admin_user_password,
+            list,
+            c.jupyter,
+            c.width,
+        )
+    else:
+        display_engine_activity(
+            c.view_server,
+            c.view_server_url,
+            c.admin_user,
+            c.admin_user_password,
+            list,
+            c.jupyter,
+            c.width,
+        )
+
+
+@show.group("integrations")
+@click.pass_context
+def integrations(ctx):
+    """Group of commands to show information about Egeria integrations"""
+    pass
+
+
+@integrations.command("status")
+@click.option(
+    "--list", is_flag=True, default=False, help="If True, a paged list will be shown"
+)
+@click.pass_context
+def integrations_status(ctx, list):
+    """Display integration-daemon status information"""
+    c = ctx.obj
+    display_integration_daemon_status(
+        c.integration_daemon,
+        c.integration_daemon_url,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        list,
+        c.jupyter,
+        c.width,
+    )
+
+
+@integrations.command("targets")
+@click.pass_context
+@click.argument("connector", nargs=1)
+def integrations_status(ctx, connector):
+    """Display Catalog Targets for a connector"""
+    c = ctx.obj
+    display_catalog_targets(
+        connector,
+        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
+
+
+@tell.group("integration-daemon")
+@click.pass_context
+def integration_daemon(ctx):
+    """Group of commands to an integration-daemon"""
+    pass
+
+
+@integration_daemon.command("refresh")
+@click.pass_context
+@click.option(
+    "--connector",
+    default="all",
+    help="Name of connector to refresh or 'all' to refresh all",
+)
+def refresh_connectors(ctx, connector):
+    """Refresh the specified integration connector or ALL connectors if not specified"""
+    c = ctx.obj
+    refresh_connector(
+        connector, c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+    )
+
+
+@integration_daemon.command("restart")
+@click.pass_context
+@click.option(
+    "--connector",
+    default="all",
+    help="Name of connector to restart or 'all' to restart all",
+)
+def restart_connectors(ctx, connector):
+    """Restart the specified integration connector or ALL connectors if not specified"""
+    c = ctx.obj
+    restart_connector(
+        connector, c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+    )
+
+
+integration_daemon.add_command(add_catalog_target)
+integration_daemon.add_command(remove_catalog_target)
+integration_daemon.add_command(update_catalog_target)
+integration_daemon.add_command(stop_server)
+integration_daemon.add_command(start_server)
+
+
+@tell.group("engine-host")
+@click.pass_context
+def engine_host(ctx):
+    """Group of commands to an engine-host"""
+    pass
+
+
+engine_host.add_command(start_engine_host)
+engine_host.add_command(stop_engine_host)
+
+
+@tell.group("repository")
+@click.pass_context
+def repository(ctx):
+    """Group of commands to a repository"""
+    pass
+
+
+repository.add_command(load_archive)
+
+
+if __name__ == "__main__":
+    cli()

{pyegeria-0.7.29 → pyegeria-0.7.31}/examples/widgets/ops/monitor_engine_activity.py

@@ -89,7 +89,9 @@ def display_engine_activity(
         token = g_client.create_egeria_bearer_token()
         action_status = g_client.get_engine_actions()
         sorted_action_status = sorted(
-            action_status, key=lambda i: i["requestedTime"], reverse=True
+            action_status,
+            key=lambda i: i("requestedTime", time.asctime()),
+            reverse=True,
         )
         if type(action_status) is str:
             requested_time = " "