pyegeria 1.5.1.0.3__tar.gz → 1.5.1.0.4__tar.gz

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/PKG-INFO

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

pyegeria-1.5.1.0.4/commands/cat/list_deployed_catalogs.py

@@ -0,0 +1,187 @@
+"""This creates a templates guid file from the core metadata archive"""
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+import os
+import argparse
+import time
+import sys
+from rich import box
+from rich.console import Console
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+
+
+console = Console()
+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"))
+
+
+def check_if_template(header: dict) -> bool:
+    """Check if the the template classification is set"""
+    classifications = header.get("classifications", None)
+    if classifications is None:
+        return False
+    for c in classifications:
+        if c["type"]["typeName"] == "Template":
+            return True
+    return False
+
+
+def list_deployed_catalogs(
+    uc_server_name: str,
+    server: str,
+    url: str,
+    username: str,
+    password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    token = c_client.create_egeria_bearer_token()
+
+    def generate_table() -> Table:
+        """Make a new table."""
+        table = Table(
+            caption=f"Databases found: {url} - {server} @ {time.asctime()}",
+            style="bold bright_white on black",
+            row_styles=["bold bright_white on black"],
+            header_style="white on dark_blue",
+            title_style="bold bright_white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            # title=f"Elements for Open Metadata Type: '{om_type}' ",
+            expand=True,
+            # width=500
+        )
+
+        table.add_column("Catalog Name/GUID", width=38, no_wrap=True)
+        table.add_column("Catalog Server")
+        table.add_column("Properties")
+        table.add_column("Catalog Schemas")
+
+        om_type = "DeployedDatabaseSchema"
+
+        cats = c_client.get_elements_by_classification("Anchors", "Catalog")
+        if type(cats) is list:
+            for cat in cats:
+                header = cat["elementHeader"]
+
+                if check_if_template(header):
+                    continue
+                el_guid = header["guid"]
+                el_name = cat["properties"].get("name", "---")
+                el_id = f"{el_name}\n{el_guid}"
+                el_home = header["origin"]["homeMetadataCollectionName"]
+
+                el_anchors_md = ""
+                class_info = header["classifications"]
+                for class_i in class_info:
+                    class_prop = class_i.get("classificationProperties", None)
+                    if class_prop:
+                        for anchor in class_prop.keys():
+                            if anchor == "anchorGUID":
+                                server_guid = class_prop[anchor]
+                            el_anchors_md += f"* **{anchor}**: {class_prop[anchor]}\n"
+                el_anchors_out = Markdown(el_anchors_md)
+
+                el_props_md = ""
+                for prop in cat["properties"].keys():
+                    el_props_md += f"* **{prop}**: {cat['properties'][prop]}\n"
+                el_props_out = Markdown(el_props_md)
+
+                schemas = c_client.get_elements_by_classification_with_property_value(
+                    "Anchors", el_guid, ["anchorGUID"], "DeployedDatabaseSchema"
+                )
+                schemas_md = ""
+                if type(schemas) is list:
+                    for schema in schemas:
+                        schema_md = ""
+                        schema_props = schema["properties"]
+                        for key in schema_props.keys():
+                            schema_md += f"* **{key}**: {schema_props[key]}\n"
+                        schemas_md += schema_md
+                schemas_md_out = Markdown(schemas_md)
+
+                element_info = c_client.get_element_by_guid(server_guid)
+                element_info_md = ""
+                for key in element_info["properties"].keys():
+                    element_info_md += (
+                        f"* **{key}**: {element_info['properties'][key]}\n"
+                    )
+                element_info_out = Markdown(element_info_md)
+
+                table.add_row(
+                    el_id,
+                    element_info_out,
+                    el_props_out,
+                    schemas_md_out,
+                )
+
+            return table
+        else:
+            print("No instances found")
+            sys.exit(1)
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter)
+
+        with console.pager(styles=True):
+            console.print(generate_table())
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+        print("\n\nPerhaps the type name isn't known")
+    finally:
+        c_client.close_session()
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="Password")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    password = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        # uc_server_name = Prompt.ask(
+        #     "Enter the name of a server to retrieve schemas for", default="*"
+        # )
+        uc_server_name = None
+        list_deployed_catalogs(uc_server_name, server, url, userid, password)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/commands/cat/list_deployed_database_schemas.py

@@ -74,19 +74,25 @@ def list_deployed_database_schemas(
             # width=500
         )
 
-        table.add_column("Name")
-        table.add_column("Type")
-        table.add_column("Created", width=23)
-        table.add_column("Home Store")
-        table.add_column("GUID", width=38, no_wrap=True)
-        table.add_column("Properties")
-        table.add_column("Tables")
+        table.add_column("Schema in Catalog")
+        table.add_column("Schema Properties")
+
+        # table.add_column("Home Store")
+        # table.add_column("GUID", width=38, no_wrap=True)
+        # table.add_column("Properties")
+        table.add_column("Cataloged Resource")
 
         om_type = "DeployedDatabaseSchema"
+
+        # get the guid for the database or catalog
+
         if db_name in (None, "*"):
             dbs = c_client.get_elements(om_type)
         else:
