pyegeria 1.5.1.1.30__tar.gz → 1.5.1.1.34__tar.gz

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/PKG-INFO

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

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/asset_catalog_omvs.py

@@ -506,6 +506,116 @@ class AssetCatalog(Client):
         )
         return response
 
+    async def _async_get_asset_lineage_graph(
+        self,
+        asset_guid: str,
+        start_from: int = 0,
+        page_size: int = max_paging_size,
+    ) -> str | dict:
+        """Return the asset lineage including a mermaid markdown string. Async Version.
+         Parameters
+         ----------
+         asset_guid : str
+             The unique identity of the asset to get the graph for.
+
+         start_from : int, optional
+             The index from which to start fetching the engine actions. Default is 0.
+
+         page_size : int, optional
+             The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+         Returns
+         -------
+        str | dict
+             A dictionary of the asset graph that includes a mermaid markdown string.
+
+         Raises:
+         ------
+         InvalidParameterException
+         PropertyServerException
+         UserNotAuthorizedException
+
+        """
+
+        url = (
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/asset-catalog/assets/{asset_guid}/"
+            f"as-lineage-graph?startFrom={start_from}&pageSize={page_size}"
+        )
+
+        response = await self._async_make_request("POST", url)
+        return response.json().get("assetLineageGraph", "no asset found")
+
+    def get_asset_lineage_graph(
+        self,
+        asset_guid: str,
+        start_from: int = 0,
+        page_size: int = max_paging_size,
+    ) -> str | dict:
+        """Return the asset lineage including a mermaid markdown string. Async Version.
+         Parameters
+         ----------
+         asset_guid : str
+             The unique identity of the asset to get the graph for.
+
+         start_from : int, optional
+             The index from which to start fetching the engine actions. Default is 0.
+
+         page_size : int, optional
+             The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+         Returns
+         -------
+        dict or str
+             A dictionary of the asset graph.
+
+         Raises:
+         ------
+         InvalidParameterException
+         PropertyServerException
+         UserNotAuthorizedException
+
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_asset_lineage_graph(asset_guid, start_from, page_size)
+        )
+        return response
+
+    def get_asset_lineage_mermaid_graph(
+        self,
+        asset_guid: str,
+        start_from: int = 0,
+        page_size: int = max_paging_size,
+    ) -> str:
+        """Return the lineage as mermaid markdown string. Async Version.
+         Parameters
+         ----------
+         asset_guid : str
+             The unique identity of the asset to get the graph for.
+
+         start_from : int, optional
+             The index from which to start fetching the engine actions. Default is 0.
+
+         page_size : int, optional
+             The maximum number of engine actions to fetch in a single request. Default is `max_paging_size`.
+
+         Returns
+         -------
+        str
+             A mermaid string representing the lineage.
+
+         Raises:
+         ------
+         InvalidParameterException
+         PropertyServerException
+         UserNotAuthorizedException
+
+        """
+
+        asset_graph = self.get_asset_lineage_graph(asset_guid, start_from, page_size)
+        return asset_graph.get("mermaidGraph")
+
     async def _async_get_assets_by_metadata_collection_id(
         self,
         metadata_collection_id: str,

pyegeria-1.5.1.1.34/pyegeria/commands/__init__.py

@@ -0,0 +1,21 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+pyegeria commands available also from python.
+"""
+
+from .ops.monitor_gov_eng_status import display_gov_eng_status
+from .ops.monitor_integ_daemon_status import display_integration_daemon_status
+from .ops.table_integ_daemon_status import (
+    display_integration_daemon_status as table_integ_daemon_status,
+)
+from .ops.monitor_engine_activity_c import display_engine_activity_c
+
+from .cat.list_glossaries import display_glossaries
+from .cat.list_terms import display_glossary_terms
+from .cat.list_deployed_catalogs import list_deployed_catalogs
+from .cat.list_deployed_database_schemas import list_deployed_database_schemas
+from .cat.list_deployed_databases import list_deployed_databases

