pyegeria 1.5.1.1.60__py3-none-any.whl → 5.2__py3-none-any.whl

pyegeria/commands/cli/egeria.py

@@ -9,21 +9,26 @@ A command line interface for Egeria Users - all commands
 This is an emerging capability based on the **click** package. Feedback welcome!
 
 """
+import os
+import sys
+
 import click
 from trogon import tui
 
+from pyegeria.commands.cli.egeria_login_tui import login
 from pyegeria.commands.cat.get_asset_graph import asset_viewer
 from pyegeria.commands.cat.get_collection import collection_viewer
 from pyegeria.commands.cat.get_project_dependencies import project_dependency_viewer
 from pyegeria.commands.cat.get_project_structure import project_structure_viewer
 from pyegeria.commands.cat.get_tech_type_elements import tech_viewer
+from pyegeria.commands.cat.list_tech_type_elements import list_tech_elements
 from pyegeria.commands.cli.egeria_ops import show_server
 from pyegeria.commands.tech.get_tech_type_template import template_viewer
 from pyegeria.commands.cat.list_assets import display_assets
 from pyegeria.commands.cat.list_cert_types import display_certifications
 from pyegeria.commands.cat.list_terms import display_glossary_terms
 from pyegeria.commands.cat.list_projects import display_project_list
-from pyegeria.commands.tech.list_element_graph import display_element_graph
+from pyegeria.commands.tech.list_anchored_elements import display_anchored_elements
 from pyegeria.commands.tech.list_elements_x import list_elements_x
 from pyegeria.commands.tech.list_relationships import list_relationships
 from pyegeria.commands.cat.list_tech_types import display_tech_types
@@ -39,6 +44,7 @@ from pyegeria.commands.my.monitor_open_todos import display_todos
 from pyegeria.commands.cat.list_deployed_database_schemas import (
     list_deployed_database_schemas,
 )
+from pyegeria.commands.cat.list_collections import display_collections
 from pyegeria.commands.cat.list_deployed_catalogs import list_deployed_catalogs
 from pyegeria.commands.cat.list_deployed_databases import list_deployed_databases
 from pyegeria.commands.cat.glossary_actions import (
@@ -108,98 +114,87 @@ from pyegeria.commands.tech.list_gov_action_processes import display_gov_process
 
 @tui()
 # @tui('menu', 'menu', 'A textual command line interface')
-@click.version_option("0.0.1", prog_name="egeria_ops")
+@click.version_option("0.5.2 ", prog_name="hey_egeria")
 @click.group()
 @click.option(
     "--server",
-    default="active-metadata-store",
-    envvar="EGERIA_METADATA_STORE",
+    default=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
     help="Egeria metadata store to work with",
 )
 @click.option(
     "--url",
-    default="https://localhost:9443",
-    envvar="EGERIA_PLATFORM_URL",
+    default=os.environ.get("EGERIA_PLATFORM_URL", "https://localhost:9443"),
     help="URL of Egeria metadata store platform to connect to",
 )
 @click.option(
-    "--integration-daemon",
-    default="integration-daemon",
-    envvar="EGERIA_INTEGRATION_DAEMON",
+    "--integration_daemon",
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
     help="Egeria integration daemon to work with",
 )
 @click.option(
     "--integration_daemon_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_INTEGRATION_DAEMON_URL",
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"),
     help="URL of Egeria integration daemon platform to connect to",
 )
 @click.option(
     "--view_server",
-    default="view-server",
-    envvar="EGERIA_VIEW_SERVER",
+    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
     help="Egeria view server to work with",
 )
 @click.option(
     "--view_server_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_VIEW_SERVER_URL",
+    default=os.environ.get("EGERIA_VIEW_SERVER_URL", "https://localhost:9443"),
     help="URL of Egeria view server platform to connect to",
 )
 @click.option(
     "--engine_host",
-    default="engine-host",
-    envvar="EGERIA_ENGINE_HOST",
+    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
     help="Egeria engine host to work with",
 )
 @click.option(
     "--engine_host_url",
-    default="https://localhost:9443",
-    envvar="EGERIA_ENGINE_HOST_URL",
+    default=os.environ.get("EGERIA_ENGINE_HOST_URL", "https://localhost:9443"),
     help="URL of Egeria engine host platform to connect to",
 )
 @click.option(
     "--admin_user",
-    default="garygeeke",
-    envvar="EGERIA_ADMIN_USER",
+    default=os.environ.get("EGERIA_ADMIN_USER", "garygeeke"),
     help="Egeria admin user",
 )
 @click.option(
     "--admin_user_password",
-    default="secret",
-    envvar="EGERIA_ADMIN_PASSWORD",
+    default=os.environ.get("EGERIA_ADMIN_PASSWORD", "secret"),
     help="Egeria admin password",
 )
 @click.option(
-    "--userid", default="erinoverview", envvar="EGERIA_USER", help="Egeria user"
+    "--userid",
+    default=os.environ.get("EGERIA_USER", "erinoverview"),
+    help="Egeria user",
 )
 @click.option(
     "--password",
-    default="secret",
-    envvar="EGERIA_PASSWORD",
+    default=os.environ.get("EGERIA_USER_PASSWORD", "secret"),
     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",
+    type=bool,
+    default=os.environ.get("EGERIA_JUPYTER", False),
     help="Enable for rendering in a Jupyter terminal",
 )
 @click.option(
     "--width",
-    default=200,
-    envvar="EGERIA_WIDTH",
+    default=os.environ.get("EGERIA_WIDTH", 200),
+    type=int,
     help="Screen width, in characters, to use",
 )
+@click.option(
+    "--home_glossary_guid",
+    default=os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None),
+    help="Glossary guid to use as the home glossary",
+)
 @click.pass_context
 def cli(
     ctx,
@@ -218,6 +213,7 @@ def cli(
     timeout,
     jupyter,
     width,
+    home_glossary_guid,
 ):
     """An Egeria Command Line interface for Operations"""
     ctx.obj = Config(
@@ -236,8 +232,9 @@ def cli(
         timeout,
         jupyter,
         width,
+        home_glossary_guid,
     )
-    ctx.max_content_width = 200
+    ctx.max_content_width = 250
     ctx.ensure_object(Config)
 
 
@@ -275,11 +272,7 @@ def show_my_profile(ctx):
 @my_show.command("my-roles")
 @click.pass_context
 def show_my_roles(ctx):
-    """Display my profiles
-
-    Usage: show my-profile
-
-    """
+    """Display my roles"""
     c = ctx.obj
     display_my_roles(
         c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
@@ -303,12 +296,7 @@ def show_my_todos(ctx):
 @my_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')
-    """
+    """Display Open Todo items"""
     c = ctx.obj
     display_todos(
         c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
@@ -374,8 +362,8 @@ def show_elements(ctx):
 @show_elements.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
+def show_guid_info(ctx, guid):
+    """Display guid information
 
     Usage: show guid-info <a guid>
 
@@ -384,22 +372,37 @@ def show_guid_infos(ctx, guid):
     display_guid(guid, c.server, c.url, c.userid, c.password, c.jupyter, c.width)
 
 
-@show_elements.command("element-graph")
+@show_elements.command("anchored_elements")
 @click.pass_context
-@click.option("--search-string", help="value we are searching for")
 @click.option(
-    "--prop-list", default="anchorTypeName", help="List of properties we are searching"
+    "--search-string",
+    default="DeployedDatabaseSchema",
+    help="value we are searching for",
+)
+@click.option(
+    "--prop-list",
+    default="anchorTypeName",
+    help="List of properties we are searching",
 )
-def list_element_graph(ctx, search_string: str, prop_list: str):
+def list_anchored_elements(ctx, search_string: str, prop_list: str):
     """List elements with the specified properties"""
     c = ctx.obj
-    display_element_graph(
+    if type(prop_list) is str:
+        property_names = prop_list.split(",")
+    elif type(prop_list) is list:
+        property_names = prop_list
+    else:
+        property_names = []
+        print(f"\nError --> Invalid property list - must be a string or list")
+        sys.exit(4)
+    display_anchored_elements(
         search_string,
-        prop_list,
+        [prop_list],
         c.view_server,
         c.view_server_url,
         c.userid,
         c.password,
+        c.timeout,
         c.jupyter,
         c.width,
     )
@@ -444,12 +447,7 @@ def show_tech_types(ctx, search_string):
 @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')
-    """
+    """Show technology type details"""
     c = ctx.obj
     tech_details_viewer(
         tech_name,
@@ -486,7 +484,7 @@ def show_tech_type_templates(ctx, tech_type):
 @show_tech_info.command("asset-types")
 @click.pass_context
 def show_asset_types(ctx):
-    """Display engine-host status information"""
+    """Display asset types"""
     c = ctx.obj
     display_asset_types(
         c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
@@ -528,16 +526,16 @@ def show_registered_services(ctx, services):
 
 @show_tech_info.command("relationship-types")
 @click.option(
-    "--rel-type",
+    "--om-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"""
+def show_relationship_types(ctx, om_type):
+    """Show information about the specified relationship types"""
     c = ctx.obj
     display_relationship_types(
-        rel_type,
+        om_type,
         c.view_server,
         c.view_server_url,
         c.userid,
@@ -561,7 +559,7 @@ def show_relationship_types(ctx, rel_type):
 )
 @click.pass_context
 def show_elements_by_classification(ctx, om_type, classification):
-    """Show information about the specified relationship type"""
+    """Show elements by classification"""
     c = ctx.obj
     list_classified_elements(
         om_type,
@@ -591,8 +589,8 @@ def show_elements_by_classification(ctx, om_type, classification):
     help="Relationship type to follow.",
 )
 @click.pass_context
-def show_relationship_types(ctx, element_guid, om_type, rel_type):
-    """Show information about the specified relationship type"""
+def show_related_elements(ctx, element_guid, om_type, rel_type):
+    """Show elements related to specified guid"""
     c = ctx.obj
     list_related_elements(
         element_guid,
@@ -722,7 +720,7 @@ def list_element_info(ctx, om_type, extended):
 @show_tech_info.command("processes")
 @click.pass_context
 def list_element_info(ctx):
-    """Display the valid metadata values for a property and type"""
+    """Display the governance action processes"""
     c = ctx.obj
     list_elements(
         "GovernanceActionProcess",
@@ -739,7 +737,7 @@ def list_element_info(ctx):
 @click.pass_context
 @click.option("--om_type", default="Project", help="Metadata type to query")
 def get_element_info(ctx, om_type):
-    """Display a table of elements for an Open Metadata Type"""
+    """Display a table of elements of an Open Metadata Type"""
     c = ctx.obj
     display_elements(
         om_type,
@@ -760,7 +758,7 @@ def get_element_info(ctx, om_type):
 @cli.group("cat")
 @click.pass_context
 def cat(ctx):
-    """Commands for the more tech user"""
+    """Commands for all users"""
     pass
 
 
@@ -789,6 +787,17 @@ def show_tech_types(ctx, tech_type):
     )
 
 
+@show_cat_info.command("collections")
+@click.option("--collection", default="*", help="Collection to search for")
+@click.pass_context
+def show_collections(ctx, collection):
+    """List Collections"""
+    c = ctx.obj
+    display_collections(
+        collection, c.view_server, c.view_server_url, c.userid, c.password
+    )
+
+
 @show_cat.group("assets")
 @click.pass_context
 def asset_group(ctx):
@@ -796,7 +805,7 @@ def asset_group(ctx):
     pass
 
 
-@asset_group.command("elements-of-type")
+@asset_group.command("elements-of-tech-type")
 @click.option(
     "--tech_type",
     default="PostgreSQL Server",
@@ -870,7 +879,7 @@ def glossary_group(ctx):
 )
 @click.option(
     "--glossary-guid",
-    default=None,
+    default=os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None),
     help="Optionally restrict search to glossary with the specified guid",
 )
 @click.option(
@@ -899,7 +908,7 @@ def show_terms(ctx, search_string, glossary_guid, glossary_name):
 @click.option("--search_string", default="*", help="Name to search for glossaries")
 @click.pass_context
 def glossaries(ctx, search_string):
-    """Display a tree graph of information about an asset"""
+    """Display a list of glossaries"""
     c = ctx.obj
     display_glossaries(
         search_string,
@@ -912,15 +921,15 @@ def glossaries(ctx, search_string):
     )
 
 
-@show_cat_info.command("collection")
+@show_cat_info.command("collection-graph")
 @click.option(
     "--root_collection",
-    default="Root Sustainability Collection",
+    default="Coco Pharmaceuticals Governance Domains",
     help="View of tree of collections from a given root",
 )
 @click.pass_context
-def show_asset_graph(ctx, root_collection):
-    """Display a tree graph of information about an asset"""
+def show_collection(ctx, root_collection):
+    """Display collection graph"""
     c = ctx.obj
     collection_viewer(
         root_collection,
@@ -962,9 +971,7 @@ def show_projects(ctx, search_string):
 @click.option("--search-string", default="CertificationType", help="")
 @click.pass_context
 def show_certification_types(ctx, search_string):
-    """Show certification types
-    - generally stay with the default.
-    """
+    """Show certification types"""
     c = ctx.obj
     display_certifications(
         search_string,
@@ -1046,7 +1053,7 @@ def show_project_dependencies(ctx, project):
 )
 @click.pass_context
 def show_todos(ctx, search_string, status):
-    """Display a tree graph of information about an asset"""
+    """Display list of To Dost"""
     c = ctx.obj
     list_todos(
         search_string,
@@ -1063,7 +1070,7 @@ def show_todos(ctx, search_string, status):
 @show_cat_info.command("user-ids")
 @click.pass_context
 def show_todos(ctx):
-    """Display a list of known user ids"""
+    """Display a list of known user-ids"""
     c = ctx.obj
     list_user_ids(
         c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
@@ -1197,9 +1204,7 @@ def show_tech_types(ctx, tech_type):
 @click.option("--search-string", default="CertificationType", help="")
 @click.pass_context
 def show_certification_types(ctx, search_string):
-    """Show certification types
-    - generally stay with the default..
-    """
+    """Show certification types"""
     c = ctx.obj
     display_certifications(
         search_string,
@@ -1320,30 +1325,11 @@ def show_asset_graph(ctx, asset_guid):
     help="Specific tech type to get elements for",
 )
 @click.pass_context
-def show_tech_type_elements(ctx, tech_type):
+def list_tech_type_elements(ctx, tech_type):
     """List technology type elements"""
     c = ctx.obj
-    tech_viewer(tech_type, c.view_server, c.view_server_url, c.userid, c.password)
-
-
-@show_cat_info.command("collection")
-@click.option(
-    "--root_collection",
-    default="Root Sustainability Collection",
-    help="View of tree of collections from a given root",
-)
-@click.pass_context
-def show_asset_graph(ctx, root_collection):
-    """Display information about a collection"""
-    c = ctx.obj
-    collection_viewer(
-        root_collection,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
+    list_tech_elements(
+        tech_type, c.view_server, c.view_server_url, c.userid, c.password
     )
 
 
@@ -1379,7 +1365,7 @@ def show_projects(ctx, search_string):
 )
 @click.pass_context
 def show_todos(ctx, search_string, status):
-    """Display a tree graph of information about an asset"""
+    """Display a list of To Dos"""
     c = ctx.obj
     list_todos(
         search_string,
@@ -1406,7 +1392,7 @@ def show_user_ids(ctx):
 @show_server.command("archives")
 @click.pass_context
 def archives(ctx):
-    """Display a tree graph of information about an asset"""
+    """Display a list of archivest"""
     c = ctx.obj
     display_archive_list(
         c.view_server,
@@ -1427,6 +1413,7 @@ def archives(ctx):
 )
 @click.pass_context
 def show_deployed_servers(ctx, search_string):
+    """Show list of deployed servers"""
     c = ctx.obj
     display_servers_by_dep_imp(
         search_string,
@@ -1445,7 +1432,7 @@ def show_deployed_servers(ctx, search_string):
 )
 @click.pass_context
 def deployed_schemas(ctx, search_catalog):
-    """Display a tree graph of information about an asset"""
+    """Display a list of deployed schemas"""
     c = ctx.obj
     list_deployed_database_schemas(
         search_catalog,
@@ -1462,7 +1449,7 @@ def deployed_schemas(ctx, search_catalog):
 @click.option("--search_server", default="*", help="Server to search for catalogs")
 @click.pass_context
 def catalogs(ctx, search_server):
-    """Display a tree graph of information about an asset"""
+    """Display a list of deployed catalogs"""
     c = ctx.obj
     list_deployed_catalogs(
         search_server,
@@ -1478,7 +1465,7 @@ def catalogs(ctx, search_server):
 @deployed_data.command("databases")
 @click.pass_context
 def databases(ctx):
-    """Display a tree graph of information about an asset"""
+    """Display a list of deployed databases"""
     c = ctx.obj
     list_deployed_databases(
         c.view_server, c.view_server_url, c.userid, c.password, c.jupyter, c.width
@@ -1489,7 +1476,7 @@ def databases(ctx):
 @click.option("--search_string", default="*", help="Name to search for glossaries")
 @click.pass_context
 def glossaries(ctx, search_string):
-    """Display a tree graph of information about an asset"""
+    """Display a list of glossaries"""
     c = ctx.obj
     display_glossaries(
         search_string,
@@ -1632,14 +1619,14 @@ def gov_eng_status(ctx, engine_list, engine_host, list):
     c = ctx.obj
     display_gov_eng_status(
         [engine_list],
-        engine_host,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        list,
-        c.jupyter,
-        c.width,
+        engine_host=engine_host,
+        view_server=c.view_server,
+        url=c.view_server_url,
+        username=c.userid,
+        user_pass=c.password,
+        paging=list,
+        jupyter=c.jupyter,
+        width=c.width,
     )
 
 
@@ -1710,7 +1697,7 @@ def integrations(ctx):
 )
 @click.pass_context
 def integrations_status(ctx, connector_list, list, sorted):
-    """Display integration-daemon status information"""
+    """Display integration_daemon status information"""
     c = ctx.obj
     display_integration_daemon_status(
         [connector_list],
@@ -1729,7 +1716,7 @@ def integrations_status(ctx, connector_list, list, sorted):
 
 @integrations.command("targets")
 @click.pass_context
-@click.argument("connector", nargs=1)
+@click.argument("--connector", nargs=1)
 def integrations_status(ctx, connector):
     """Display Catalog Targets for a connector"""
     c = ctx.obj
@@ -1759,7 +1746,7 @@ def tell_ops(ctx):
 @tell_ops.group("integration-daemon")
 @click.pass_context
 def tell_integration_daemon(ctx):
-    """Group of commands to an integration-daemon"""
+    """Group of commands to an integration_daemon"""
     pass
 
 
@@ -1843,4 +1830,8 @@ def repository(ctx):
 repository.add_command(load_archive)
 
 if __name__ == "__main__":
-    cli()
+    while True:
+        try:
+            cli()
+        except Exception as e:
+            click.echo(f"Error: {e}")