pyegeria 0.7.45__py3-none-any.whl → 0.8.0__py3-none-any.whl

examples/widgets/cli/egeria_tech.py

@@ -24,8 +24,9 @@ from examples.widgets.tech.list_valid_metadata_values import display_metadata_va
 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 examples.widgets.tech.list_related_specification import (
+    display_related_specification,
+)
 
 
 # from pyegeria import ServerOps
@@ -44,48 +45,143 @@ from examples.widgets.tech.list_related_specification import display_related_spe
 #
 # 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)
+@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:
@@ -99,8 +195,8 @@ def show(ctx):
     pass
 
 
-@show.command('guid-info')
-@click.argument('guid', nargs=1)
+@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
@@ -109,22 +205,28 @@ def show_guid_infos(ctx, guid):
 
     """
     c = ctx.obj
-    display_guid(guid, c.server, c.url,
-                 c.userid, c.password, c.jupyter, c.width)
+    display_guid(guid, c.server, c.url, c.userid, c.password, c.jupyter, c.width)
 
-@show.command('related-specifications')
+
+@show.command("related-specifications")
 @click.pass_context
-@click.argument('element-guid')
+@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')
+    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
@@ -135,14 +237,14 @@ def show_tech_types(ctx, search_string):
 
     """
 
-
     c = ctx.obj
-    display_tech_types(search_string, c.view_server, c.view_server_url,
-                       c.userid, c.password)
+    display_tech_types(
+        search_string, c.view_server, c.view_server_url, c.userid, c.password
+    )
 
 
-@show.command('tech-details')
-@click.argument('tech-name')
+@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
@@ -152,7 +254,15 @@ def show_tech_details(ctx, 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)
+    tech_details_viewer(
+        tech_name,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
 
 
 @show.command("asset-types")
@@ -160,94 +270,185 @@ def show_tech_details(ctx, tech_name):
 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')
+    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')
+    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)
+    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')
+@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)
+    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')
+@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)
+    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')
+@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')
+    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')
+@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)
+    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')
+@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)
+    display_elements(
+        om_type,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
 
 
 #
 #  Tell
 #
 
-@cli.group('tell')
+
+@cli.group("tell")
 @click.pass_context
 def tell(ctx):
     """Perform actions an Egeria Objects"""
     pass
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     cli()

examples/widgets/my/my_profile_actions.py

@@ -22,79 +22,97 @@ from pyegeria._exceptions import (
 )
 
 
-@click.command('add-todo')
-@click.argument('integration-connector')
-@click.argument('metadata-element-guid')
-@click.argument('catalog-target-name')
+@click.command("add-todo")
+@click.argument("integration-connector")
+@click.argument("metadata-element-guid")
+@click.argument("catalog-target-name")
 @click.pass_context
-def add_catalog_target(ctx, integration_connector: str, metadata_element_guid:str, catalog_target_name:str)-> str:
+def add_catalog_target(
+    ctx,
+    integration_connector: str,
+    metadata_element_guid: str,
+    catalog_target_name: str,
+) -> str:
     """Add catalog targets to the specified integration connector"""
     try:
         if integration_connector not in INTEGRATION_GUIDS.keys():
-            click.echo('Integration connector is not known')
+            click.echo("Integration connector is not known")
 
         c = ctx.obj
-        a_client = AutomatedCuration(c.view_server, c.view_server_url, c.userid, c.password)
+        a_client = AutomatedCuration(
+            c.view_server, c.view_server_url, c.userid, c.password
+        )
         token = a_client.create_egeria_bearer_token()
 
-        guid = a_client.add_catalog_target(INTEGRATION_GUIDS[integration_connector], metadata_element_guid,
-                                           catalog_target_name)
-
-        click.echo(f"Added catalog target to {integration_connector} with a return guid of {guid}")
+        guid = a_client.add_catalog_target(
+            INTEGRATION_GUIDS[integration_connector],
+            metadata_element_guid,
+            catalog_target_name,
+        )
 
+        click.echo(
+            f"Added catalog target to {integration_connector} with a return guid of {guid}"
+        )
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
 
 
-
-@click.command('remove-target')
-@click.argument('relationship-guid')
+@click.command("remove-target")
+@click.argument("relationship-guid")
 @click.pass_context
 def remove_catalog_target(ctx, relationship_guid: str):
     """Remove the catalog target specified by the relationship guidr"""
     try:
         c = ctx.obj
-        a_client = AutomatedCuration(c.view_server, c.view_server_url, c.userid, c.password)
+        a_client = AutomatedCuration(
+            c.view_server, c.view_server_url, c.userid, c.password
+        )
         token = a_client.create_egeria_bearer_token()
 
         a_client.remove_catalog_target(relationship_guid)
 
-        click.echo(f"Removed catalog target with relationship guid of {relationship_guid}")
-
+        click.echo(
+            f"Removed catalog target with relationship guid of {relationship_guid}"
+        )
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
 
 
-@click.command('update-target')
-@click.argument('relationship-guid')
-@click.argument('catalog-target-name')
+@click.command("update-target")
+@click.argument("relationship-guid")
+@click.argument("catalog-target-name")
 @click.pass_context
-def update_catalog_target(ctx, relationship_guid: str, catalog_target_name:str):
-    """Update the catalog target specified by the relationship guid """
+def update_catalog_target(ctx, relationship_guid: str, catalog_target_name: str):
+    """Update the catalog target specified by the relationship guid"""
     try:
         c = ctx.obj
-        a_client = AutomatedCuration(c.view_server, c.view_server_url, c.userid, c.password)
+        a_client = AutomatedCuration(
+            c.view_server, c.view_server_url, c.userid, c.password
+        )
         token = a_client.create_egeria_bearer_token()
 
         guid = a_client.update_catalog_target(relationship_guid, catalog_target_name)
 
-        click.echo(f"Update catalog target with relationship guid of  {relationship_guid} to a catalog target name of "
-                   f"{catalog_target_name} with a return guid of {guid}")
-
+        click.echo(
+            f"Update catalog target with relationship guid of  {relationship_guid} to a catalog target name of "
+            f"{catalog_target_name} with a return guid of {guid}"
+        )
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
 
 
-@click.command('stop')
+@click.command("stop")
 @click.pass_context
 def stop_server(ctx):
     """Stop an integration daemon"""
     try:
         c = ctx.obj
-        p_client = Platform(c.integration_daemon, c.integration_daemon_url, c.userid, c.password)
+        p_client = Platform(
+            c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+        )
 
         p_client.shutdown_server()
 
@@ -103,13 +121,15 @@ def stop_server(ctx):
         print_exception_response(e)
 
 
-@click.command('start')
+@click.command("start")
 @click.pass_context
 def start_server(ctx):
-    """Start or restart an integration daemon from its known configuration """
+    """Start or restart an integration daemon from its known configuration"""
     try:
         c = ctx.obj
-        p_client = Platform(c.integration_daemon, c.integration_daemon_url, c.userid, c.password)
+        p_client = Platform(
+            c.integration_daemon, c.integration_daemon_url, c.userid, c.password
+        )
 
         p_client.activate_server_stored_config()
 
@@ -117,4 +137,3 @@ def start_server(ctx):
 
     except (InvalidParameterException, PropertyServerException) as e:
         print_exception_response(e)
-