pyegeria 0.8.4.18__py3-none-any.whl → 0.8.4.19__py3-none-any.whl

{examples/widgets → commands}/cli/egeria.py

@@ -12,66 +12,66 @@ This is an emerging capability based on the **click** package. Feedback welcome!
 import click
 from trogon import tui
 
-from examples.widgets.cat.get_asset_graph import asset_viewer
-from examples.widgets.cat.get_collection import collection_viewer
-from examples.widgets.cat.get_project_dependencies import project_dependency_viewer
-from examples.widgets.cat.get_project_structure import project_structure_viewer
-from examples.widgets.cat.get_tech_type_elements import tech_viewer
-from examples.widgets.cat.get_tech_type_template import template_viewer
-from examples.widgets.cat.list_assets import display_assets
-from examples.widgets.cat.list_cert_types import display_certifications
-from examples.widgets.cat.list_glossary import display_glossary_terms
-from examples.widgets.cat.list_projects import display_project_list
-from examples.widgets.cat.list_relationships import list_relationships
-from examples.widgets.cat.list_tech_types import display_tech_types
-from examples.widgets.cat.list_todos import display_to_dos as list_todos
-from examples.widgets.cat.list_user_ids import list_user_ids
-from examples.widgets.cat.list_archives import display_archive_list
-from examples.widgets.cli.ops_config import Config
-from examples.widgets.my.list_my_profile import display_my_profile
-from examples.widgets.my.list_my_roles import display_my_roles
-from examples.widgets.my.monitor_my_todos import display_my_todos
-from examples.widgets.my.monitor_open_todos import display_todos
-from examples.widgets.ops.engine_actions import (
+from commands.cat.get_asset_graph import asset_viewer
+from commands.cat.get_collection import collection_viewer
+from commands.cat.get_project_dependencies import project_dependency_viewer
+from commands.cat.get_project_structure import project_structure_viewer
+from commands.cat.get_tech_type_elements import tech_viewer
+from commands.cat.get_tech_type_template import template_viewer
+from commands.cat.list_assets import display_assets
+from commands.cat.list_cert_types import display_certifications
+from commands.cat.list_glossary import display_glossary_terms
+from commands.cat.list_projects import display_project_list
+from commands.cat.list_relationships import list_relationships
+from commands.cat.list_tech_types import display_tech_types
+from commands.cat.list_todos import display_to_dos as list_todos
+from commands.cat.list_user_ids import list_user_ids
+from commands.cat.list_archives import display_archive_list
+from commands.cli.ops_config import Config
+from commands.my.list_my_profile import display_my_profile
+from commands.my.list_my_roles import display_my_roles
+from commands.my.monitor_my_todos import display_my_todos
+from commands.my.monitor_open_todos import display_todos
+from commands.ops.engine_actions import (
     start_daemon as start_engine_host,
     stop_daemon as stop_engine_host,
 )
-from examples.widgets.ops.integration_daemon_actions import (
+from commands.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 (
+from commands.ops.list_catalog_targets import display_catalog_targets
+from commands.ops.load_archive import load_archive
+from commands.ops.monitor_engine_activity import display_engine_activity
+from commands.ops.monitor_engine_activity_c import display_engine_activity_c
+from commands.ops.monitor_gov_eng_status import display_gov_eng_status
+from commands.ops.monitor_integ_daemon_status import (
     display_integration_daemon_status,
 )
-from examples.widgets.ops.monitor_platform_status import (
+from commands.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 (
+from commands.ops.monitor_server_list import display_status as display_list
+from commands.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
-from examples.widgets.tech.get_element_info import display_elements
-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_elements import list_elements
-from examples.widgets.tech.list_registered_services import display_registered_svcs
-from examples.widgets.tech.list_related_specification import (
+from commands.ops.refresh_integration_daemon import refresh_connector
+from commands.ops.restart_integration_daemon import restart_connector
+from commands.tech.get_element_info import display_elements
+from commands.tech.get_guid_info import display_guid
+from commands.tech.get_tech_details import tech_details_viewer
+from commands.tech.list_asset_types import display_asset_types
+from commands.tech.list_elements import list_elements
+from commands.tech.list_registered_services import display_registered_svcs
+from commands.tech.list_related_specification import (
     display_related_specification,
 )
-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 commands.tech.list_relationship_types import display_relationship_types
+from commands.tech.list_tech_templates import display_templates_spec
+from commands.tech.list_valid_metadata_values import display_metadata_values
 
 
 @tui()

{examples/widgets → commands}/cli/egeria_cat.py

@@ -12,24 +12,24 @@ This is an emerging capability based on the **click** package. Feedback welcome!
 import click
 from trogon import tui
 
-from examples.widgets.cat.get_asset_graph import asset_viewer
-from examples.widgets.cat.get_collection import collection_viewer
-from examples.widgets.cat.get_tech_type_elements import tech_viewer
-from examples.widgets.cat.get_tech_type_template import template_viewer
-from examples.widgets.cat.list_assets import display_assets
-from examples.widgets.cat.list_glossary import display_glossary_terms
-from examples.widgets.cat.list_tech_types import display_tech_types
-from examples.widgets.cat.list_projects import display_project_list
-from examples.widgets.cat.list_todos import display_to_dos as list_todos
-from examples.widgets.cat.get_project_structure import project_structure_viewer
-from examples.widgets.cat.get_project_dependencies import project_dependency_viewer
-from examples.widgets.cat.list_cert_types import display_certifications
-from examples.widgets.cat.list_relationships import list_relationships
-from examples.widgets.cat.list_user_ids import list_user_ids
-from examples.widgets.cat.list_archives import display_archive_list
+from commands.cat.get_asset_graph import asset_viewer
+from commands.cat.get_collection import collection_viewer
+from commands.cat.get_tech_type_elements import tech_viewer
+from commands.cat.get_tech_type_template import template_viewer
+from commands.cat.list_assets import display_assets
+from commands.cat.list_glossary import display_glossary_terms
+from commands.cat.list_tech_types import display_tech_types
+from commands.cat.list_projects import display_project_list
+from commands.cat.list_todos import display_to_dos as list_todos
+from commands.cat.get_project_structure import project_structure_viewer
+from commands.cat.get_project_dependencies import project_dependency_viewer
+from commands.cat.list_cert_types import display_certifications
+from commands.cat.list_relationships import list_relationships
+from commands.cat.list_user_ids import list_user_ids
+from commands.cat.list_archives import display_archive_list
 
 # from pyegeria import ServerOps
-from examples.widgets.cli.ops_config import Config
+from commands.cli.ops_config import Config
 
 
 # class Config(object):

commands/cli/egeria_my.py

@@ -0,0 +1,269 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+A command line interface for Egeria Users - of individual relevance
+
+This is an emerging capability based on the **click** package. Feedback welcome!
+
+"""
+import click
+from trogon import tui
+
+from commands.cli.ops_config import Config
+
+from commands.my.monitor_open_todos import display_todos
+from commands.my.monitor_my_todos import display_my_todos
+from commands.my.list_my_profile import display_my_profile
+from commands.my.list_my_roles import display_my_roles
+from commands.my.todo_actions import (
+    create_todo,
+    delete_todo,
+    change_todo_status,
+    mark_todo_complete,
+    reassign_todo,
+)
+
+
+# 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.command("my-profile")
+@click.pass_context
+def show_my_profile(ctx):
+    """Display my profiles
+
+    Usage: show my-profile
+
+    """
+    c = ctx.obj
+    display_my_profile(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("my-roles")
+@click.pass_context
+def show_my_roles(ctx):
+    """Display my profiles
+
+    Usage: show my-profile
+
+    """
+    c = ctx.obj
+    display_my_roles(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("my-to-dos")
+@click.pass_context
+def show_my_todos(ctx):
+    """Show my To-Dos
+
+    Usage: show my-to-dos
+
+    """
+    c = ctx.obj
+    display_my_todos(
+        c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
+    )
+
+
+@show.command("open-to-dos")
+@click.pass_context
+def show_open_todos(ctx):
+    """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
+    display_todos(
+        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.add_command(create_todo)
+tell.add_command(delete_todo)
+tell.add_command(change_todo_status)
+tell.add_command(mark_todo_complete)
+tell.add_command(reassign_todo)
+
+
+if __name__ == "__main__":
+    cli()

{examples/widgets → commands}/cli/egeria_ops.py

@@ -13,36 +13,34 @@ 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 commands.cli.ops_config import Config
+from commands.ops.engine_actions import (
+    start_server,
+    stop_server,
+    refresh_gov_eng_config,
 )
-from examples.widgets.ops.integration_daemon_actions import (
+from commands.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 (
+from commands.ops.list_catalog_targets import display_catalog_targets
+from commands.ops.load_archive import load_archive
+from commands.ops.monitor_engine_activity import display_engine_activity
+from commands.ops.monitor_engine_activity_c import display_engine_activity_c
+from commands.ops.monitor_gov_eng_status import display_gov_eng_status
+from commands.ops.monitor_integ_daemon_status import (
     display_integration_daemon_status,
 )
-from examples.widgets.ops.monitor_platform_status import (
+from commands.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 (
+from commands.ops.monitor_server_list import display_status as display_list
+from commands.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
-
+from commands.ops.refresh_integration_daemon import refresh_connector
+from commands.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,
@@ -379,6 +377,10 @@ def tell(ctx):
     pass
 
 
+tell.add_command(start_server)
+tell.add_command(stop_server)
+
+
 @tell.group("integration-daemon")
 @click.pass_context
 def integration_daemon(ctx):
@@ -419,8 +421,6 @@ def restart_connectors(ctx, connector):
 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")
@@ -430,8 +430,7 @@ def engine_host(ctx):
     pass
 
 
-engine_host.add_command(start_engine_host)
-engine_host.add_command(stop_engine_host)
+engine_host.add_command(refresh_gov_eng_config)
 
 
 @tell.group("repository")

{examples/widgets → commands}/cli/egeria_tech.py

@@ -12,19 +12,19 @@ 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 (
+from commands.cat.list_tech_types import display_tech_types
+from commands.cli.ops_config import Config
+from commands.tech.get_guid_info import display_guid
+from commands.tech.get_tech_details import tech_details_viewer
+from commands.tech.list_asset_types import display_asset_types
+from commands.tech.list_registered_services import display_registered_svcs
+from commands.tech.list_relationship_types import display_relationship_types
+from commands.tech.list_tech_templates import display_templates_spec
+from commands.tech.list_valid_metadata_values import display_metadata_values
+from commands.cat.get_tech_type_template import template_viewer
+from commands.tech.list_elements import list_elements
+from commands.tech.get_element_info import display_elements
+from commands.tech.list_related_specification import (
     display_related_specification,
 )
 

commands/ops/engine_actions.py

@@ -0,0 +1,131 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Execute engine actions.
+
+"""
+import os
+
+import click
+
+from commands.ops.monitor_engine_activity import EGERIA_ENGINE_HOST
+
+# from ops_config import Config, pass_config
+from pyegeria import EgeriaTech
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    print_exception_response,
+)
+
+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_INTEGRATION_DAEMON_URL = os.environ.get(
+    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
+)
+
+EGERIA_USER = os.environ.get("EGERIA_USER", "garygeeke")
+EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
+
+
+@click.command("stop")
+@click.option("--server", help="OMAG Server to stop")
+@click.option(
+    "--view-server", default=EGERIA_VIEW_SERVER, help="View Server to communicate with"
+)
+@click.option(
+    "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
+)
+@click.option("--userid", default="garygeeke", envvar="EGERIA_USER", help="Egeria user")
+@click.option(
+    "--password",
+    default="secret",
+    envvar="EGERIA_PASSWORD",
+    help="Egeria user password",
+)
+def stop_server(view_server, server, url, userid, password):
+    """Stop an engine-host daemon"""
+    p_client = EgeriaTech(view_server, url, userid, password)
+    token = p_client.create_egeria_bearer_token()
+    try:
+        server_guid = p_client.get_guid_for_name(server)
+
+        p_client.shutdown_server(server_guid)
+        click.echo(f"Stopped server {server}")
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()
+
+
+@click.command("start")
+@click.option("--server", help="OMAG Server to start")
+@click.option(
+    "--view-server", default=EGERIA_VIEW_SERVER, help="View Server to communicate with"
+)
+@click.option(
+    "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
+)
+@click.option("--userid", default="garygeeke", envvar="EGERIA_USER", help="Egeria user")
+@click.option(
+    "--password",
+    default="secret",
+    envvar="EGERIA_PASSWORD",
+    help="Egeria user password",
+)
+def start_server(view_server, server, url, userid, password):
+    """Start or restart an engine-host from its known configuration"""
+    p_client = EgeriaTech(view_server, url, userid, password)
+    token = p_client.create_egeria_bearer_token()
+    try:
+        server_guid = p_client.get_guid_for_name(server)
+        p_client.activate_server_with_stored_config(server_guid)
+
+        click.echo(f"Started server {server}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()
+
+
+@click.command("refresh-gov-eng-config")
+@click.option(
+    "--engine-host", default=EGERIA_ENGINE_HOST, help="Engine Host to refresh"
+)
+@click.option(
+    "--view-server", default=EGERIA_VIEW_SERVER, help="View Server to communicate with"
+)
+@click.option(
+    "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
+)
+@click.option("--userid", default="garygeeke", envvar="EGERIA_USER", help="Egeria user")
+@click.option(
+    "--password",
+    default="secret",
+    envvar="EGERIA_PASSWORD",
+    help="Egeria user password",
+)
+def refresh_gov_eng_config(engine_host, view_server, url, userid, password):
+    """Start or restart an engine-host from its known configuration"""
+    p_client = EgeriaTech(view_server, url, userid, password)
+    token = p_client.create_egeria_bearer_token()
+    try:
+        engine_host_guid = p_client.get_guid_for_name(engine_host)
+        p_client.refresh_gov_eng_config(engine_host_guid)
+
+        click.echo(f"Refreshed server {engine_host}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        p_client.close_session()