pyegeria 0.8.4.50__tar.gz → 1.5.1.0.1__tar.gz

{pyegeria-0.8.4.50 → pyegeria-1.5.1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 0.8.4.50
+Version: 1.5.1.0.1
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0
@@ -41,17 +41,20 @@ Description-Content-Type: text/markdown
 
 # pyegeria: a python client for Egeria
 
-This is an experimental package for easily using the Egeria
+This is a package for easily using the Egeria
 open metadata environment from python. Details about the
 open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
 
 This package is in active development. There is initial
 support for many of Egeria's services including configuration and operation.  This client depends on 
-Egeria 4.4 Snapshot and above - although most of the functions may work on earlier versions of Egeria as well. 
+This release supports Egeria 5.1 - although most of the functions may work on earlier versions of Egeria as well. 
 
 The code is organized to mimic the existing Egeria Java Client structure.
 
-A new examples folder holds some useful text widgets that help to visualize the status of an Egeria deployment.
+The commands folder holds the Egeria Command Line Interface and corresponding commands
+to visualize and use Egeria. The commands also serve as useful examples.
+
+An examples folder holds some useful examples showing different facets of using pyegeria.
 
 WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and 
 evolve.

pyegeria-1.5.1.0.1/README.md

@@ -0,0 +1,40 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+<!-- Copyright Contributors to the ODPi Egeria project. -->
+
+![Egeria Logo](https://egeria-project.org/assets/images/egeria-header.png)
+
+[![GitHub](https://img.shields.io/github/license/odpi/egeria)](LICENSE)
+
+
+# pyegeria: a python client for Egeria
+
+This is a package for easily using the Egeria
+open metadata environment from python. Details about the
+open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
+
+This package is in active development. There is initial
+support for many of Egeria's services including configuration and operation.  This client depends on 
+This release supports Egeria 5.1 - although most of the functions may work on earlier versions of Egeria as well. 
+
+The code is organized to mimic the existing Egeria Java Client structure.
+
+The commands folder holds the Egeria Command Line Interface and corresponding commands
+to visualize and use Egeria. The commands also serve as useful examples.
+
+An examples folder holds some useful examples showing different facets of using pyegeria.
+
+WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and 
+evolve.
+
+All feedback is welcome. Please engage via our [community](http://egeria-project.org/guides/community/), 
+team calls, or via github issues in this repo. If interested in contributing,
+you can engage via the community or directly reach out to
+[dan.wolfson\@pdr-associates.com](mailto:dan.wolfson@pdr-associates.com?subject=pyegeria).
+
+This is a learning experience.
+
+
+
+----
+License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/),
+Copyright Contributors to the ODPi Egeria project.

pyegeria-1.5.1.0.1/commands/tech/get_element_graph.py

@@ -0,0 +1,202 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+Unit tests for the Utils helper functions using the Pytest framework.
+
+
+A simple display for glossary terms
+"""
+import argparse
+import os
+import sys
+import time
+
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.markdown import Markdown
+from rich.table import Table
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    print_exception_response,
+    EgeriaTech,
+)
+
+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", "260"))
+
+
+disable_ssl_warnings = True
+
+
+def display_elements(
+    search_string: str,
+    prop_list: [str],
+    server: str,
+    url: str,
+    username: str,
+    user_password: str,
+    time_out: int = 60,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    console = Console(width=width, force_terminal=not jupyter, soft_wrap=True)
+    if (search_string is None) or (len(search_string) < 3):
+        raise ValueError(
+            "Invalid Search String - must be greater than four characters long"
+        )
+    g_client = EgeriaTech(server, url, username, user_password)
+    token = g_client.create_egeria_bearer_token()
+
+    def generate_table(search_string: str, prop_list: [str]) -> Table:
+        """Make a new table."""
+        table = Table(
+            title=f"Assets containing the string  {search_string} @ {time.asctime()}",
+            header_style="white on dark_blue",
+            style="bold white on black",
+            row_styles=["bold white on black"],
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{server}' @ Platform - {url}",
+            expand=True,
+        )
+        # table.add_column("Qualified Name")
+        table.add_column("GUID", no_wrap=True)
+        table.add_column("Properties")
+
+        table.add_column("Classification Props", width=30)
+        table.add_column("Matching Elements")
+
+        classification = "Anchors"
+        open_type_name = None
+        property_value = search_string
+        property_names = prop_list
+
+        elements = g_client.find_elements_by_classification_with_property_value(
+            classification, property_value, property_names, open_type_name
+        )
+        if type(elements) is str:
+            return table
+
+        for element in elements:
+            template = False
+            guid = element["elementHeader"].get("guid", "---")
+            classifications = element["elementHeader"]["classifications"]
+
+            class_prop_md = ""
+            for classific in classifications:
+                class_prop = classific.get("classificationProperties", "---")
+                if type(class_prop) is dict:
+                    for key in class_prop.keys():
+                        class_prop_md += f"* {key}: {class_prop[key]}\n"
+
+            class_prop_out = Markdown(class_prop_md)
+
+            properties = element["properties"]
+            props_md = ""
+            if type(properties) is dict:
+                for key in properties.keys():
+                    props_md += f"* {key}: {properties[key]}\n"
+                    if key == "category" and properties[key] == "placeholderProperty":
+                        template = True
+            props_out = Markdown(props_md)
+
+            if template:  # Not interested in template elements in this method
+                continue
+
+            relationship = g_client.get_related_elements(guid, None, None)
+
+            if type(relationship) is list:
+                rel_md = ""
+                for rel in relationship:
+                    match_tab = Table(expand=True)
+                    match_tab.add_column("Type Name")
+                    match_tab.add_column("GUID", no_wrap=True, width=36)
+                    match_tab.add_column("Properties")
+                    match = rel["relationshipHeader"]
+                    match_type_name = match["type"]["typeName"]
+                    matching_guid = match["guid"]
+                    match_props = rel["relatedElement"]["properties"]
+                    match_details_md = ""
+                    for key in match_props.keys():
+                        match_details_md += f"* {key}: {match_props[key]}\n"
+                    match_details_out = Markdown(match_details_md)
+                    match_tab.add_row(match_type_name, matching_guid, match_details_out)
+
+            table.add_row(guid, props_out, class_prop_out, match_tab)
+
+        g_client.close_session()
+        return table
+
+    try:
+        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
+        #     while True:
+        #         time.sleep(2)
+        #         live.update(generate_table())
+
+        with console.pager(styles=True):
+            console.print(generate_table(search_string, prop_list), soft_wrap=True)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        console.print_exception()
+        sys.exit(1)
+
+    except ValueError as e:
+        console.print(
+            f"\n\n====> Invalid Search String - must be greater than four characters long"
+        )
+        sys.exit(1)
+
+
+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("--time_out", help="Time Out")
+
+    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
+    time_out = args.time_out if args.time_out is not None else 60
+    try:
+        search_string = Prompt.ask("Enter an asset search string:", default="")
+        prop_list = Prompt.ask(
+            "Enter the list of properties to search", default="anchorTypeName"
+        )
+        display_elements(
+            search_string, [prop_list], server, url, userid, user_pass, time_out
+        )
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

{pyegeria-0.8.4.50 → pyegeria-1.5.1.0.1/pyegeria}/README.md

@@ -8,18 +8,16 @@
 
 # pyegeria: a python client for Egeria
 
-This is an experimental package for easily using the Egeria
+This is a package for easily using the Egeria
 open metadata environment from python. Details about the
 open source Egeria project can be found at [Egeria Project](https://egeria-project.org).
 
 This package is in active development. There is initial
 support for many of Egeria's services including configuration and operation.  This client depends on 
-Egeria 4.4 Snapshot and above - although most of the functions may work on earlier versions of Egeria as well. 
+This release supports Egeria 5.1 and above - although most of the functions may work on earlier versions of Egeria as well. 
 
 The code is organized to mimic the existing Egeria Java Client structure.
 
-A new examples folder holds some useful text widgets that help to visualize the status of an Egeria deployment.
-
 WARNING: files that start with "X" are in-progress placeholders that are not meant to be used..they will mature and 
 evolve.
 

{pyegeria-0.8.4.50 → pyegeria-1.5.1.0.1}/pyegeria/automated_curation_omvs.py

@@ -2336,11 +2336,11 @@ class AutomatedCuration(Client):
     ) -> str:
         """Initiate a postgres database survey"""
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
-            "governanceActionTypeQualifiedName": "AssetSurvey-postgres-database",
+            "governanceActionTypeQualifiedName": "survey-postgres-database",
             "actionTargets": [
                 {
                     "class": "NewActionTarget",
@@ -2365,7 +2365,7 @@ class AutomatedCuration(Client):
     ) -> str:
         """Initiate a postgres server survey - Async version"""
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
@@ -2426,7 +2426,7 @@ class AutomatedCuration(Client):
             - AssetSurvey:survey-all-folders-and-files
         """
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
@@ -2489,7 +2489,7 @@ class AutomatedCuration(Client):
     async def _async_initiate_file_survey(self, file_guid: str) -> str:
         """Initiate a file survey - async version"""
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
@@ -2525,7 +2525,7 @@ class AutomatedCuration(Client):
 
         """
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
@@ -2576,7 +2576,7 @@ class AutomatedCuration(Client):
 
         """
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",
@@ -2626,7 +2626,7 @@ class AutomatedCuration(Client):
 
         """
 
-        url = f"{self.curation_command_root}/governance-action-types/" f"initiate"
+        url = f"{self.curation_command_root}/governance-action-types/initiate"
 
         body = {
             "class": "InitiateGovernanceActionTypeRequestBody",

{pyegeria-0.8.4.50 → pyegeria-1.5.1.0.1}/pyegeria/classification_manager_omvs.py

@@ -1,7 +1,7 @@
 """PDX-License-Identifier: Apache-2.0
 Copyright Contributors to the ODPi Egeria project.
 
-This module contains an initial version of the feedback_manager_omvs
+This module contains an initial version of the classification_manager_omvs
 module.
 
 """

{pyegeria-0.8.4.50 → pyegeria-1.5.1.0.1}/pyegeria/valid_metadata_omvs.py

@@ -89,7 +89,9 @@ class ValidMetadataManager(Client):
           "preferredValue": "",
           "dataType": "",
           "isCaseSensitive": false,
-          "isDeprecated" : false
+          "isDeprecated" : false,
+          "effectiveFrom" : "2024-09-30T20:00:00.000Z",
+          "effectiveTo" : "2025-09-30T20:00:00.000Z",
         }
         """
 
@@ -199,7 +201,9 @@ class ValidMetadataManager(Client):
           "preferredValue": "put mapName value here",
           "dataType": "",
           "isCaseSensitive": false,
-          "isDeprecated" : false
+          "isDeprecated" : false,
+          "effectiveFrom" : "2024-09-30T20:00:00.000Z",
+          "effectiveTo" : "2025-09-30T20:00:00.000Z"
         }
 
         """
@@ -315,6 +319,8 @@ class ValidMetadataManager(Client):
           "preferredValue": "put mapName value here",
           "dataType": "",
           "isCaseSensitive": false,
+          "effectiveFrom" : "2024-09-30T20:00:00.000Z",
+          "effectiveTo" : "2025-09-30T20:00:00.000Z"
         }
         """
         url = (

{pyegeria-0.8.4.50 → pyegeria-1.5.1.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "0.8.4.50"
+version = "1.5.1.0.1"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -116,7 +116,8 @@ pytest = "^8.2.2"
     get_element_info = "commands.tech.get_element_info:main"
     list_elements = "commands.tech.list_elements:main"
     list_related_specification = "commands.tech.list_related_specification:main"
-    list_elements_by_classification = "commands.tech.list_elements_by_classification:main"
+    list_elements_by_classification = "commands.tech.list_elements_for_classification:main"
     list_related_elements = "commands.tech.list_related_elements:main"
 
     list_valid_metadata_values = "commands.tech.list_valid_metadata_values:main"
+    list_get_element_graph = "commands.tech.get_element_graph:main"