-            dbs = c_client.get_elements_by_property_value(db_name, "name", om_type)
+            db_guid = c_client.get_guid_for_name(db_name)
+            dbs = c_client.get_elements_by_classification_with_property_value(
+                "Anchors", db_guid, ["anchorGUID"], om_type
+            )
 
         if type(dbs) is list:
             for element in dbs:
@@ -108,6 +114,24 @@ def list_deployed_database_schemas(
 
                 el_guid = header["guid"]
 
+                el_classification = header["classifications"]
+                for c in el_classification:
+                    if c["type"]["typeName"] == "Anchors":
+                        el_anchor_guid = c["classificationProperties"]["anchorGUID"]
+                        el_anchor_type_name = c["classificationProperties"][
+                            "anchorTypeName"
+                        ]
+                        if el_anchor_type_name == "Catalog":
+                            el_cat = c_client.get_element_by_guid(el_anchor_guid)
+                            el_cat_name = el_cat["properties"].get("name", None)
+                            if el_cat_name is None:
+                                el_cat_name = el_cat["properties"].get(
+                                    "qualifiedName", "---"
+                                )
+                            el_cat_guid = el_cat["elementHeader"]["guid"]
+                el_schema_id = (
+                    f"{el_name}\n{el_guid}\n\n\t\tin\n\n{el_cat_name}\n{el_cat_guid}"
+                )
                 el_props_md = ""
                 for prop in element["properties"].keys():
                     el_props_md += f"* **{prop}**: {element['properties'][prop]}\n"
@@ -139,11 +163,11 @@ def list_deployed_database_schemas(
                     rel_el_out = Markdown(rel_el_md)
 
                 table.add_row(
-                    el_name,
-                    el_type,
-                    el_created_out,
-                    el_home,
-                    el_guid,
+                    el_schema_id,
+                    # el_type,
+                    # el_created_out,
+                    # el_home,
+                    # el_guid,
                     el_props_out,
                     rel_el_out,
                 )

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/commands/cli/egeria.py

@@ -32,6 +32,9 @@ 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.cat.list_deployed_database_schemas import list_deployed_database_schemas
+from commands.cat.list_deployed_catalogs import list_deployed_catalogs
+
 
 from commands.ops.gov_server_actions import (
     add_catalog_target,
@@ -71,6 +74,7 @@ from commands.tech.list_related_specification import (
 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.tech.list_gov_action_processes import display_gov_processes
 
 
 @tui()
@@ -540,6 +544,23 @@ def tech_template_spec(ctx, search_string):
     )
 
 
+@show.command("gov-action-processes")
+@click.pass_context
+@click.option("--search-string", default="*", help="Search string")
+def gov_action_processes(ctx, search_string):
+    """Display available governance action processes."""
+    c = ctx.obj
+    display_gov_processes(
+        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")
@@ -888,6 +909,42 @@ def list_archives(ctx):
     )
 
 
+@show.command("list-deployed-schemas")
+@click.option("--search-string", default="*", help="What database or catalog to search")
+@click.pass_context
+def list_deployed_schemas(search_string, ctx):
+    """Display a tree graph of information about an asset"""
+    c = ctx.obj
+    list_deployed_database_schemas(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        None,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("list-catalogs")
+# @click.option("--search-string", default="*", help="What database or catalog to search")
+@click.pass_context
+def list_catalogs(ctx):
+    """Display a tree graph of information about an asset"""
+    c = ctx.obj
+    list_deployed_catalogs(
+        " ",
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        None,
+        c.jupyter,
+        c.width,
+    )
+
+
 #
 #  Catalog User: Tell
 #

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/commands/cli/egeria_cat.py

@@ -27,6 +27,9 @@ 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 commands.cat.list_deployed_database_schemas import list_deployed_database_schemas
+from commands.cat.list_deployed_catalogs import list_deployed_catalogs
+
 
 # from pyegeria import ServerOps
 from commands.cli.ops_config import Config
@@ -486,6 +489,42 @@ def list_archives(ctx):
     )
 
 
+@show.command("list-deployed-schemas")
+@click.option("--search-string", default="*", help="What database or catalog to search")
+@click.pass_context
+def list_deployed_schemas(search_string, ctx):
+    """Display a tree graph of information about an asset"""
+    c = ctx.obj
+    list_deployed_database_schemas(
+        search_string,
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        None,
+        c.jupyter,
+        c.width,
+    )
+
+
+@show.command("list-catalogs")
+# @click.option("--search-string", default="*", help="What database or catalog to search")
+@click.pass_context
+def list_catalogs(ctx):
+    """Display a tree graph of information about an asset"""
+    c = ctx.obj
+    list_deployed_catalogs(
+        " ",
+        c.view_server,
+        c.view_server_url,
+        c.userid,
+        c.password,
+        None,
+        c.jupyter,
+        c.width,
+    )
+
+
 #
 #  Tell
 #

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/commands/cli/egeria_tech.py

@@ -29,7 +29,7 @@ from commands.tech.list_related_specification import (
 )
 from commands.tech.list_related_elements import list_related_elements
 from commands.tech.list_elements_for_classification import list_classified_elements
-
+from commands.tech.list_gov_action_processes import display_gov_processes
 
 # from pyegeria import ServerOps
 
@@ -429,6 +429,23 @@ def tech_template_spec(ctx, search_string):
     )
 
 
+@show.command("gov-action-processes")
+@click.pass_context
+@click.option("--search-string", default="*", help="Search string")
+def gov_action_processes(ctx, search_string):
+    """Display available governance action processes."""
+    c = ctx.obj
+    display_gov_processes(
+        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")

pyegeria-1.5.1.0.4/commands/tech/list_gov_action_processes.py

@@ -0,0 +1,139 @@
+#!/usr/bin/env python3
+"""
+SPDX-Lic
+ense-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+List the currently loaded Governance Action Processes.
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich import box
+from rich import print
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+from pyegeria import ValidMetadataManager
+
+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"))
+
+
+def display_gov_processes(
+    type_name: str,
+    server: str,
+    url: str,
+    username: str,
+    user_pass: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+) -> Table:
+    p_client = EgeriaTech(server, url, user_id=username, user_pwd=user_pass)
+    token = p_client.create_egeria_bearer_token(username, user_pass)
+
+    def generate_table(type_name: str) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Available Governance Action Processes  @ {time.asctime()}",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            header_style="white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"list for Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+
+        table.add_column(
+            "Name",
+            no_wrap=True,
+        )
+        table.add_column("Qualified Name")
+        table.add_column(
+            "GUID",
+            no_wrap=True,
+        )
+        table.add_column("Description")
+
+        process_list = p_client.find_gov_action_processes(type_name)
+
+        if type(process_list) is str:
+            print("No Governance Processes found matching the type name\n")
+            sys.exit(1)
+
+        for proc in process_list:
+            guid = proc["elementHeader"]["guid"]
+            props = proc["processProperties"]
+            name = props[("displayName" "")]
+            qualified_name = props["qualifiedName"]
+            description = props.get("description", "---")
+
+            table.add_row(name, qualified_name, guid, description)
+
+        p_client.close_session()
+        return table
+
+    try:
+        console = Console(width=width, force_terminal=not jupyter, record=True)
+        with console.pager(styles=True):
+            console.print(generate_table(type_name))
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+        ValueError,
+    ) as e:
+        if type(e) is str:
+            print(e)
+        else:
+            print_exception_response(e)
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--server", help="Name of the server to display status for")
+    parser.add_argument("--url", help="URL Platform to connect to")
+    parser.add_argument("--userid", help="User Id")
+    parser.add_argument("--password", help="User Password")
+    parser.add_argument("--save-output", help="Save output to file?")
+
+    args = parser.parse_args()
+
+    server = args.server if args.server is not None else EGERIA_VIEW_SERVER
+    url = args.url if args.url is not None else EGERIA_PLATFORM_URL
+    userid = args.userid if args.userid is not None else EGERIA_USER
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+    type_name = Prompt.ask("Enter the Type Name to retrieve:", default="*")
+
+    display_gov_processes(type_name, server, url, userid, user_pass)
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/pyegeria/automated_curation_omvs.py

@@ -2439,11 +2439,11 @@ class AutomatedCuration(Client):
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "survey-postgres-database",
+            "governanceActionTypeQualifiedName": "AssetSurvey:survey-postgres-database",
             "actionTargets": [
                 {
                     "class": "NewActionTarget",
-                    "actionTargetName": "serverToSurvey",
+                    "actionTargetName": "postgresDatabase",
                     "actionTargetGUID": postgres_database_guid,
                 }
             ],

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/pyegeria/classification_manager_omvs.py

@@ -442,10 +442,8 @@ class ClassificationManager(Client):
             "POST", url, body_slimmer(body), time_out=time_out
         )
 
-        elements = response.json().get("elements", "No elements found")
-        if type(elements) is list:
-            if len(elements) == 0:
-                return "No elements found"
+        elements = response.json().get("element", "No elements found")
+
         return elements
 
     def get_element_by_guid(

{pyegeria-1.5.1.0.3 → pyegeria-1.5.1.0.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "1.5.1.0.3"
+version = "1.5.1.0.4"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -67,6 +67,8 @@ pytest = "^8.2.2"
     list_relationships = "commands.cat.list_relationships:main"
     list_user_ids = "commands.cat.list_user_ids:main"
     list_archives = "commands.cat.list_archives:main"
+    list_deployed_catalogs = "commands.cat.list_deployed_catalogs:main"
+    list_deployed_schemas = "commands.cat.list_deployed_database_schemas:main"
 
     monitor_asset_events = "commands.ops.monitor_asset_events:main"
     monitor_coco_status = "commands.ops.monitor_coco_status:main"
@@ -120,4 +122,5 @@ pytest = "^8.2.2"
     list_related_elements = "commands.tech.list_related_elements:main"
 
     list_valid_metadata_values = "commands.tech.list_valid_metadata_values:main"
-    list_element_graph = "commands.tech.get_element_graph:main"
+    list_element_graph = "commands.tech.get_element_graph:main"
+    list_gov_action_processes = "commands.tech.list_gov_action_processes:main"