pyegeria 1.5.1.1.6__tar.gz → 1.5.1.1.7__tar.gz

{pyegeria-1.5.1.1.6 → pyegeria-1.5.1.1.7}/PKG-INFO

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

{pyegeria-1.5.1.1.6 → pyegeria-1.5.1.1.7}/commands/cat/glossary_actions.py

@@ -13,10 +13,15 @@ import os
 import sys
 import time
 from datetime import datetime
+from rich import box
+from rich.console import Console
+from rich.prompt import Prompt
+from rich.table import Table
+from rich.text import Text
 
 import click
 
-# from ops_config import Config, pass_config
+
 from pyegeria import EgeriaTech, body_slimmer
 from pyegeria._exceptions import (
     InvalidParameterException,
@@ -40,6 +45,8 @@ 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_WIDTH = os.environ.get("EGERIA_WIDTH", 200)
+EGERIA_JUPYTER = os.environ.get("EGERIA_JUPYTER", False)
 
 
 @click.command("create-glossary")
@@ -88,7 +95,7 @@ def create_glossary(
                 )
             sys.exit(0)
 
-        glossary_guid = m_client.create_glossary(name, language, description, usage)
+        glossary_guid = m_client.create_glossary(name, description, language, usage)
         print(f"New glossary {name} created with id of {glossary_guid}")
 
     except (InvalidParameterException, PropertyServerException) as e:
@@ -97,6 +104,64 @@ def create_glossary(
         m_client.close_session()
 
 
+@click.command("list-glossaries")
+@click.option("--search-string", default="*", help="Glossaries to search for")
+@click.option("--server", default=EGERIA_VIEW_SERVER, help="Egeria view server to use")
+@click.option(
+    "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
+)
+@click.option("--userid", default=EGERIA_USER, help="Egeria user")
+@click.option("--password", default=EGERIA_USER_PASSWORD, help="Egeria user password")
+@click.option("--timeout", default=60, help="Number of seconds to wait")
+def list_glossaries(search_string, server, url, userid, password, timeout):
+    """List all glossaries"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    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 '{server}' @ Platform - {url}",
+            expand=True,
+        )
+        table.add_column("Glossary Name")
+        table.add_column("Qualified Name / GUID")
+        table.add_column("Language")
+        table.add_column("Description")
+        table.add_column("Usage")
+
+        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 = f"{qualified_name}\n\n{guid}"
+                language = glossary["glossaryProperties"]["language"]
+                description = glossary["glossaryProperties"]["description"]
+                usage = glossary["glossaryProperties"]["usage"]
+                table.add_row(display_name, q_name, language, description, usage)
+            console = Console(
+                style="bold bright_white on black",
+                width=EGERIA_WIDTH,
+                force_terminal=not EGERIA_JUPYTER,
+            )
+            console.print(table)
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
 @click.command("delete-glossary")
 @click.option("--server", default=EGERIA_VIEW_SERVER, help="Egeria view server to use")
 @click.option(

pyegeria-1.5.1.1.6/commands/cat/list_glossary.py → pyegeria-1.5.1.1.7/commands/cat/list_terms.py

@@ -68,10 +68,10 @@ def display_glossary_terms(
             caption_style="white on black",
             show_lines=True,
             box=box.ROUNDED,
-            caption=f"Glossary View Server '{server}' @ Platform - {url}",
+            caption=f"View Server '{server}' @ Platform - {url}",
             expand=True,
         )
-        table.add_column("Display Name")
+        table.add_column("Term Name")
         table.add_column("Qualified Name")
 
         table.add_column("Abbreviation")

{pyegeria-1.5.1.1.6 → pyegeria-1.5.1.1.7}/commands/cli/egeria.py

@@ -20,7 +20,7 @@ from commands.cat.get_tech_type_elements import tech_viewer
 from commands.cat.get_tech_type_template import template_viewer
 from commands.cat.list_assets import display_assets
 from commands.cat.list_cert_types import display_certifications
-from commands.cat.list_glossary import display_glossary_terms
+from commands.cat.list_terms import display_glossary_terms
 from commands.cat.list_projects import display_project_list
 from commands.cat.list_relationships import list_relationships
 from commands.cat.list_tech_types import display_tech_types
@@ -40,6 +40,7 @@ from commands.cat.list_deployed_databases import list_deployed_databases
 from commands.cat.glossary_actions import (
     create_glossary,
     delete_glossary,
+    list_glossaries,
     create_term,
     load_terms,
 )
@@ -970,6 +971,8 @@ def list_databases(ctx):
     )
 
 
+show.add_command(list_glossaries)
+
 #
 #  Catalog User: Tell
 #

{pyegeria-1.5.1.1.6 → pyegeria-1.5.1.1.7}/commands/cli/egeria_cat.py

@@ -23,6 +23,7 @@ from commands.cat.glossary_actions import (
     delete_glossary,
     create_term,
     load_terms,
+    list_glossaries,
 )
 from commands.cat.list_archives import display_archive_list
 from commands.cat.list_assets import display_assets
@@ -32,7 +33,7 @@ from commands.cat.list_deployed_database_schemas import (
     list_deployed_database_schemas,
 )
 from commands.cat.list_deployed_databases import list_deployed_databases
-from commands.cat.list_glossary import display_glossary_terms
+from commands.cat.list_terms import display_glossary_terms
 from commands.cat.list_projects import display_project_list
 from commands.cat.list_relationships import list_relationships
 from commands.cat.list_tech_types import display_tech_types
@@ -552,6 +553,8 @@ def list_databases(ctx):
     )
 
 
+show.add_command(list_glossaries)
+
 #
 #  Tell
 #

{pyegeria-1.5.1.1.6 → pyegeria-1.5.1.1.7}/pyegeria/glossary_manager_omvs.py

@@ -10,6 +10,7 @@ import asyncio
 import time
 import csv
 from datetime import datetime
+from typing import List
 
 from pyegeria import InvalidParameterException
 
@@ -1417,7 +1418,7 @@ class GlossaryManager(GlossaryBrowser):
 
     def load_terms_from_file(
         self, glossary_name: str, filename: str, upsert: bool = False
-    ) -> [dict]:
+    ) -> List[dict]:
         """This method loads glossary terms into the specified glossary from the indicated file."""
         # Check that glossary exists and get guid
         glossaries = self.get_glossaries_by_name(glossary_name)
@@ -1437,7 +1438,6 @@ class GlossaryManager(GlossaryBrowser):
 
         # Now we know we have a single glossary so we can get the guid
         glossary_guid = glossaries[0]["elementHeader"]["guid"]
-        term_info = []
 
         term_properties = {
             "Term Name",
@@ -1455,6 +1455,7 @@ class GlossaryManager(GlossaryBrowser):
             # Create a CSV reader object
             csv_reader = csv.DictReader(file)
             headers = csv_reader.fieldnames
+            term_info = []
             # check that the column headers are known
             if all(header in term_properties for header in headers) is False:
                 raise InvalidParameterException("Invalid headers in CSV File")
@@ -1473,23 +1474,23 @@ class GlossaryManager(GlossaryBrowser):
                 status = row.get("Status", "DRAFT").upper()
 
                 # process the row
-                if term_name is None:
+                if len(term_name) < 2:
                     term_info.append(
                         {
-                            {"term_name": "---"},
-                            {"qualified_name": "---"},
-                            {"term_guid": "---"},
-                            {"error": "missing term names - skipping"},
+                            "term_name": "---",
+                            "qualified_name": "---",
+                            "term_guid": "---",
+                            "error": "missing or invalid term names - skipping",
                         }
                     )
                     continue
                 if self.__validate_term_status__(status) is False:
                     term_info.append(
                         {
-                            {"term_name": "---"},
-                            {"qualified_name": "---"},
-                            {"term_guid": "---"},
-                            {"error": "invalid term status"},
+                            "term_name": "---",
+                            "qualified_name": "---",
+                            "term_guid": "---",
+                            "error": "invalid term status",
                         }
                     )
                     continue

{pyegeria-1.5.1.1.6 → pyegeria-1.5.1.1.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "1.5.1.1.6"
+version = "1.5.1.1.7"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -56,7 +56,7 @@ pytest = "^8.2.2"
     list_tech_types = "commands.cat.list_tech_types:main"
     get_asset_graph = "commands.cat.get_asset_graph:main"
     get_collection = "commands.cat.get_collection:main"
-    list_terms = "commands.cat.list_glossary:main"
+    list_terms = "commands.cat.list_terms:main"
     get_tech_type_elements = "commands.cat.get_tech_type_elements:main"
     get_tech_type_template = "commands.cat.get_tech_type_template:main"
     list_projects = "commands.cat.list_projects:main"
@@ -73,6 +73,7 @@ pytest = "^8.2.2"
     create_glossary = "commands.cat.glossary_actions:create_glossary"
     delete_glossary = "commands.cat.glossary_actions:delete_glossary"
     create_term = "commands.cat.glossary_actions:create_term"
+    list_glossaries = "commands.cat.glossary_actions:list_glossaries"
     load_terms_from_file = "commands.cat.glossary_actions:load_terms"
 
     monitor_asset_events = "commands.ops.monitor_asset_events:main"