pyegeria 1.5.1.1.11__py3-none-any.whl → 1.5.1.1.13__py3-none-any.whl

commands/cat/glossary_actions.py

@@ -329,3 +329,36 @@ def load_terms(
         print_exception_response(e)
     finally:
         m_client.close_session()
+
+
+@click.command("export-terms-to-file")
+@click.option("--glossary-guid", help="GUID of Glossary to export", required=True)
+@click.option("--file-name", help="Path of CSV file", required=True)
+@click.option(
+    "--verbose",
+    is_flag=True,
+    default=False,
+    help="If set, result descriptions are provided",
+)
+@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 export_terms(glossary_guid, file_name, server, url, userid, password, timeout):
+    """Delete the glossary specified"""
+    m_client = EgeriaTech(server, url, user_id=userid, user_pwd=password)
+    token = m_client.create_egeria_bearer_token()
+    try:
+        result = m_client.export_glossary_to_csv(glossary_guid, file_name)
+
+        click.echo(
+            f"Exported {result} terms  from glossary: {glossary_guid} into {file_name}"
+        )
+
+    except (InvalidParameterException, PropertyServerException) as e:
+        print_exception_response(e)
+    finally:
+        m_client.close_session()

commands/cat/list_terms.py

@@ -73,12 +73,12 @@ def display_glossary_terms(
         )
         table.add_column("Term Name")
         table.add_column("Qualified Name / GUID")
-        table.add_column("Glossary")
         table.add_column("Abbreviation")
         table.add_column("Summary")
         table.add_column("Description")
         table.add_column("Version Id")
-        # table.add_column("Status")
+        table.add_column("Glossary")
+        table.add_column("Status")
 
         terms = g_client.find_glossary_terms(
             search_string,
@@ -98,7 +98,7 @@ def display_glossary_terms(
         style = "bright_white on black"
         if type(terms) is str:
             return table
-
+        glossary_info = {}
         for term in sorted_terms:
             props = term.get("glossaryTermProperties", "None")
             if props == "None":
@@ -113,19 +113,31 @@ def display_glossary_terms(
             description = Text(props.get("description", " "), style=style)
             version = Text(props.get("publishVersionIdentifier", " "), style=style)
 
-            glossary_info = g_client.get_glossary_for_term(term_guid)
-
-            glossary_name = glossary_info["glossaryProperties"].get("displayName", " ")
-
+            classifications = term["elementHeader"]["classifications"]
+            glossary_guid = None
+            for c in classifications:
+                if c["classificationName"] == "Anchors":
+                    glossary_guid = c["classificationProperties"]["anchorGUID"]
+
+            if glossary_guid and glossary_guid in glossary_info:
+                glossary_name = glossary_info[glossary_guid]
+            elif glossary_guid:
+                g = g_client.get_glossary_for_term(term_guid)
+                glossary_name = g["glossaryProperties"].get("displayName", "---")
+                glossary_info[glossary_guid] = glossary_name
+            else:
+                glossary_name = "---"
+
+            term_status = term["elementHeader"]["status"]
             table.add_row(
                 display_name,
                 q_name,
-                glossary_name,
                 abbrev,
                 summary,
                 description,
                 version,
-                # status,
+                glossary_name,
+                term_status,
                 style="bold white on black",
             )
 
@@ -133,10 +145,6 @@ def display_glossary_terms(
         return table
 
     try:
-        # with Live(generate_table(), refresh_per_second=4, screen=True) as live:
-        #     while True:
-        #         time.sleep(2)
-        #         live.update(generate_table(search_string))
         console = Console(
             style="bold bright_white on black", width=width, force_terminal=not jupyter
         )

commands/cli/egeria.py

@@ -43,6 +43,7 @@ from commands.cat.glossary_actions import (
     list_glossaries,
     create_term,
     load_terms,
+    export_terms,
 )
 from commands.my.todo_actions import (
     mark_todo_complete,
@@ -993,6 +994,7 @@ tell.add_command(reassign_todo)
 tell.add_command(delete_todo)
 tell.add_command(create_todo)
 tell.add_command(load_terms)
+tell.add_command(export_terms)
 
 
 @tell.group("survey")

commands/cli/egeria_cat.py

@@ -24,6 +24,7 @@ from commands.cat.glossary_actions import (
     create_term,
     load_terms,
     list_glossaries,
+    export_terms,
 )
 from commands.cat.list_archives import display_archive_list
 from commands.cat.list_assets import display_assets
@@ -575,6 +576,7 @@ tell.add_command(reassign_todo)
 tell.add_command(delete_todo)
 tell.add_command(create_todo)
 tell.add_command(load_terms)
+tell.add_command(export_terms)
 
 
 @tell.group("survey")

pyegeria/glossary_manager_omvs.py

@@ -67,7 +67,7 @@ class GlossaryManager(GlossaryBrowser):
 
     def __validate_term_status__(self, status: str) -> bool:
         """Return True if the status is a legal glossary term status"""
-        recognized_term_status = {"DRAFT", "ACTIVE", "DEPRACATED", "OBSOLETE", "OTHER"}
+        recognized_term_status = self.get_glossary_term_statuses()
         return status in recognized_term_status
 
     async def _async_create_glossary(
@@ -103,7 +103,7 @@ class GlossaryManager(GlossaryBrowser):
             "class": "ReferenceableRequestBody",
             "elementProperties": {
                 "class": "GlossaryProperties",
-                "qualifiedName": f"Glossary-{display_name}-{time.asctime()}",
+                "qualifiedName": f"Glossary:{display_name}-{time.asctime()}",
                 "displayName": display_name,
                 "description": description,
                 "language": language,
@@ -187,6 +187,120 @@ class GlossaryManager(GlossaryBrowser):
         response = loop.run_until_complete(self._async_delete_glossary(glossary_guid))
         return response
 
+    async def _async_update_glossary(
+        self,
+        glossary_guid: str,
+        body: dict,
+        is_merge_update: bool = True,
+        for_lineage: bool = False,
+        for_duplicate_processing: bool = False,
+    ) -> None:
+        """Update Glossary.
+
+        Async version.
+
+        Parameters
+        ----------
+        glossary_guid: str
+            The ID of the glossary to update.
+        body: dict
+            A dict containing the properties to update.
+        is_merge_update: bool, optional, default = True
+            If true, then only those properties specified in the body will be updated. If false, then all the
+            properties of the glossary will be replaced with those of the body.
+        for_lineage: bool, optional, default = False
+            Normally false. Used when we want to retrieve elements that have been delete but have a Memento entry.
+        for_duplicate_processing: bool, optional, default = False
+            Normally false. Set true when Egeria is told to skip deduplication because another system will do it.
+
+
+        Returns
+        -------
+        None
+
+        Notes
+        -----
+
+        Sample body:
+
+            {
+                "class" : "ReferenceableRequestBody",
+                "elementProperties" :
+                    {
+                        "class" : "GlossaryProperties",
+                        "qualifiedName" : "MyGlossary",
+                        "displayName" : "My Glossary",
+                        "description" : "This is an example glossary"
+                    }
+            }
+        """
+
+        url = (
+            f"{self.platform_url}/servers/{self.view_server}/api/open-metadata/glossary-manager/glossaries/"
+            f"{glossary_guid}/update?isMergeUpdate={is_merge_update}&forLineage={for_lineage}&"
+            f"forDuplicateProcessing={for_duplicate_processing}"
+        )
+
+        await self._async_make_request("POST", url, body_slimmer(body))
+        return
+
+    def update_glossary(
+        self,
+        glossary_guid: str,
+        body: dict,
+        is_merge_update: bool = True,
+        for_lineage: bool = False,
+        for_duplicate_processing: bool = False,
+    ) -> None:
+        """Update Glossary.
+
+        Parameters
+        ----------
+        glossary_guid: str
+            The ID of the glossary to update.
+        body: dict
+            A dict containing the properties to update.
+        is_merge_update: bool, optional, default = True
+            If true, then only those properties specified in the body will be updated. If false, then all the
+            properties of the glossary will be replaced with those of the body.
+        for_lineage: bool, optional, default = False
+            Normally false. Used when we want to retrieve elements that have been delete but have a Memento entry.
+        for_duplicate_processing: bool, optional, default = False
+            Normally false. Set true when Egeria is told to skip deduplication because another system will do it.
+
+
+        Returns
+        -------
+        None
+
+        Notes
+        -----
+
+        Sample body:
+
+            {
+                "class" : "ReferenceableRequestBody",
+                "elementProperties" :
+                    {
+                        "class" : "GlossaryProperties",
+                        "qualifiedName" : "MyGlossary",
+                        "displayName" : "My Glossary",
+                        "description" : "This is an example glossary"
+                    }
+            }
+        """
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(
+            self._async_update_glossary(
+                glossary_guid,
+                body,
+                is_merge_update,
+                for_lineage,
+                for_duplicate_processing,
+            )
+        )
+        return
+
     #
     #       Glossaries
     #
@@ -1471,9 +1585,10 @@ class GlossaryManager(GlossaryBrowser):
                 examples = row.get("Examples", None)
                 usage = row.get("Usage", None)
                 version = row.get("Version Identifier", "1.0")
-                status = row.get("Status", "DRAFT").upper()
+                status = row.get("Status", "DRAFT")
+                status = status.upper()
 
-                # process the row
+                # quality check the row
                 if len(term_name) < 2:
                     term_info.append(
                         {
@@ -1494,12 +1609,64 @@ class GlossaryManager(GlossaryBrowser):
                         }
                     )
                     continue
+                if upsert:
+                    # If upsert is set we need to see if it can be done (there must be a valid qualified name) and then
+                    # do the update for the row - if there is no qualified name we will treat the row as an insert.
+                    if qualified_name:
+                        body = {
+                            "class": "ReferenceableRequestBody",
+                            "elementProperties": {
+                                "class": "GlossaryTermProperties",
+                                "qualifiedName": qualified_name,
+                                "displayName": term_name,
+                                "summary": summary,
+                                "description": description,
+                                "abbreviation": abbrev,
+                                "examples": examples,
+                                "usage": usage,
+                                "publishVersionIdentifier": version,
+                            },
+                            "initialStatus": status,
+                        }
+                        term_stuff = self.get_terms_by_name(
+                            qualified_name, glossary_guid
+                        )
+                        if type(term_stuff) is str:
+                            # An existing term was not found with that qualified name
+                            term_info.append(
+                                {
+                                    "term_name": term_name,
+                                    "qualified_name": qualified_name,
+                                    "term_guid": term_guid,
+                                    "error": "Matching term not found - skipping",
+                                }
+                            )
+                            continue
+                        else:
+                            # An existing term was found - so update it!
+                            term_guid = term_stuff["elementHeader"]["guid"]
+                            self.update_term(
+                                term_guid, body_slimmer(body), is_merge_update=True
+                            )
+                            term_info.append(
+                                {
+                                    "term_name": term_name,
+                                    "qualified_name": qualified_name,
+                                    "term_guid": term_guid,
+                                    "updated": "the term was updated",
+                                }
+                            )
+                            continue
 
+                # Add the term
+                term_qualified_name = (
+                    f"GlossaryTerm: {term_name} - {datetime.now().isoformat()}"
+                )
                 body = {
                     "class": "ReferenceableRequestBody",
                     "elementProperties": {
                         "class": "GlossaryTermProperties",
-                        "qualifiedName": f"GlossaryTerm: {term_name} - {datetime.now().isoformat()}",
+                        "qualifiedName": term_qualified_name,
                         "displayName": term_name,
                         "summary": summary,
                         "description": description,
@@ -1511,9 +1678,6 @@ class GlossaryManager(GlossaryBrowser):
                     "initialStatus": status,
                 }
 
-                # if upsert:
-                #     if len(qualified_name) > 5:
-                #         existing_term =
                 # Add the term
                 term_guid = self.create_controlled_glossary_term(
                     glossary_guid, body_slimmer(body)
@@ -1521,12 +1685,95 @@ class GlossaryManager(GlossaryBrowser):
                 term_info.append(
                     {
                         "term_name": term_name,
-                        "qualified_name": qualified_name,
+                        "qualified_name": term_qualified_name,
                         "term_guid": term_guid,
                     }
                 )
         return term_info
 
+    async def _async_export_glossary_to_csv(
+        self, glossary_guid: str, target_file: str
+    ) -> int:
+        """Export all the terms in a glossary to a CSV file. Async version
+
+        Parameters:
+        -----------
+        glossary_guid: str
+            Identity of the glossary to export.
+        target_file: str
+            Complete file name with path and extension to export to.
+
+        Returns:
+            int: Number of rows exported.
+        """
+
+        term_list = await self._async_get_terms_for_glossary(glossary_guid)
+
+        header = [
+            "Term Name",
+            "Qualified Name",
+            "Abbreviation",
+            "Summary",
+            "Description",
+            "Examples",
+            "Usage",
+            "Version Identifier",
+            "Status",
+        ]
+
+        with open(target_file, mode="w") as file:
+            csv_writer = csv.DictWriter(file, fieldnames=header)
+            csv_writer.writeheader()
+            count = 0
+            for term in term_list:
+                term_name = term["glossaryTermProperties"]["displayName"]
+                qualified_name = term["glossaryTermProperties"]["qualifiedName"]
+                abbrev = term["glossaryTermProperties"]["abbreviation"]
+                summary = term["glossaryTermProperties"]["summary"]
+                description = term["glossaryTermProperties"]["description"]
+                examples = term["glossaryTermProperties"]["examples"]
+                usage = term["glossaryTermProperties"]["usage"]
+                version = term["glossaryTermProperties"]["publishVersionIdentifier"]
+                status = term["elementHeader"]["status"]
+
+                csv_writer.writerow(
+                    {
+                        "Term Name": term_name,
+                        "Qualified Name": qualified_name,
+                        "Abbreviation": abbrev,
+                        "Summary": summary,
+                        "Description": description,
+                        "Examples": examples,
+                        "Usage": usage,
+                        "Version Identifier": version,
+                        "Status": status,
+                    }
+                )
+
+                count += 1
+        return count
+
+    def export_glossary_to_csv(self, glossary_guid: str, target_file: str) -> int:
+        """Export all the terms in a glossary to a CSV file.
+
+        Parameters:
+        -----------
+        glossary_guid: str
+            Identity of the glossary to export.
+        target_file: str
+            Complete file name with path and extension to export to.
+
+        Returns:
+            int: Number of rows exported.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_export_glossary_to_csv(glossary_guid, target_file)
+        )
+
+        return response
+
     async def _async_create_term_copy(
         self,
         glossary_guid: str,

{pyegeria-1.5.1.1.11.dist-info → pyegeria-1.5.1.1.13.dist-info}/METADATA

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

{pyegeria-1.5.1.1.11.dist-info → pyegeria-1.5.1.1.13.dist-info}/RECORD

@@ -6,7 +6,7 @@ commands/cat/get_project_dependencies.py,sha256=B0JaMSUi0hzVgos1sTY2uUPGy1DzKEJM
 commands/cat/get_project_structure.py,sha256=n2GbNd07w1DTo7jTR8b2ewXRyNcat_2BcCBRyDMldwk,5969
 commands/cat/get_tech_type_elements.py,sha256=-m3Q0BoNqkCtV8h75vMwTcOV-_ymEXmnJcr4Ec7WMAw,6180
 commands/cat/get_tech_type_template.py,sha256=gMFVcgCIm09GQu1Vsc5ZUVH9XLhItAG1eVGZJrcnHeQ,6174
-commands/cat/glossary_actions.py,sha256=wj6kooUTm8aZkfoVkFXlSM90awhniGgCdZxiSMq1axo,11891
+commands/cat/glossary_actions.py,sha256=_DmE_mgm24q1I_IbuytLmkqECWj83Xwmq70E1zMZk5A,13233
 commands/cat/list_archives.py,sha256=FEZ2XYnQIWo2PztWqnj6unn0pbblPU0-bMbTyI3csv4,5464
 commands/cat/list_assets.py,sha256=bNwSaBDz661hfnc2Rn4j4HPHAugKvz0XwN9L1m4FVQk,6529
 commands/cat/list_cert_types.py,sha256=mbCls_EqC5JKG5rvS4o69k7KgZ6aNXlcqoJ3DtHsTFA,7127
@@ -16,12 +16,12 @@ commands/cat/list_deployed_databases.py,sha256=HE8nG-mIlxa9iSUEH-n71o-G2a4ss1Zza
 commands/cat/list_projects.py,sha256=Jzs-DtIpPhCH-gY4PYT6mnRBWnEf4m18TFfcw8UymNU,8011
 commands/cat/list_relationships.py,sha256=U9f78cOi4HyaacqNaFSMq_7rRxVcEczvwPv468GYw3Q,5869
 commands/cat/list_tech_types.py,sha256=20T4v6L5qeebSsaL1nGkFMDAIsy2W3A3SMm1RcgFoh0,4609
-commands/cat/list_terms.py,sha256=gpjE_Wyzg7WDhh9numPPTiQCiLF6awjGqvpBFaXuRF8,6353
+commands/cat/list_terms.py,sha256=8aS_TwQefU7FCqQiMIuX7BHRAcPRhyKosULEAOLfhyw,6777
 commands/cat/list_todos.py,sha256=iPxHRyW3X5tiREio4TUOwRPvNPjU0gxm3pVnUI79ir4,6542
 commands/cat/list_user_ids.py,sha256=7JinL7rknPbGusIb8ikXKEaV1vvbuvx_WWtbmlfS_DY,5093
 commands/cli/__init__.py,sha256=hpTVSMP2gnPRhcAZPdeUEsQ-eaDySlXlk239dNWYmng,292
-commands/cli/egeria.py,sha256=2TUbDYeKoqU5ihFq2HbHxZjycwiW4rqdpv2ivDQEV6o,31380
-commands/cli/egeria_cat.py,sha256=ED--LsHKn94lxuyv8w46lhfnRNido-hOnbBBgrTwHMc,14915
+commands/cli/egeria.py,sha256=l475S6iix6PlFcry-mOcSa_ne3XDnm1mKuVvgRFQVq0,31429
+commands/cli/egeria_cat.py,sha256=7BSdRFWB5AMQC726fQZIBMEti5s469pA9HJ8mESaTCE,14964
 commands/cli/egeria_my.py,sha256=9zIpUDLeA_R-0rgCSQfEZTtVmkxPcEAsYcCTn1wQFrE,6181
 commands/cli/egeria_ops.py,sha256=fxDXYWXRhexx06PdSLCp2FhgUtS13NdDpyg7ea775fc,11531
 commands/cli/egeria_tech.py,sha256=eTDHTHDVEYmr6gUPGfido_Uf7Fec0Nuyxlkhg4KAMAw,13160
@@ -92,7 +92,7 @@ pyegeria/egeria_tech_client.py,sha256=7NfqpJFft5GR4NPRDVDw22L9caHbXB8fhx0TAf6qEo
 pyegeria/feedback_manager_omvs.py,sha256=B66e3ZCaC_dirb0mcb2Nz3PYh2ZKsoMAYNOb3euNiro,152931
 pyegeria/full_omag_server_config.py,sha256=LBnqUiz1ofBdlKBzECFs_pQbdJwcWigAukWHGJRR2nU,47340
 pyegeria/glossary_browser_omvs.py,sha256=NcitYaZJqwVODBO5zBtWpXPNUJJ3DKzEbRaOFSAyUlg,93554
-pyegeria/glossary_manager_omvs.py,sha256=QOx4OwESPAF4cjrkHsHxGfvyQkJaPbYCzWGEMqfnFFg,116964
+pyegeria/glossary_manager_omvs.py,sha256=s9BxAa2UJk5kinS6-U9H6xKqZUG-lp7aqHdNdStaGLs,126294
 pyegeria/mermaid_utilities.py,sha256=GXiS-subb5nJcDqlThZWX2T8WspU1neFfhf4TxRoMh4,8344
 pyegeria/my_profile_omvs.py,sha256=DyECbUFEcgokrIbzdMMNljC3bqfqKGXAF2wZEpzvRYs,34666
 pyegeria/platform_services.py,sha256=CJIOYIFEbcIGwdWlApAQcXxZTsdrhFtpJcm4O3p7dG0,41646
@@ -104,8 +104,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.11.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-pyegeria-1.5.1.1.11.dist-info/METADATA,sha256=1gGEbsh_40wIn2PEdk8fEwwQQg5UufTbuZjRBN3MUgQ,2998
-pyegeria-1.5.1.1.11.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pyegeria-1.5.1.1.11.dist-info/entry_points.txt,sha256=aSpiaOuOEL1QBfuIGOaATzDCihpVOyvIK1XCQHK3uRc,4186
-pyegeria-1.5.1.1.11.dist-info/RECORD,,
+pyegeria-1.5.1.1.13.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+pyegeria-1.5.1.1.13.dist-info/METADATA,sha256=XRIsf599nDaJ1HzITqEhfrYYvBMqW2tQlxOg9wgkX0w,2998
+pyegeria-1.5.1.1.13.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pyegeria-1.5.1.1.13.dist-info/entry_points.txt,sha256=bmxD0DvBAXMQRU74qf5Jm-lZT6mSonssv_ZFK_uCP2c,4250
+pyegeria-1.5.1.1.13.dist-info/RECORD,,

{pyegeria-1.5.1.1.11.dist-info → pyegeria-1.5.1.1.13.dist-info}/entry_points.txt

@@ -5,6 +5,7 @@ create_term=commands.cat.glossary_actions:create_term
 create_todo=commands.my.todo_actions:create_todo
 delete_glossary=commands.cat.glossary_actions:delete_glossary
 delete_todo=commands.my.todo_actions:delete_todo
+export_terms_to_file=commands.cat.glossary_actions:export_terms
 get_asset_graph=commands.cat.get_asset_graph:main
 get_collection=commands.cat.get_collection:main
 get_element_info=commands.tech.get_element_info:main