pyegeria 0.3.7__tar.gz → 0.3.8__tar.gz

{pyegeria-0.3.7/src/pyegeria.egg-info → pyegeria-0.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.3.7
+Version: 0.3.8
 Summary: A python client for Egeria
 Home-page: https://egeria-project.org/egeria-python
 Author: Dan Wolfson

{pyegeria-0.3.7 → pyegeria-0.3.8}/examples/Jupyter Notebooks/common/P-environment-check.ipynb

@@ -6,7 +6,6 @@
    "metadata": {
     "collapsed": false
    },
-   "outputs": [],
    "source": [
     "\n",
     "#\n",
@@ -21,11 +20,11 @@
     "from globals import (adminUserId, cocoMDS1Name, cocoMDS2Name, cocoMDS3Name, cocoMDS4Name, cocoMDS5Name, cocoMDS6Name, cocoView1Name, cocoOLS1Name, cocoMDSxName, devPlatformName, dataLakePlatformName, corePlatformName, corePlatformURL, dataLakePlatformURL, devPlatformURL)\n",
     "import nest_asyncio \n",
     "nest_asyncio.apply()"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
-   "outputs": [],
    "source": [
     "\n",
     "print(\"\\nChecking OMAG Server Platform availability...\")\n",
@@ -39,11 +38,11 @@
    "metadata": {
     "collapsed": false
    },
-   "execution_count": null
+   "execution_count": null,
+   "outputs": []
   },
   {
    "cell_type": "code",
-   "outputs": [],
    "source": [
     "# Try to activate each of the platforms\n",
     "# nest_asyncio.apply()\n",
@@ -52,11 +51,11 @@
    "metadata": {
     "collapsed": false
    },
-   "execution_count": null
+   "execution_count": null,
+   "outputs": []
   },
   {
    "cell_type": "code",
-   "outputs": [],
    "source": [
     "# nest_asyncio.apply()\n",
     "activatePlatform(dataLakePlatformName, dataLakePlatformURL, [cocoMDS1Name, cocoMDS4Name, cocoView1Name, cocoOLS1Name], adminUserId)"
@@ -64,11 +63,11 @@
    "metadata": {
     "collapsed": false
    },
-   "execution_count": null
+   "execution_count": null,
+   "outputs": []
   },
   {
    "cell_type": "code",
-   "outputs": [],
    "source": [
     "# nest_asyncio.apply()\n",
     "activatePlatform(devPlatformName, devPlatformURL, [cocoMDSxName], adminUserId)\n",
@@ -79,15 +78,17 @@
    "metadata": {
     "tags": []
    },
-   "execution_count": null
+   "execution_count": null,
+   "outputs": []
   },
   {
    "cell_type": "code",
-   "outputs": [],
    "source": [],
    "metadata": {
     "collapsed": false
-   }
+   },
+   "execution_count": null,
+   "outputs": []
   }
  ],
  "metadata": {

{pyegeria-0.3.7 → pyegeria-0.3.8}/examples/Jupyter Notebooks/common/common-functions.ipynb

@@ -6,7 +6,6 @@
    "metadata": {
     "is_executing": true
    },
-   "outputs": [],
    "source": [
     "#\n",
     "# This file contains the common functions and definitions used in the Egeria Hands on\n",
@@ -54,13 +53,13 @@
     "# A targeted use of this flag is recommended, set this before and reset this after the code you would like to produce debug\n",
     "#\n",
     "isDebug = False"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Definitions of the Coco Pharmaceuticals Environment\n",
@@ -178,13 +177,13 @@
     "monitorDev01Name         = \"monitorDev01\"\n",
     "monitorDev01ServerType   = \"Integration Daemon\"\n",
     "monitorDev01MDS          = \"cocoMDSx\"\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Common processing of REST API errors.\n",
@@ -310,13 +309,13 @@
     "    print (\"   ...... (POST\", url, \")\")\n",
     "    response = requests.post(url, json=json, headers=headers, verify=False)\n",
     "    print (\"   ...... Response: \", response.json())\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# Server configuration can be deployed from one OMAG Server Platform to another.\n",
     "# This enables a server configuration to be tested and then deployed in production.\n",
@@ -331,13 +330,13 @@
     "    }\n",
     "    jsonContentHeader = {'content-type':'application/json'}\n",
     "    postAndPrintResult(url, json=platformTarget, headers=jsonContentHeader)\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# The OMAG Server Platform is a single executable (application) that can be started\n",
     "# from the command line or a script or as part of a pre-built container environment\n",
@@ -491,11 +490,11 @@
     "        print (\"Response: \")\n",
     "        print (prettyResponse)\n",
     "        print (\" \")\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
-   "outputs": [],
    "source": [
     "\n",
     "#\n",
@@ -717,13 +716,13 @@
     "    issuePost(url, requestBody)"
    ],
    "metadata": {},
-   "execution_count": 0
+   "execution_count": 0,
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "\n",
     "# Each server is configured to define which services should be active.  This configuration results in\n",
@@ -831,13 +830,13 @@
     "        for x in range(len(hostedServerNames)):\n",
     "            activateServerOnPlatform(hostedServerNames[x], serverPlatformName, serverPlatformURL)\n",
     "\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Repository Services\n",
@@ -1006,20 +1005,20 @@
     "    metadataHighwayServicesURLcore = '/servers/' + serverName + '/open-metadata/repository-services/users/' + adminUserId + '/metadata-highway'\n",
     "    url = serverPlatformURL + metadataHighwayServicesURLcore + '/cohorts/' + cohortName + '/unregister'\n",
     "    response = issueGet(url)\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# OMAS\n",
@@ -1112,13 +1111,13 @@
     "        for guid in guids:\n",
     "            returnGUID = guid\n",
     "        return returnGUID"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# OCF Common services\n",
@@ -1603,13 +1602,13 @@
     "            if isPublic:\n",
     "                print(\"  public:       \" + str(isPublic))\n",
     "\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "   \n",
     "#\n",
@@ -1814,13 +1813,13 @@
     "    else:\n",
     "        print (\"No semantic assignment Relationship created\")\n",
     "        processErrorResponse(serverName, serverPlatformName, serverPlatformURL, response)\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Asset Consumer OMAS\n",
@@ -2266,13 +2265,13 @@
     "\n",
     "def assetConsumerPrintAssetComments(serverName, serverPlatformName, serverPlatformURL, userId, requestType):\n",
     "    printAssetComments(serverName, serverPlatformName, serverPlatformURL, \"asset-consumer\", userId, requestType)\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Asset Manager OMAS\n",
@@ -2382,20 +2381,20 @@
     "        print (\"No process created\")\n",
     "        processErrorResponse(serverName, serverPlatformName, serverPlatformURL, response)\n",
     "    "
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
-   "source": []
+   "source": [],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Subject Area OMAS\n",
@@ -2654,13 +2653,13 @@
     "    else:\n",
     "        print(\"No terms created\")\n",
     "        \n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# Open Governance and Discovery\n",
     "# Working with the engine host server and the Governance Engine OMAS of the metadata server.\n",
@@ -3307,13 +3306,13 @@
     "    except Exception as error:\n",
     "        print(\"Exception: %s\" % error)\n",
     "        print(\"Platform \" + serverPlatformURL + \" is returning an error\")\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Working with Governance Actions, Governance Action Processes and Governance Action Types through the Governance Engine OMAS\n",
@@ -3667,25 +3666,25 @@
     "    except Exception as error:\n",
     "        print(\"Exception: %s\" % error )\n",
     "        print(\"Platform \" + serverPlatformURL + \" is returning an error\")\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Using the OpenMetadataStore services to report on running governance action processes.\n",
     "#\n",
     "\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "# \n",
     "# Interaction with the Integration Daemon OMAG Server\n",
@@ -3845,13 +3844,13 @@
     "        print(\"Exception: %s\" % error)\n",
     "        print(\"Platform \" + serverPlatformURL + \" is returning an error\")\n",
     "        "
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "## Open Metadata Integration Services\n",
     "\n",
@@ -3920,13 +3919,13 @@
     "        print(\"Exception: %s\" % error)\n",
     "        print(\"Platform \" + serverPlatformURL + \" is returning an error\")\n",
     "        \n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Load an archive\n",
@@ -3943,13 +3942,13 @@
     "        print (prettyResponse)\n",
     "    print(\" \")\n",
     "\n"
-   ]
+   ],
+   "outputs": []
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
-   "outputs": [],
    "source": [
     "#\n",
     "# Issue requests to the Asset Manager OMAS\n",
@@ -4667,7 +4666,8 @@
     "\n",
     "\n",
     "\n"
-   ]
+   ],
+   "outputs": []
   }
  ],
  "metadata": {

{pyegeria-0.3.7 → pyegeria-0.3.8}/examples/widgets/engine_action_status.py

@@ -12,6 +12,7 @@ A simple status display for Engine Actions
 import argparse
 import json
 import time
+import sys
 
 from rich import box
 from rich.live import Live
@@ -76,7 +77,7 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
 
         token = g_client.create_egeria_bearer_token()
         action_status = g_client.get_engine_actions()
-        if "No Elements" in action_status:
+        if type(action_status) is str:
             requested_time = " "
             start_time = " "
             completion_time = " "
@@ -86,9 +87,9 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
             target_element = " "
             process_name = " "
             completion_message = " "
-        else:
+        elif type(action_status) is list:
             for action in action_status:
-                requested_time = action["requestedTime"]
+                requested_time = action.get("requestedTime", " ")
                 start_time = action.get("startTime", " ")
                 completion_time = action.get("completionTime", " ")
 
@@ -115,7 +116,9 @@ def display_status_engine_actions(server: str = good_server_3, url: str = good_p
                     requested_time, start_time, action_guid,engine_name, request_type,
                     action_status, target_element, completion_time, process_name, completion_message
                 )
-
+        else:
+            print("Egeria integration daemon not running")
+            sys.exit()
         # g_client.close_session()
         return table
 

{pyegeria-0.3.7 → pyegeria-0.3.8}/examples/widgets/find_todos.py

@@ -81,9 +81,9 @@ def display_to_dos(search_string: str, guid: str=None, server: str = good_server
         table.add_column("Status")
         table.add_column("Sponsor")
 
-        todo_items = m_client.find_to_do("*", starts_with=True)
+        todo_items = m_client.find_to_do(search_string)
 
-        if todo_items is None:
+        if type(todo_items) is str:
             name = " "
             type_name = " "
             created = " "
@@ -107,7 +107,7 @@ def display_to_dos(search_string: str, guid: str=None, server: str = good_server
                 sponsor = "erinoverview"
                 if status in ("WAITING", "OPEN"):
                     status = f"[yellow]{status}"
-                elif status in ("INPROGRESS", "COMPLETE"):
+                elif status in ("IN_PROGRESS", "COMPLETE"):
                     status = f"[green]{status}"
                 else:
                     status = f"[red]{status}"

{pyegeria-0.3.7 → pyegeria-0.3.8}/pyproject.toml

@@ -9,7 +9,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyegeria"
-version = "0.3.7"
+version = "0.3.8"
 #license = 'Apache 2.0'
 authors = [
     {name ="Dan Wolfson", email= "dan.wolfson@pdr-associates.com"},

{pyegeria-0.3.7 → pyegeria-0.3.8}/src/pyegeria/__init__.py

@@ -43,4 +43,5 @@ from .server_operations import ServerOps
 from .collection_manager_omvs import CollectionManager
 from .project_manager_omvs import ProjectManager
 from .valid_metadata_omvs import ValidMetadataManager
-__version__ = "0.3"
+from .loaded_resources_omvs import LoadedResources
+__version__ = "0.38"

pyegeria-0.3.8/src/pyegeria/loaded_resources_omvs.py

@@ -0,0 +1,159 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+This module allows users to query the available (registered) capabilities of Egeria. Detailed information is returned
+to provide both insight and understanding in how to use these capabilities. For example, when configuring an Egeria
+integration service, it is importregistered_info.pyant to know what companion service it depends on so that you can make sure the
+companion service is also configured and running.
+
+"""
+
+import pandas as pd
+from tabulate import tabulate
+
+from pyegeria._client import Client
+from pyegeria.utils import wrap_text
+
+
+class LoadedResources(Client):
+    """ Client to search and retrieve currently loaded information about connectors, templates, governance actions,
+        etc.
+
+    Attributes:
+    ----------
+        server_name: str
+                Name of the server to use.
+        platform_url : str
+            URL of the server platform to connect to
+        user_id : str
+            The identity of the user calling the method - this sets a default optionally used by the methods
+            when the user doesn't pass the user_id on a method call.
+        user_pwd: str
+            The password associated with the user_id. Defaults to None
+        verify_flag: bool
+            Flag to indicate if SSL Certificates should be verified in the HTTP requests.
+            Defaults to False.
+
+    Methods:
+    -------
+
+    """
+
+    admin_command_root: str
+
+    def __init__(
+            self,
+            server_name: str,
+            platform_url: str,
+            user_id: str,
+            user_pwd: str = None,
+            verify_flag: bool = False,
+    ):
+        if server_name is None:
+            server_name = "NA"
+        Client.__init__(self, server_name, platform_url,
+                        user_id, user_pwd, verify_flag)
+
+    def get_all_templates(self, server: str = None, start_from: int = 0, page_size: int = 0) -> list | str:
+        """ Get Loaded templates for the Server.
+
+           Parameters
+           ----------
+
+           Returns
+           -------
+           dict | str
+              A dictionary containing a simplified list of key template attributes.
+
+           Raises
+           ------
+           InvalidParameterException
+               If the response code is not 200.
+           PropertyServerException:
+               Raised by the server when an issue arises in processing a valid request
+           NotAuthorizedException:
+               The principle specified by the user_id does not have authorization for the requested action
+
+           """
+        server = self.server_name if server is None else server
+        url = (f"{self.platform_url}/servers/{server}/open-metadata/framework-services/asset-owner/open-metadata-store/"
+               f"users/{self.user_id}/metadata-elements/by-search-string?startFrom=start_from&pageSize=page_size")
+        body = {
+                  "class" : "SearchStringRequestBody",
+                  "searchString" : ".*Template.*"
+                }
+        response = self.make_request("POST", url, body)
+        return response.json().get("elementList", "No elements")
+
+    def list_severity_definitions(self, fmt: str = 'json', skinny: bool = True, wrap_len: int = 30) -> list | str:
+        """ Get the registered severities for the OMAG Server
+
+          Parameters
+          ----------
+           fmt: str, optional, default = 'json'
+               If fmt is 'json', then return the result as a JSON string. If fmt is 'table', then
+               return the result as a nicely formatted table string.
+           skinny: bool, optional, default = True
+               If a table is being created and `skinny` is true, then return a subset of the information,
+               if false return all columns.
+           wrap_len: int, optional, default = 30
+               If a table is being created, the width of the column to wrap text to.
+
+          Returns
+          -------
+          dict | str
+              If fmt is 'JSON' then return a dictionary containing the registered services for the specified
+               platform. If fmt is 'table' then return the result as a nicely formatted printable table string.
+
+          Raises
+          ------
+          InvalidParameterException
+              If the response code is not 200.
+          PropertyServerException:
+              Raised by the server when an issue arises in processing a valid request
+          NotAuthorizedException:
+              The principle specified by the user_id does not have authorization for the requested action
+
+        """
+        url = (f"{self.platform_url}/servers/{self.server_name}/open-metadata/repository-services"
+               f"/users/{self.user_id}/audit-log/severity-definitions"
+               )
+        response = self.make_request("GET", url)
+        if fmt == 'json':
+            return response.json().get("severities", "No severities found")
+        elif fmt == 'table':
+            df = pd.DataFrame(response.json().get("severities", []))
+            if skinny:
+                df = df.drop(columns=['ordinal'])
+            return tabulate(wrap_text(df, wrap_len=wrap_len), headers='keys', tablefmt='psql')
+
+    def list_asset_types(self, server: str = None) -> list | str:
+        """ Get the registered severities for the OMAG Server
+
+          Parameters
+          ----------
+           server: str, optional, default = None
+
+          Returns
+          -------
+          dict | str
+              Returns a list of the asset types.
+
+          Raises
+          ------
+          InvalidParameterException
+              If the response code is not 200.
+          PropertyServerException:
+              Raised by the server when an issue arises in processing a valid request
+          NotAuthorizedException:
+              The principle specified by the user_id does not have authorization for the requested action
+
+        """
+        server = self.server_name if server is None else server
+        url = f"{self.platform_url}/servers/{self.server_name}/api/open-metadata/asset-catalog/assets/types"
+
+        response = self.make_request("GET", url)
+        return response.json().get('types', 'no types found')