pyegeria-1.5.1.1.34/pyegeria/commands/cat/__init__.py

@@ -0,0 +1,5 @@
+# from .list_glossaries import display_glossaries
+# from .list_terms import display_glossary_terms
+# from .list_deployed_catalogs import list_deployed_catalogs
+# from .list_deployed_database_schemas import list_deployed_database_schemas
+# from .list_deployed_databases import list_deployed_databases

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cat/list_deployed_catalogs.py

@@ -47,21 +47,41 @@ def check_if_template(header: dict) -> bool:
 
 
 def list_deployed_catalogs(
-    catalog_server: str,
-    server: str,
-    url: str,
-    username: str,
-    password: str,
+    catalog_server: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
 ):
-    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    """
+    Display the list of deployed catalogs. These could be metadata catalogs or other catalogs such as database catalogs..
+
+    Parameters
+    ----------
+    catalog_server : str, optional
+        The name of the catalog server to query. Default is "*" for all catalog servers.
+    view_server : str, optional
+        The server providing the view. Default is EGERIA_VIEW_SERVER.
+    view_url : str, optional
+        The URL of the view server. Default is EGERIA_VIEW_SERVER_URL.
+    user : str, optional
+        The user ID for authentication. Default is EGERIA_USER.
+    user_pass : str, optional
+        The password for the user. Default is EGERIA_USER_PASSWORD.
+    jupyter : bool, optional
+        Enable Jupyter notebook output. Default is EGERIA_JUPYTER.
+    width : int, optional
+        The width of the console output. Default is EGERIA_WIDTH.
+    """
+    c_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
     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()}",
+            caption=f"Databases found: {view_url} - {view_server} @ {time.asctime()}",
             style="bold bright_white on black",
             row_styles=["bold bright_white on black"],
             header_style="white on dark_blue",

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cat/list_deployed_database_schemas.py

@@ -55,21 +55,39 @@ def make_prop_md(props: dict) -> str:
 
 
 def list_deployed_database_schemas(
-    db_name: str,
-    server: str,
-    url: str,
-    username: str,
-    password: str,
+    db_name: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
 ):
-    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    """List schemas that have been deployed in database catalogs or databases.
+    Parameters
+    ----------
+    db_name : str
+        Name of the database or catalog to get schemas for, or '*' for all databases.
+    view_server : str
+        The view server to connect to.
+    view_url : str
+        URL of the view server.
+    user : str
+        Username for authentication.
+    user_pass : str
+        Password for authentication.
+    jupyter : bool
+        Whether to force the terminal output to behave as if in a Jupyter notebook.
+    width : int
+        Width of the console output.
+    """
+    c_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
     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()}",
+            caption=f"Databases found: {view_url} - {view_server} @ {time.asctime()}",
             style="bold bright_white on black",
             row_styles=["bold bright_white on black"],
             header_style="white on dark_blue",

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cat/list_deployed_databases.py

@@ -47,20 +47,36 @@ def check_if_template(header: dict) -> bool:
 
 
 def list_deployed_databases(
-    server: str,
-    url: str,
-    username: str,
-    password: str,
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
 ):
-    c_client = EgeriaTech(server, url, user_id=username, user_pwd=password)
+    """
+    Parameters
+    ----------
+    view_server : str
+        The view server name to which the Egeria client will connect. By default, this is set to EGERIA_VIEW_SERVER.
+    view_url : str
+        The URL of the Egeria view server. By default, this is set to EGERIA_VIEW_SERVER_URL.
+    user : str
+        The username used for authentication with the Egeria server. By default, it is set to EGERIA_USER.
+    user_pass : str
+        The password used for authentication with the Egeria server. By default, it is set to EGERIA_USER_PASSWORD.
+    jupyter : bool
+        A flag indicating whether the output is displayed within a Jupyter notebook. Default is set to EGERIA_JUPYTER.
+    width : int
+        The width of the output console. By default, it is set to EGERIA_WIDTH.
+    """
+    c_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
     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()}",
