pyegeria 5.2.1__py3-none-any.whl → 5.3__py3-none-any.whl

{pyegeria/commands → commands}/cli/egeria_tech.py

@@ -4,7 +4,7 @@ SPDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
 
-A command line interface for Egeria Data techs.
+A object_action line interface for Egeria Data techs.
 
 This is an emerging capability based on the **click** package. Feedback welcome!
 
@@ -15,56 +15,52 @@ import sys
 import click
 from trogon import tui
 
-from pyegeria.commands.cat.list_tech_types import display_tech_types
-from pyegeria.commands.cli.ops_config import Config
-from pyegeria.commands.tech.get_guid_info import display_guid
-from pyegeria.commands.tech.get_tech_details import tech_details_viewer
-from pyegeria.commands.tech.list_asset_types import display_asset_types
-from pyegeria.commands.tech.list_elements_x import list_elements_x
-from pyegeria.commands.tech.list_registered_services import display_registered_svcs
-from pyegeria.commands.tech.list_relationship_types import display_relationship_types
-from pyegeria.commands.tech.list_tech_templates import display_templates_spec
-from pyegeria.commands.tech.list_valid_metadata_values import display_metadata_values
-from pyegeria.commands.tech.get_tech_type_template import template_viewer
-from pyegeria.commands.tech.list_anchored_elements import display_anchored_elements
-from pyegeria.commands.tech.list_elements import list_elements
-
-from pyegeria.commands.tech.get_element_info import display_elements
-from pyegeria.commands.tech.list_related_specification import (
-    display_related_specification,
+from commands.cat.list_tech_types import display_tech_types
+from commands.cli.ops_config import Config
+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.get_tech_type_template import template_viewer
+from commands.tech.list_all_om_type_elements import list_elements
+from commands.tech.list_all_om_type_elements_x import list_elements_x
+from commands.tech.list_all_related_elements import list_related_elements
+from commands.tech.list_anchored_elements import display_anchored_elements
+from commands.tech.list_asset_types import display_asset_types
+from commands.tech.list_elements_by_classification_by_property_value import (
+    find_elements_by_classification_by_prop_value,
+)
+from commands.tech.list_elements_by_property_value import (
+    find_elements_by_prop_value,
+)
+from commands.tech.list_elements_by_property_value_x import (
+    find_elements_by_prop_value_x,
 )
-from pyegeria.commands.tech.list_related_elements import list_related_elements
-from pyegeria.commands.tech.list_elements_for_classification import (
+from commands.tech.list_elements_for_classification import (
     list_classified_elements,
 )
-from pyegeria.commands.tech.list_gov_action_processes import display_gov_processes
-from pyegeria.commands.tech.get_tech_type_template import template_viewer
-
-# 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)
-
+from commands.tech.list_gov_action_processes import display_gov_processes
+from commands.tech.list_information_supply_chains import supply_chain_viewer
+from commands.tech.list_registered_services import display_registered_svcs
+from commands.tech.list_related_elements_with_prop_value import (
+    list_related_elements_with_prop_value,
+)
+from commands.tech.list_related_specification import (
+    display_related_specification,
+)
+from commands.tech.list_relationship_types import display_relationship_types
+from commands.tech.list_solution_blueprints import blueprint_list
+from commands.tech.list_solution_components import solution_component_list
+from commands.tech.list_solution_roles import solution_role_list
+from commands.tech.list_tech_templates import display_templates_spec
+from commands.tech.list_valid_metadata_values import display_metadata_values
+from commands.tech.generic_actions import delete_element
 
-# @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=os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store"),
+    default=os.environ.get("EGERIA_METADATA_STORE", "qs-metadata-store"),
     help="Egeria metadata store to work with",
 )
 @click.option(
@@ -74,7 +70,7 @@ from pyegeria.commands.tech.get_tech_type_template import template_viewer
 )
 @click.option(
     "--integration_daemon",
-    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "integration-daemon"),
+    default=os.environ.get("EGERIA_INTEGRATION_DAEMON", "qs-integration-daemon"),
     help="Egeria integration daemon to work with",
 )
 @click.option(
@@ -84,7 +80,7 @@ from pyegeria.commands.tech.get_tech_type_template import template_viewer
 )
 @click.option(
     "--view_server",
-    default=os.environ.get("EGERIA_VIEW_SERVER", "view-server"),
+    default=os.environ.get("EGERIA_VIEW_SERVER", "qs-view-server"),
     help="Egeria view server to work with",
 )
 @click.option(
@@ -94,7 +90,7 @@ from pyegeria.commands.tech.get_tech_type_template import template_viewer
 )
 @click.option(
     "--engine_host",
-    default=os.environ.get("EGERIA_ENGINE_HOST", "engine-host"),
+    default=os.environ.get("EGERIA_ENGINE_HOST", "qs-engine-host"),
     help="Egeria engine host to work with",
 )
 @click.option(
@@ -139,6 +135,11 @@ from pyegeria.commands.tech.get_tech_type_template import template_viewer
     default=os.environ.get("EGERIA_HOME_GLOSSARY_GUID", None),
     help="Glossary guid to use as the home glossary",
 )
