pyegeria 1.5.1.1.60__py3-none-any.whl → 1.5.1.1.61__py3-none-any.whl

pyegeria/commands/cat/exp_list_glossaries.py

@@ -0,0 +1,156 @@
+#!/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, print
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
+from rich_pixels import Pixels
+
+
+from pyegeria import (
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+    EgeriaTech,
+    print_exception_response,
+)
+
+disable_ssl_warnings = True
+
+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_glossaries(
+    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,
+):
+    """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(
+            title=f"Glossary List @ {time.asctime()}",
+            style="bright_white on black",
+            header_style="bright_white on dark_blue",
+            title_style="bold white on black",
+            caption_style="white on black",
+            show_lines=True,
+            box=box.ROUNDED,
+            caption=f"View Server '{view_server}' @ Platform - {view_url}",
+            expand=True,
+        )
+        table.add_column("Glossary Name")
+        table.add_column(
+            "Qualified Name & GUID", width=38, no_wrap=True, justify="center"
+        )
+        table.add_column("Language")
+
+        table.add_column("Usage", width=50, justify="center")
+
+        glossaries = m_client.find_glossaries(search_string)
+        if type(glossaries) is list:
+            sorted_glossary_list = sorted(
+                glossaries, key=lambda k: k["glossaryProperties"]["displayName"]
+            )
+            for glossary in sorted_glossary_list:
+                display_name = glossary["glossaryProperties"]["displayName"]
+                qualified_name = glossary["glossaryProperties"]["qualifiedName"]
+                guid = glossary["elementHeader"]["guid"]
+                q_name = Text(f"{qualified_name}\n&\n{guid}", justify="center")
+                language = glossary["glossaryProperties"]["language"]
+                description = glossary["glossaryProperties"]["description"]
+                usage = glossary["glossaryProperties"]["usage"]
+                text = "http://100.83.199.62:8088/superset/dashboard/p/xOgE56dLNaY/"
+
+                table.add_row(display_name, q_name, language, text)
+            console = Console(
+                style="bold bright_white on black",
+                width=width,
+                force_terminal=not jupyter,
+            )
+            console.print(table)
+            print("Visit my [link=https://www.willmcgugan.com]blog[/link]!")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_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="User 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
+    user_pass = args.password if args.password is not None else EGERIA_USER_PASSWORD
+
+    try:
+        search_string = Prompt.ask(
+            "Enter the glossary you are searching for or '*' for all:", default="*"
+        )
+
+        display_glossaries(search_string, server, url, userid, user_pass)
+
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()

pyegeria/commands/ops/monitor_server_status.py

@@ -169,7 +169,7 @@ def main():
     parser.add_argument("--password", help="User Password")
     args = parser.parse_args()
 
-    full = args.extended if args.extended is not None else False
+    full = args.full if args.full is not None else False
     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_ADMIN_USER

pyegeria/core_omag_server_config.py

@@ -818,6 +818,42 @@ class CoreServerConfig(Client):
         )
         self.make_request("POST", url, severities)
 
+    def add_postgres_log_destinations(
+        self, config_body: dict, server_name: str = None
+    ) -> None:
+        """Adds a postgres log destination to a server.
+
+        Parameters
+        ----------
+        config_body : str
+            Configuration of the postgres database for the audit log destination.
+        server_name : str
+            Name of the server to update.
+
+        Returns
+        -------
+        Void
+
+        Raises
+        ------
+
+        InvalidParameterException:
+            If the client passes incorrect parameters on the request - such as bad URLs or invalid values
+        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
+        ConfigurationErrorException:
+            Raised when configuration parameters passed on earlier calls turn out to be
+            invalid or make the new call invalid.
+
+        """
+        if server_name is None:
+            server_name = self.server_name
+
+        url = f"{self.core_command_root}/servers/{server_name}/audit-log-destinations/postgres"
+        self.make_request("POST", url, config_body)
+
     def add_slf4j_log_destination(
         self, severities: [str] = None, server_name: str = None
     ) -> None:

{pyegeria-1.5.1.1.60.dist-info → pyegeria-1.5.1.1.61.dist-info}/METADATA

@@ -1,29 +1,29 @@
 Metadata-Version: 2.1
 Name: pyegeria
-Version: 1.5.1.1.60
+Version: 1.5.1.1.61
 Summary: A python client for Egeria
 Home-page: https://github.com/odpi/egeria-python
 License: Apache 2.0
 Keywords: egeria,metadata,governance
 Author: Dan Wolfson
 Author-email: dan.wolfson@pdr-associates.com
-Requires-Python: >=3.11,<4.0
+Requires-Python: >=3.12,<4.0
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: License :: Other/Proprietary License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Dist: click (>=8.1.7,<9.0.0)
 Requires-Dist: confluent-kafka (>=2.5.0,<3.0.0)
-Requires-Dist: httpx (>=0.27.0,<0.28.0)
+Requires-Dist: httpx (>=0.27,<0.28)
 Requires-Dist: jupyter (>=1.0.0,<2.0.0)
 Requires-Dist: mermaid-py (>=0.5.3,<0.6.0)
 Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
 Requires-Dist: pytest (>=8.2.2,<9.0.0)
 Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: rich (>=13.8.1,<14.0.0)
-Requires-Dist: textual (>=0.75.1,<0.76.0)
+Requires-Dist: rich (>=13,<14)
+Requires-Dist: rich-pixels (>=3.0.1,<4.0.0)
+Requires-Dist: textual (>=0.86,<0.87)
 Requires-Dist: textual-forms (>=0.3.0,<0.4.0)
 Requires-Dist: trogon (>=0.5.0,<0.6.0)
 Requires-Dist: urllib3 (>=2.2.2,<3.0.0)

{pyegeria-1.5.1.1.60.dist-info → pyegeria-1.5.1.1.61.dist-info}/RECORD

@@ -13,6 +13,7 @@ pyegeria/commands/README.md,sha256=zNfWZppDxoKqTJeRtcewzku9z1m6_hKacCyQUQw1iq4,1
 pyegeria/commands/__init__.py,sha256=IBYAvBbuGneZ06YSFjZsU-Zxx-b-Qo4ZV_Vd4zz4AI0,844
 pyegeria/commands/cat/README.md,sha256=-aaAnIT2fcfU63vajgB-RzQk4l4yFdhkyVfSaTPiqRY,967
 pyegeria/commands/cat/__init__.py,sha256=3LHTWeyxLdFGDhWVTBzgJ6Y_9b2pM5CO2-kbsUASv4M,300
+pyegeria/commands/cat/exp_list_glossaries.py,sha256=Gz_4XdwxhblIriuXajjwXueyRRGDwwyTXcfQiFjn1xY,5804
 pyegeria/commands/cat/get_asset_graph.py,sha256=4AO4KlCgb7vbMihJK7W_GAnrd4J9sKwc4kXxa2ZrRW4,12447
 pyegeria/commands/cat/get_collection.py,sha256=v7hCeEDcAQmcjM9qepuk8gg_RnYra3_v009AJOunkKk,5005
 pyegeria/commands/cat/get_project_dependencies.py,sha256=B0JaMSUi0hzVgos1sTY2uUPGy1DzKEJMIbbYfMUWvQA,5981
@@ -75,6 +76,7 @@ pyegeria/commands/doc/glossary/images/tui-show-glossary-terms 2024-11-05 at 19.3
 pyegeria/commands/doc/glossary/images/tui-upsert 2024-11-07 at 11.49.04.png,sha256=tLM_fX53WHDL3bALqvTugOsq_v-CcwaLQpJ0325gewE,347024
 pyegeria/commands/doc/glossary/images/upsert-example.om-terms 2024-11-07 at 11.44.05.png,sha256=h0VE0ybRygOToKYnRplTwXcQlK4H7AzCySO7YEfkKuc,174761
 pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/hey_egeria: overview.md,sha256=kCKj6rYTBj2De4XJYatP2X0m-7iS43r5zUTeLyDEVYE,18950
+pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/CleanShot 2024-11-18 at 21.32.03@2x.png,sha256=VAlnHSpnDqCGTIc-IOozARcR6sSl9QNgmhuPOeiM-4s,913730
 pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731421782704.png,sha256=8lfyO8prtahjTqqT4Uk3HSICipBpf1ly2bXp00csRb8,314990
 pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/Xmind 1731422134920.png,sha256=Ri4xBHuYzsMrOpoq48-3UkfQNLm9coJxLT_LJGNIU80,745535
 pyegeria/commands/doc/hey_egeria: a pyegeria command line interface/images/hey_egeria  2024-11-12 at 20.38.43.png,sha256=J9g754NN27AOk_OYUPI4o0A7cM5oHUqO-P5sjUmBsxM,387071
@@ -110,7 +112,7 @@ pyegeria/commands/ops/monitor_gov_eng_status.py,sha256=nR0xI_8L8W6gOJm8-jp8BaAeO
 pyegeria/commands/ops/monitor_integ_daemon_status.py,sha256=NQVHJuZfRfSaO7WjZnziI6ckHLCl06ykliJCV_sICOI,11368
 pyegeria/commands/ops/monitor_platform_status.py,sha256=E4Qf6m1dv8EqUV1-LAxWAlOrZRqNSXJgJ0i_cczW1aI,6578
 pyegeria/commands/ops/monitor_server_startup.py,sha256=0pwnhv761uuFHGJXVANa5RhQQPPTXFldJ45TfeT7qfk,3901
-pyegeria/commands/ops/monitor_server_status.py,sha256=TLdtjt5EFR-VVC2jAZqiBlGMvtb5IjOTdtdVZfHMz0o,6878
+pyegeria/commands/ops/monitor_server_status.py,sha256=O7iixd-6jzaDO7QrK1JuXLdrDF291YvxLbgLUk3BYQs,6870
 pyegeria/commands/ops/orig_monitor_server_list.py,sha256=Uhtn8lv7QVXJBi9DSR3Nelmz8TB0vOsat10nFS6Nu20,4637
 pyegeria/commands/ops/orig_monitor_server_status.py,sha256=A-8hMDfbscdcq-b1OD4wKn0tphumX8WIK-Hz8uPoFkc,3974
 pyegeria/commands/ops/refresh_integration_daemon.py,sha256=WEAeaFAEWLJ055pGfzX6rkn7mq3Z0FYqJ0Xn0z1VjtA,2962
@@ -138,7 +140,7 @@ pyegeria/commands/tech/list_tech_templates.py,sha256=FIeYWnJY2bVUrfDQBJX2bpkp5cU
 pyegeria/commands/tech/list_valid_metadata_values.py,sha256=N3D0_BmREPszgde3uvvYdfzq7DJ46uMOv2t1vtncGsw,6333
 pyegeria/commands/tech/table_tech_templates.py,sha256=_aWI4U8CMO0c2JdUxfqW7b2RQADMPUBvTulWk6m50VA,9318
 pyegeria/commands/tech/x_list_related_elements.py,sha256=qBsf1619cecaMCTzG0MG22fAT32WNH2Z3CXrjo9z-5Y,5853
-pyegeria/core_omag_server_config.py,sha256=UKgnMGjB-WikvRjjkVjkAcbWEsL5G10BlHBFPgCoCw8,96497
+pyegeria/core_omag_server_config.py,sha256=ej0oNpGelSTTm2oERS86LpgT9O9E5CZFbUm2Iek8f1E,97764
 pyegeria/create_tech_guid_lists.py,sha256=HHkC6HW58EN1BiolrYSRqSE0JhPbTepOFzwtdwBxVaU,4640
 pyegeria/egeria_cat_client.py,sha256=NzwDbdi5OBHOOA7JzIQC5LqJJ7xtEwHA5yaKrGkDFnc,2022
 pyegeria/egeria_client.py,sha256=gZjo_Z8n7r05KJnQgJuQibGOvCA90JCDlzyFRGkZV-I,3366
@@ -160,8 +162,8 @@ pyegeria/template_manager_omvs.py,sha256=heqbKeum5hPCHap4r1RUZU8YB3QaQlxVNbq4GZi
 pyegeria/utils.py,sha256=1h6bwveadd6GpbnGLTmqPBmBk68QvxdjGTI9RfbrgKY,5415
 pyegeria/valid_metadata_omvs.py,sha256=tfCGXed5LLt59YA8uZNNtd9UJ-lRZfPU_uZxK31Yux0,65069
 pyegeria/x_action_author_omvs.py,sha256=xu1IQ0YbhIKi17C5a7Aq9u1Az2czwahNPpX9czmyVxE,6454
-pyegeria-1.5.1.1.60.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-1.5.1.1.60.dist-info/METADATA,sha256=jSeDNCcs-ovkGuyFsD9jkBDQwd-_HBucn_rAzjL4o3I,2998
-pyegeria-1.5.1.1.60.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-1.5.1.1.60.dist-info/entry_points.txt,sha256=oG-N-_kcUg7NFj2XchfxtFqsL4d4uOxlGYZOzDta1Pg,5171
-pyegeria-1.5.1.1.60.dist-info/RECORD,,
+pyegeria-1.5.1.1.61.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-1.5.1.1.61.dist-info/METADATA,sha256=LPbV3MEz4VPkgPeKrC53vdWDLASlTN7XuVeGWvjIf74,2975
+pyegeria-1.5.1.1.61.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-1.5.1.1.61.dist-info/entry_points.txt,sha256=oG-N-_kcUg7NFj2XchfxtFqsL4d4uOxlGYZOzDta1Pg,5171
+pyegeria-1.5.1.1.61.dist-info/RECORD,,