+            caption=f"Databases found: {view_url} - {view_server} @ {time.asctime()}",
             style="bold bright_white on black",
             row_styles=["bold bright_white on black"],
             header_style="white on dark_blue",

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cat/list_glossaries.py

@@ -46,16 +46,33 @@ EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
 
 
 def display_glossaries(
-    search_string: str,
-    server: str,
-    url: str,
-    userid: str,
-    password: str,
+    search_string: str = "*",
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
 ):
-    """List all glossaries"""
-    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    """Display either a specified glossary or all glossaries if the search_string is '*'.
+    Parameters
+    ----------
+    search_string : str, default is '*'
+        The string used to search for glossaries.
+    view_server : str
+        The view server name or address where the Egeria services are hosted.
+    view_url : str
+        The URL of the platform the view server is on.
+    user : str
+        The user ID for authentication with the Egeria server.
+    user_pass : str
+        The password for authentication with the Egeria server.
+    jupyter : bool, optional
+        A boolean indicating whether the output is intended for a Jupyter notebook (default is EGERIA_JUPYTER).
+    width : int, optional
+        The width of the console output (default is EGERIA_WIDTH).
+    """
+    m_client = EgeriaTech(view_server, view_url, user_id=user, user_pwd=user_pass)
     token = m_client.create_egeria_bearer_token()
     try:
         table = Table(
@@ -66,7 +83,7 @@ def display_glossaries(
             caption_style="white on black",
             show_lines=True,
             box=box.ROUNDED,
-            caption=f"View Server '{server}' @ Platform - {url}",
+            caption=f"View Server '{view_server}' @ Platform - {view_url}",
             expand=True,
         )
         table.add_column("Glossary Name")

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cat/list_terms.py

@@ -46,18 +46,45 @@ EGERIA_WIDTH = int(os.environ.get("EGERIA_WIDTH", "200"))
 
 
 def display_glossary_terms(
-    search_string: str,
-    glossary_guid: str,
-    glossary_name: str,
-    server: str,
-    url: str,
-    username: str,
-    user_password: str,
+    search_string: str = "*",
+    glossary_guid: str = None,
+    glossary_name: str = None,
+    view_server: str = EGERIA_VIEW_SERVER,
+    view_url: str = EGERIA_VIEW_SERVER_URL,
+    user_id: str = EGERIA_USER,
+    user_pass: str = EGERIA_USER_PASSWORD,
     jupyter: bool = EGERIA_JUPYTER,
     width: int = EGERIA_WIDTH,
 ):
-    """Display glossary terms in a table"""
-    g_client = EgeriaTech(server, url, username, user_password)
+    """Display a table of glossary terms filtered by search_string and glossary, if specified. If no
+        filters then all terms are displayed. If glossary_guid or name is specified, then only terms from that
+        glossary are displayed.
+    Parameters
+    ----------
+    search_string : str, optional
+        The string to search for terms. Defaults to "*".
+    glossary_guid : str, optional
+        The unique identifier of the glossary. Defaults to None. If specified, then only terms from that glossary
+        are displayed. If both glossary_guid and glossary_name are provided then glossary_guid will take precedence.
+    glossary_name : str, optional
+        The display name of the glossary. Defaults to None. If specified, then only terms from that glossary
+        are displayed. If both glossary_guid and glossary_name are provided then glossary_guid will take precedence.
+        Note that the use of glossary display name relies on the qualified name conforming to convention. GUID is more
+        reliable.
+    view_server : str
+        The server where the glossary is hosted. Defaults to EGERIA_VIEW_SERVER.
+    view_url : str
+        The URL of the server where the glossary is hosted. Defaults to EGERIA_VIEW_SERVER_URL.
+    user_id : str
+        The user ID for authentication. Defaults to EGERIA_USER.
+    user_pass : str
+        The user password for authentication. Defaults to EGERIA_USER_PASSWORD.
+    jupyter : bool
+        Flag to indicate if the output should be formatted for Jupyter notebook. Defaults to EGERIA_JUPYTER.
+    width : int
+        The width of the console output. Defaults to EGERIA_WIDTH.
+    """
+    g_client = EgeriaTech(view_server, view_url, user_id, user_pass)
     token = g_client.create_egeria_bearer_token()
     if (glossary_name is not None) and (glossary_name != "*"):
         glossary_guid = g_client.__get_guid__(
@@ -78,7 +105,7 @@ def display_glossary_terms(
             caption_style="white on black",
             show_lines=True,
             box=box.ROUNDED,
-            caption=f"View Server '{server}' @ Platform - {url}",
+            caption=f"View Server '{view_server}' @ Platform - {view_url}",
             expand=True,
         )
         table.add_column("Term Name")
@@ -117,7 +144,7 @@ def display_glossary_terms(
             display_name = Text(props["displayName"], style=style)
             qualified_name = props["qualifiedName"]
             term_guid = term["elementHeader"]["guid"]
-            q_name = Text(f"{qualified_name}\n\t\t\t&\n{term_guid}", style=style)
+            q_name = Text(f"{qualified_name}\n\t\t&\n{term_guid}", style=style)
             abbrev = Text(props.get("abbreviation", " "), style=style)
             summary = Text(props.get("summary", " "), style=style)
             description = Text(props.get("description", " "), style=style)

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cli/egeria.py

@@ -356,7 +356,7 @@ def get_element_info(ctx, om_type):
     )
 
 
-@show.command("list-elements")
+@show.command("elements")
 @click.pass_context
 @click.option("--om_type", default="Project", help="Metadata type to query")
 def list_element_info(ctx, om_type):
@@ -373,9 +373,9 @@ def list_element_info(ctx, om_type):
     )
 
 
-@show.command("list-processes")
+@show.command("processes")
 @click.pass_context
-def list_element_info(ctx):
+def list_process_info(ctx):
     """Display the valid metadata values for a property and type"""
     c = ctx.obj
     list_elements(
@@ -917,9 +917,9 @@ def show_todos(ctx):
     )
 
 
-@show.command("list-archives")
+@show.command("archives")
 @click.pass_context
-def list_archives(ctx):
+def archives(ctx):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     display_archive_list(
@@ -933,12 +933,12 @@ def list_archives(ctx):
     )
 
 
-@show.command("list-deployed-schemas")
+@show.command("deployed-schemas")
 @click.option(
     "--search_catalog", default="*", help="What database or catalog to search"
 )
 @click.pass_context
-def list_deployed_schemas(search_catalog, ctx):
+def deployed_schemas(search_catalog, ctx):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_deployed_database_schemas(
@@ -952,10 +952,10 @@ def list_deployed_schemas(search_catalog, ctx):
     )
 
 
-@show.command("list-catalogs")
+@show.command("catalogs")
 @click.option("--search_server", default="*", help="Server to search for catalogs")
 @click.pass_context
-def list_catalogs(search_server, ctx):
+def catalogs(search_server, ctx):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_deployed_catalogs(
@@ -969,9 +969,9 @@ def list_catalogs(search_server, ctx):
     )
 
 
-@show.command("list-databases")
+@show.command("databases")
 @click.pass_context
-def list_databases(ctx):
+def databases(ctx):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_deployed_databases(
@@ -979,10 +979,10 @@ def list_databases(ctx):
     )
 
 
-@show.command("list-glossaries")
+@show.command("glossaries")
 @click.option("--search_string", default="*", help="Name to search for glossaries")
 @click.pass_context
-def list_glossaries(ctx, search_string):
+def glossaries(ctx, search_string):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     display_glossaries(

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cli/egeria_cat.py

@@ -500,7 +500,7 @@ def show_todos(ctx):
     )
 
 
-@show.command("list-archives")
+@show.command("archives")
 @click.pass_context
 def list_archives(ctx):
     """Display a tree graph of information about an asset"""
@@ -516,10 +516,10 @@ def list_archives(ctx):
     )
 
 
