pyegeria 1.5.1.0.4__tar.gz → 1.5.1.0.6__tar.gz

{pyegeria-1.5.1.0.4 → pyegeria-1.5.1.0.6}/PKG-INFO

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

pyegeria-1.5.1.0.6/commands/cat/glossary_actions.py

@@ -0,0 +1,212 @@
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+
+
+Execute Glossary actions.
+
+"""
+import os
+import sys
+import time
+from datetime import datetime
+
+import click
+
+# from ops_config import Config, pass_config
+from pyegeria import EgeriaTech, body_slimmer
+from pyegeria._exceptions import (
+    InvalidParameterException,
+    PropertyServerException,
+    print_exception_response,
+)
+
+
+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_INTEGRATION_DAEMON_URL = os.environ.get(
+    "EGERIA_INTEGRATION_DAEMON_URL", "https://localhost:9443"
+)
+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")
+
+
+@click.command("create-glossary")
+@click.option("--name", help="Name of Glossary", required=True)
+@click.option("--language", help="Language of Glossary", default="English")
+@click.option(
+    "--description",
+    help="Description of Glossary",
+    default="A description goes here",
+)
+@click.option(
+    "--usage",
+    help="Purpose of glossary",
+    default="Definitions",
+)
+@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 create_glossary(
+    server: str,
+    url: str,
+    userid: str,
+    password: str,
+    timeout: int,
+    name: str,
+    language: str,
+    description: str,
+    usage: str,
+) -> None:
+    """Create a new Glossary"""
+
+    try:
+        m_client = EgeriaTech(server, url, userid, password)
+        token = m_client.create_egeria_bearer_token()
+
+        existing_glossary = m_client.find_glossaries(name)
+        if type(existing_glossary) is list:
+            click.echo(f"\nFound {len(existing_glossary)} existing Glossaries\n")
+            for glossary in existing_glossary:
+                click.echo(
+                    f"\tFound glossary: {glossary['glossaryProperties']['qualifiedName']} with id of {glossary['elementHeader']['guid']}\n"
+                )
+            sys.exit(0)
+
+        glossary_guid = m_client.create_glossary(name, language, description, usage)
+        print(f"New glossary {name} created with id of {glossary_guid}")
+
+    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(
+    "--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")
+@click.argument("glossary-guid")
+def delete_glossary(server, url, userid, password, timeout, glossary_guid):
+    """Delete the glossary specified"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        m_client.delete_to_do(glossary_guid)
+
+        click.echo(f"Deleted Todo item {glossary_guid}")
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()
+
+
+@click.command("create-term")
+@click.option("--glossary-name", help="Name of Glossary", required=True)
+@click.option("--term-name", help="Name of Term", required=True)
+@click.option(
+    "--summary",
+    help="Summary definition",
+    default="Summary goes here",
+)
+@click.option(
+    "--description",
+    help="Full description",
+    default="Description goes here",
+)
+@click.option("--abbrev", help="Abbreviation", default=None)
+@click.option("--examples", help="Example usage", default=None)
+@click.option("--usage", help="Usage notes", default=None)
+@click.option("--version", help="Version", default="1.0")
+@click.option(
+    "--status",
+    help="Status",
+    type=click.Choice(
+        ["DRAFT", "ACTIVE", "DEPRACATED", "OBSOLETE", "OTHER"], case_sensitive=False
+    ),
+    default="DRAFT",
+)
+@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 create_term(
+    server,
+    url,
+    userid,
+    password,
+    timeout,
+    glossary_name,
+    term_name,
+    summary,
+    description,
+    abbrev,
+    examples,
+    usage,
+    version,
+    status,
+):
+    """Create a new term"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        body = {
+            "class": "ReferenceableRequestBody",
+            "elementProperties": {
+                "class": "GlossaryTermProperties",
+                "qualifiedName": f"GlossaryTerm: {term_name} : {datetime.now().isoformat()}",
+                "displayName": term_name,
+                "summary": summary,
+                "description": description,
+                "abbreviation": abbrev,
+                "examples": examples,
+                "usage": usage,
+                "publishVersionIdentifier": version,
+            },
+            "initialStatus": status,
+        }
+        exists = False
+        glossary_info = m_client.find_glossaries(glossary_name)
+        if type(glossary_info) is list:
+            for glossary in glossary_info:
+                if glossary["glossaryProperties"]["displayName"] == glossary_name:
+                    exists = True
+                    glossary_guid = glossary["elementHeader"]["guid"]
+
+        if not exists:
+            click.echo(f"The glossary name {glossary_name} was not found..exiting\n")
+            sys.exit(0)
+
+        term_guid = m_client.create_controlled_glossary_term(
+            glossary_guid, body_slimmer(body)
+        )
+
+        click.echo(
+            f"Successfully created term {term_name} with GUID {term_guid}, in glossary {glossary_name}.\n"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()

{pyegeria-1.5.1.0.4 → pyegeria-1.5.1.0.6}/commands/cli/egeria.py

@@ -34,6 +34,13 @@ from commands.my.monitor_my_todos import display_my_todos
 from commands.my.monitor_open_todos import display_todos
 from commands.cat.list_deployed_database_schemas import list_deployed_database_schemas
 from commands.cat.list_deployed_catalogs import list_deployed_catalogs
+from commands.cat.glossary_actions import create_glossary, delete_glossary, create_term
+from commands.my.todo_actions import (
+    mark_todo_complete,
+    reassign_todo,
+    delete_todo,
+    create_todo,
+)
 
 
 from commands.ops.gov_server_actions import (
@@ -957,6 +964,15 @@ def tell(ctx):
     pass
 
 
+tell.add_command(create_glossary)
+tell.add_command(delete_glossary)
+tell.add_command(create_term)
+tell.add_command(mark_todo_complete)
+tell.add_command(reassign_todo)
+tell.add_command(delete_todo)
+tell.add_command(create_todo)
+
+
 @tell.group("survey")
 @click.pass_context
 def survey(ctx):

{pyegeria-1.5.1.0.4 → pyegeria-1.5.1.0.6}/commands/cli/egeria_cat.py

@@ -29,10 +29,16 @@ from commands.cat.list_user_ids import list_user_ids
 from commands.cat.list_archives import display_archive_list
 from commands.cat.list_deployed_database_schemas import list_deployed_database_schemas
 from commands.cat.list_deployed_catalogs import list_deployed_catalogs
-
+from commands.cat.glossary_actions import create_glossary, delete_glossary, create_term
 
 # from pyegeria import ServerOps
 from commands.cli.ops_config import Config
+from commands.my.todo_actions import (
+    mark_todo_complete,
+    reassign_todo,
+    delete_todo,
+    create_todo,
+)
 
 
 # class Config(object):
@@ -537,6 +543,15 @@ def tell(ctx):
     pass
 
 
+tell.add_command(create_glossary)
+tell.add_command(delete_glossary)
+tell.add_command(create_term)
+tell.add_command(mark_todo_complete)
+tell.add_command(reassign_todo)
+tell.add_command(delete_todo)
+tell.add_command(create_todo)
+
+
 @tell.group("survey")
 @click.pass_context
 def survey(ctx):

{pyegeria-1.5.1.0.4 → pyegeria-1.5.1.0.6}/commands/my/todo_actions.py

@@ -25,7 +25,7 @@ erins_guid = "a588fb08-ae09-4415-bd5d-991882ceacba"
 peter_guid = "a187bc48-8154-491f-97b4-a2f3c3f1a00e"
 tanya_guid = "26ec1614-bede-4b25-a2a3-f8ed26db3aaa"
 
-ERIA_METADATA_STORE = os.environ.get("EGERIA_METADATA_STORE", "active-metadata-store")
+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")
@@ -43,11 +43,11 @@ EGERIA_USER_PASSWORD = os.environ.get("EGERIA_USER_PASSWORD", "secret")
 
 
 @click.command("create-todo")
+@click.option("--server", default=EGERIA_VIEW_SERVER, help="Egeria view server to use.")
 @click.option(
-    "--server", default=EGERIA_VIEW_SERVER, help="Egeria metadata store to load"
-)
-@click.option(
-    "--url", default=EGERIA_VIEW_SERVER_URL, help="URL of Egeria platform to connect to"
+    "--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")

{pyegeria-1.5.1.0.4 → pyegeria-1.5.1.0.6}/pyegeria/glossary_manager_omvs.py

@@ -1405,6 +1405,17 @@ class GlossaryManager(GlossaryBrowser):
 
         return response
 
+    def load_terms_from_file(
+        self, glossary_name: str, filename: str, upsert: bool = False
+    ) -> str:
+        """This method loads glossary terms into the specified glossary from the indicated file."""
+        # Check that glossary exists and get guid
+
+        # Open file
+
+        # Insert terms into glossary
+        pass
+
     async def _async_create_term_copy(
         self,
         glossary_guid: str,

{pyegeria-1.5.1.0.4 → pyegeria-1.5.1.0.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "1.5.1.0.4"
+version = "1.5.1.0.6"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -69,6 +69,9 @@ pytest = "^8.2.2"
     list_archives = "commands.cat.list_archives:main"
     list_deployed_catalogs = "commands.cat.list_deployed_catalogs:main"
     list_deployed_schemas = "commands.cat.list_deployed_database_schemas:main"
+    create_glossary = "commands.cat.glossary_actions:create_glossary"
+    delete_glossary = "commands.cat.glossary_actions:delete_glossary"
+    create_term = "commands.cat.glossary_actions:create_term"
 
     monitor_asset_events = "commands.ops.monitor_asset_events:main"
     monitor_coco_status = "commands.ops.monitor_coco_status:main"