+@click.option(
+    "--glossary_path",
+    default=os.environ.get("EGERIA_GLOSSARY_PATH", "/home/jovyan/loading-bay/glossary"),
+    help="Path to glossary import/export files",
+)
 @click.pass_context
 def cli(
     ctx,
@@ -157,6 +158,8 @@ def cli(
     timeout,
     jupyter,
     width,
+    home_glossary_guid,
+    home_glossary_path,
 ):
     """An Egeria Command Line interface for Operations"""
     ctx.obj = Config(
@@ -175,6 +178,8 @@ def cli(
         timeout,
         jupyter,
         width,
+        home_glossary_guid,
+        home_glossary_path,
     )
     ctx.max_content_width = 200
     ctx.ensure_object(Config)
@@ -207,6 +212,12 @@ def show_elements(ctx):
     """Show information about Egeria elements"""
 
 
+@show.group("solution-architecture")
+@click.pass_context
+def show_supply_chains(ctx):
+    """Show information about Information Supply Chains"""
+
+
 @show_elements.command("guid-info")
 @click.argument("guid", nargs=1)
 @click.pass_context
@@ -220,56 +231,248 @@ def show_guid_info(ctx, guid):
     display_guid(guid, c.server, c.url, c.userid, c.password, c.jupyter, c.width)
 
 
-@show_elements.command("related-specifications")
+@show_elements.command("anchored_elements")
 @click.pass_context
-@click.argument("element-guid")
-def show_related_specifications(ctx, element_guid):
-    """List specifications related to the given Element"""
+@click.option(
+    "--property_value",
+    default="DeployedDatabaseSchema",
+    help="value we are searching for",
+)
+@click.option(
+    "--prop-list",
+    default="anchorTypeName",
+    help="List of properties we are searching",
+)
+def list_anchored_elements(ctx, property_value: str, prop_list: str):
+    """List anchored elements with the specified properties"""
     c = ctx.obj
-    display_related_specification(
-        element_guid,
+    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("Error --> Invalid property list - must be a string or list")
+        sys.exit(4)
+    display_anchored_elements(
+        property_value,
+        [property_names],
         c.view_server,
         c.view_server_url,
         c.userid,
         c.password,
+        c.timeout,
         c.jupyter,
         c.width,
     )
 
 
-@show_elements.command("anchored-elements")
+@show_elements.command("elements-by-classification")
+@click.option(
+    "--om-type",
+    default="Referenceable",
+    help="Open Metadata type to filter by",
+)
+@click.option(
+    "--classification",
+    default="GovernanceProject",
+    help="Classification to filter byt",
+)
 @click.pass_context
+def show_elements_by_classification(ctx, om_type, classification):
+    """Show elements by classification"""
+    c = ctx.obj
+    list_classified_elements(
+        om_type,
+        classification,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_elements.command("elements-by-classification-by-prop-value")
 @click.option(
-    "--search-string",
-    default="SoftwareCapability",
-    help="value we are searching for",
+    "--classification",
+    default="GovernanceProject",
+    help="Classification to filter by",
 )
 @click.option(
-    "--prop-list",
-    default="anchorDomainName",
-    help="List of properties we are searching",
+    "--property_value",
+    help="Property value to filter by",
+)
+@click.option(
+    "--property_names",
+    help="List of properties to search by",
+)
+@click.option(
+    "--om-type",
+    default="Referenceable",
+    help="Open Metadata type to filter by",
 )
-def list_anchored_elements(ctx, search_string: str, prop_list: str):
-    """List elements with the specified properties"""
+@click.pass_context
+def show_elements_by_classification_by_prop(
+    ctx, classification, property_value, property_names, om_type
+):
+    """Show elements by classification and property value"""
     c = ctx.obj
-    # put guards around this to make it a list?
-    if type(prop_list) is str:
-        property_names = prop_list.split(",")
-    elif type(prop_list) is list:
-        property_names = prop_list
+    find_elements_by_classification_by_prop_value(
+        om_type,
+        classification,
+        property_value,
+        [property_names],
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_elements.command("elements-by-prop-value")
+@click.option(
+    "--property_value",
+    help="Property value to filter by",
+)
+@click.option(
+    "--property_names",
+    help="List of properties to search by",
+)
+@click.option(
+    "--om-type",
+    default="Referenceable",
+    help="Open Metadata type to filter by",
+)
+@click.option(
+    "--extended",
+    is_flag=True,
+    default=False,
+    help="If True, feedback information is displayed",
+)
+@click.pass_context
+def show_elements_by_classification_by_prop(
+    ctx, property_value, property_names, om_type, extended
+):
+    """Show elements by classification and property value"""
+    c = ctx.obj
+    if extended:
+        find_elements_by_prop_value_x(
+            om_type,
+            property_value,
+            [property_names],
+            c.view_server,
+            c.view_server_url,
+            c.userid,
+            c.password,
+            c.jupyter,
+            c.width,
+        )
     else:
-        property_names = []
-        print(f"\nError --> Invalid property list - must be a string or list")
-        sys.exit(4)
+        find_elements_by_prop_value(
+            om_type,
+            property_value,
+            [property_names],
+            c.view_server,
+            c.view_server_url,
+            c.userid,
+            c.password,
+            c.jupyter,
+            c.width,
+        )
 
-    display_anchored_elements(
-        search_string,
-        property_names,
+
+@show_elements.command("related-elements")
+@click.option(
+    "--element-guid",
+    help="GUID of the Element to navigate from.",
+)
+@click.option(
+    "--om-type",
+    default="Referenceable",
+    help="Open metadata type to filter by.",
+)
+@click.option(
+    "--rel-type",
+    default="Certification",
+    help="Relationship type to follow.",
+)
+@click.pass_context
+def show_related_elements(ctx, element_guid, om_type, rel_type):
+    """Show all elements related to specified guid"""
+    c = ctx.obj
+    list_related_elements(
+        element_guid,
+        om_type,
+        rel_type,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_elements.command("related-elements_by_prop")
+@click.option(
+    "--element-guid",
+    help="GUID of the Element to navigate from.",
+)
+@click.option(
+    "--rel-type",
+    default="Certification",
+    help="Relationship type to follow.",
+)
+@click.option(
+    "--property_value",
+    help="Property value to filter by",
+)
+@click.option(
+    "--property_names",
+    help="List of properties to search by",
+)
+@click.option(
+    "--om-type",
+    default="Referenceable",
+    help="Open metadata type to filter by.",
+)
+@click.pass_context
+def show_related_elements(
+    ctx, element_guid, rel_type, property_value, property_names, om_type
+):
+    """Show elements related to specified guid and property value"""
+    c = ctx.obj
+    list_related_elements_with_prop_value(
+        element_guid,
+        rel_type,
+        property_value,
+        [property_names],
+        om_type,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_elements.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.timeout,
         c.jupyter,
         c.width,
     )
@@ -382,7 +585,7 @@ def show_registered_services(ctx, services):
 @show_info.command("relationship-types")
 @click.option(
     "--om-type",
-    default="AssetOwner",
+    default="Referenceable",
     help="Relationship type to get information about",
 )
 @click.pass_context
@@ -401,65 +604,6 @@ def show_relationship_types(ctx, rel_type):
     )
 
 
-@show_elements.command("elements-by-classification")
-@click.option(
-    "--om-type",
-    default="Project",
-    help="Open Metadata type to filter by",
-)
-@click.option(
-    "--classification",
-    default="GovernanceProject",
-    help="Classification to filter byt",
-)
-@click.pass_context
-def show_elements_by_classification(ctx, om_type, classification):
-    """Show elements by classification"""
-    c = ctx.obj
-    list_classified_elements(
-        om_type,
-        classification,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
-
-
-@show_elements.command("related-elements")
-@click.option(
-    "--element-guid",
-    help="GUID of the Element to navigate from.",
-)
-@click.option(
-    "--om-type",
-    default="Project",
-    help="Open metadata type to filter by.",
-)
-@click.option(
-    "--rel-type",
-    default="Certification",
-    help="Relationship type to follow.",
-)
-@click.pass_context
-def show_related_elements(ctx, element_guid, om_type, rel_type):
-    """Show information about related elements"""
-    c = ctx.obj
-    list_related_elements(
-        element_guid,
-        om_type,
-        rel_type,
-        c.view_server,
-        c.view_server_url,
-        c.userid,
-        c.password,
-        c.jupyter,
-        c.width,
-    )
-
-
 @show_tech.command("tech-templates")
 @click.pass_context
 @click.option(
@@ -535,6 +679,39 @@ def valid_metadata_values(ctx, property, type_name):
     )
 
 
+@show_info.command("processes")
+@click.pass_context
+def list_element_info(ctx):
+    """Display processes"""
+    c = ctx.obj
+    list_elements(
+        "GovernanceActionProcess",
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_elements.command("get-elements")
+@click.pass_context
+@click.option("--om_type", default="Referenceable", help="Metadata type to query")
+def get_element_info(ctx, om_type):
+    """Display graph of 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,
+    )
+
+
 @show_elements.command("elements")
 @click.pass_context
 @click.option(
@@ -543,9 +720,9 @@ def valid_metadata_values(ctx, property, type_name):
     default=False,
     help="If True, feedback information is displayed",
 )
-@click.option("--om_type", default="Organization", help="Metadata type to query")
-def list_element_info(ctx, om_type, extended):
-    """Display elements of a specific Open Metadata Type"""
+@click.option("--om_type", default="Referenceable", help="Metadata type to query")
+def list_all_om_type_elements(ctx, om_type, extended):
+    """Display all elements of a specific Open Metadata Type"""
     c = ctx.obj
     if extended:
         list_elements_x(
@@ -569,13 +746,14 @@ def list_element_info(ctx, om_type, extended):
         )
 
 
-@show_info.command("processes")
+@show_supply_chains.command("supply-chains")
+@click.option("--search-string", default="*", help="Search string")
 @click.pass_context
-def list_element_info(ctx):
-    """Display the valid metadata values for a property and type"""
+def list_supply_chains(ctx, search_string):
+    """Display supply chains"""
     c = ctx.obj
-    list_elements(
-        "GovernanceActionProcess",
+    supply_chain_viewer(
+        search_string,
         c.view_server,
         c.view_server_url,
         c.userid,
@@ -585,14 +763,48 @@ def list_element_info(ctx):
     )
 
 
-@show_elements.command("get-elements")
+@show_supply_chains.command("blueprints")
+@click.option("--search-string", default="*", help="Search string")
 @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"""
+def list_blueprints(ctx, search_string):
+    """Display solution blueprints"""
     c = ctx.obj
-    display_elements(
-        om_type,
+    blueprint_list(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_supply_chains.command("solution-roles")
+@click.option("--search-string", default="*", help="Search string")
+@click.pass_context
+def list_solution_roles(ctx, search_string):
+    """Display solution roles"""
+    c = ctx.obj
+    solution_role_list(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show_supply_chains.command("solution-components")
+@click.option("--search-string", default="*", help="Search string")
+@click.pass_context
+def list_solution_components(ctx, search_string):
+    """Display solution componentss"""
+    c = ctx.obj
+    solution_component_list(
+        search_string,
         c.view_server,
         c.view_server_url,
         c.userid,
@@ -607,12 +819,12 @@ def get_element_info(ctx, om_type):
 #
 
 
-# @cli.group("tell")
-# @click.pass_context
-# def tell(ctx):
-#     """Perform actions an Egeria Objects"""
-#     pass
-
+@cli.group("tell")
+@click.pass_context
+def tell(ctx):
+    """Perform actions an Egeria Objects"""
+    pass
+tell.add_command(delete_element)
 
 if __name__ == "__main__":
     cli()