-@show.command("list-schemas")
+@show.command("deployed-schemas")
 @click.option("--catalog", default="*", help="What database or catalog to search")
 @click.pass_context
-def list_deployed_schemas(ctx, catalog):
+def deployed_schemas(ctx, catalog):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     list_deployed_database_schemas(
@@ -533,7 +533,7 @@ def list_deployed_schemas(ctx, catalog):
     )
 
 
-@show.command("list-catalogs")
+@show.command("catalogs")
 @click.option("--search_server", default="*", help="Server to search for catalogs")
 @click.pass_context
 def list_catalogs(ctx, search_server):
@@ -550,10 +550,10 @@ def list_catalogs(ctx, search_server):
     )
 
 
-@show.command("list-glossaries")
+@show.command("glossaries")
 @click.option("--search_string", default="*", help="Name to search for glossaries")
 @click.pass_context
-def list_glossaries(ctx, search_string):
+def glossaries(ctx, search_string):
     """Display a tree graph of information about an asset"""
     c = ctx.obj
     display_glossaries(
@@ -567,7 +567,7 @@ def list_glossaries(ctx, search_string):
     )
 
 
-@show.command("list-databases")
+@show.command("databases")
 @click.pass_context
 def list_databases(ctx):
     """Display a tree graph of information about an asset"""
@@ -608,19 +608,19 @@ def survey(ctx):
     pass
 
 
-@survey.command("survey-uc-server")
-@click.pass_context
-@click.option(
-    "--uc_endpoint",
-    default="https://localhost:8080",
-    help="Endpoint of the Unity Catalog Server to Survey",
-)
-def survey_uc_server(ctx, uc_endpoint):
-    """Survey the Unity Catalog server at the given endpoint"""
-    c = ctx.obj
-    pass
-    # restart_connector(connector, c.integration_daemon, c.integration_daemon_url,
-    #                   c.userid, c.password)
+# @survey.command("survey-uc-server")
+# @click.pass_context
+# @click.option(
+#     "--uc_endpoint",
+#     default="https://localhost:8080",
+#     help="Endpoint of the Unity Catalog Server to Survey",
+# )
+# def survey_uc_server(ctx, uc_endpoint):
+#     """Survey the Unity Catalog server at the given endpoint"""
+#     c = ctx.obj
+#     pass
+#     # restart_connector(connector, c.integration_daemon, c.integration_daemon_url,
+#     #                   c.userid, c.password)
 
 
 if __name__ == "__main__":

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/cli/egeria_tech.py

@@ -468,7 +468,7 @@ def valid_metadata_values(ctx, property, type_name):
     )
 
 
-@show.command("list-elements")
+@show.command("elements")
 @click.pass_context
 @click.option("--om_type", default="Organization", help="Metadata type to query")
 def list_element_info(ctx, om_type):
@@ -485,7 +485,7 @@ def list_element_info(ctx, om_type):
     )
 
 
-@show.command("list-processes")
+@show.command("processes")
 @click.pass_context
 def list_element_info(ctx):
     """Display the valid metadata values for a property and type"""

{pyegeria-1.5.1.1.30 → pyegeria-1.5.1.1.34}/pyegeria/commands/ops/engine_actions.py

@@ -98,7 +98,7 @@ def start_server(ctx, server):
         p_client.close_session()
 
 
-@click.command("refresh-gov-eng-config")
+@click.command("refresh")
 @click.pass_context
 # @click.option(
 #     "--engine-host", default=EGERIA_ENGINE_HOST, help="Engine Host to refresh"