pyegeria 0.8.4.8__tar.gz → 0.8.4.10__tar.gz

{pyegeria-0.8.4.8 → pyegeria-0.8.4.10}/PKG-INFO

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

{pyegeria-0.8.4.8 → pyegeria-0.8.4.10}/pyegeria/classification_manager_omvs.py

@@ -431,17 +431,159 @@ class ClassificationManager(Client):
         )
         return response
 
+    async def _async_get_element_by_guid(
+        self,
+        element_guid: str,
+        effective_time: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
+    ) -> dict | str:
+        """
+        Retrieve element by its unique identifier.  Async version.
+
+        https://egeria-project.org/types/
+
+        Parameters
+        ----------
+        element_guid: str
+            - unique identifier for the element
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+        for_lineage: bool, default is set by server
+           - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+           - Normally false. Set true when the caller is part of a deduplication function
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        dict | str
+            Returns a string if no elements found; otherwise a dict of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+        if server_name is None:
+            server_name = self.server_name
+
+        possible_query_params = query_string(
+            [
+                ("forLineage", for_lineage),
+                ("forDuplicateProcessing", for_duplicate_processing),
+            ]
+        )
+
+        body = {
+            "class": "EffectiveTimeQueryRequestBody",
+            "effectiveTime": effective_time,
+        }
+
+        url = f"{base_path(self, server_name)}/elements/{element_guid}{possible_query_params}"
+
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body), time_out=time_out
+        )
+
+        elements = response.json().get("elements", "No elements found")
+        if type(elements) is list:
+            if len(elements) == 0:
+                return "No elements found"
+        return elements
+
+    def get_element_by_guid(
+        self,
+        element_guid: str,
+        effective_time: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
+    ) -> dict | str:
+        """
+        Retrieve element by its unique identifier.
+
+        https://egeria-project.org/types/
+
+        Parameters
+        ----------
+        element_guid: str
+            - unique identifier for the element
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
+        for_lineage: bool, default is set by server
+           - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+           - Normally false. Set true when the caller is part of a deduplication function
+        server_name: str, default = None
+            - name of the server instances for this request.
+        time_out: int, default = default_time_out
+            - http request timeout for this request
+
+        Returns
+        -------
+        dict | str
+            Returns a string if no elements found; otherwise a dict of the element.
+
+        Raises
+        ------
+        InvalidParameterException
+            one of the parameters is null or invalid or
+        PropertyServerException
+            There is a problem adding the element properties to the metadata repository or
+        UserNotAuthorizedException
+            the requesting user is not authorized to issue this request.
+        """
+
+        loop = asyncio.get_event_loop()
+        response = loop.run_until_complete(
+            self._async_get_element_by_guid(
+                element_guid,
+                effective_time,
+                for_lineage,
+                for_duplicate_processing,
+                server_name,
+                time_out,
+            )
+        )
+        return response
+
     async def _async_get_guid_for_name(
-        self, name: str, server_name: str = None, time_out: int = default_time_out
+        self,
+        name: str,
+        property_name: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        effective_time: str = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
     ) -> list | str:
         """
-        Retrieve the guid associated with the supplied element name.
+        Retrieve the guid associated with the supplied unique element name.
         If more than one element returned, an exception is thrown. Async version.
 
         Parameters
         ----------
         name: str
             - element name to be searched.
+        property_name: str, optional
+            - optional name of property to search. If not specified, defaults to qualifiedName
+        for_lineage: bool, default is set by server
+            - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+            - Normally false. Set true when the caller is part of a deduplication function
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
         server_name: str, default = None
             - name of the server instances for this request.
         time_out: int, default = default_time_out
@@ -463,11 +605,32 @@ class ClassificationManager(Client):
         """
         if server_name is None:
             server_name = self.server_name
-        property_name = ["name", "qualifiedName", "title"]
-        elements = await self._async_get_elements_by_property_value(
-            name, property_name, None
+        property_name = "qualifiedName" if property_name is None else property_name
+
+        possible_query_params = query_string(
+            [
+                ("forLineage", for_lineage),
+                ("forDuplicateProcessing", for_duplicate_processing),
+            ]
+        )
+
+        body = {
+            "class": "NameRequestBody",
+            "name": name,
+            "forLineage": for_lineage,
+            "forDuplicateProcessing": for_duplicate_processing,
+            "namePropertyName": property_name,
+            "effectiveTime": effective_time,
+        }
+
+        url = f"{base_path(self, server_name)}/elements/guid-by-unique-name{possible_query_params}"
+
+        response: Response = await self._async_make_request(
+            "POST", url, body_slimmer(body), time_out=time_out
         )
 
+        elements = response.json().get("elements", "No elements found")
+
         if type(elements) is list:
             if len(elements) == 0:
                 return "No elements found"
@@ -478,16 +641,31 @@ class ClassificationManager(Client):
         return elements
 
     def get_guid_for_name(
-        self, name: str, server_name: str = None, time_out: int = default_time_out
+        self,
+        name: str,
+        property_name: str = None,
+        for_lineage: bool = None,
+        for_duplicate_processing: bool = None,
+        effective_time: str = None,
+        server_name: str = None,
+        time_out: int = default_time_out,
     ) -> list | str:
         """
-        Retrieve the guid associated with the supplied element name.
+        Retrieve the guid associated with the supplied unique element name.
         If more than one element returned, an exception is thrown.
 
         Parameters
         ----------
         name: str
             - element name to be searched.
+        property_name: str, optional
+            - optional name of property to search. If not specified, defaults to qualifiedName
+        for_lineage: bool, default is set by server
+            - determines if elements classified as Memento should be returned - normally false
+        for_duplicate_processing: bool, default is set by server
+            - Normally false. Set true when the caller is part of a deduplication function
+        effective_time: str, default = None
+            - Time format is "YYYY-MM-DDTHH:MM:SS" (ISO 8601)
         server_name: str, default = None
             - name of the server instances for this request.
         time_out: int, default = default_time_out
@@ -510,7 +688,15 @@ class ClassificationManager(Client):
 
         loop = asyncio.get_event_loop()
         response = loop.run_until_complete(
-            self._async_get_guid_for_name(name, server_name, time_out)
+            self._async_get_guid_for_name(
+                name,
+                property_name,
+                for_lineage,
+                for_duplicate_processing,
+                effective_time,
+                server_name,
+                time_out,
+            )
         )
         return response
 
@@ -4199,7 +4385,7 @@ class ClassificationManager(Client):
         time_out: int = default_time_out,
     ) -> None:
         """
-        Add or replace the security tags for an element. Async versuib,
+        Add or replace the security tags for an element. Async version,
 
         Security Tags: https://egeria-project.org/types/4/0423-Security-Definitions/
 

{pyegeria-0.8.4.8 → pyegeria-0.8.4.10}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pyegeria"
-version = "0.8.4.8"
+version = "0.8.4.10"
 license = 'Apache 2.0'
 authors = ["Dan Wolfson <dan.wolfson@pdr-associates.com>"]
 readme = "README.md"
@@ -18,9 +18,8 @@ packages = [
     { include = "pyegeria"},
     { include = "examples/widgets/cat" },
     { include = "examples/widgets/tech" },
-    { include = "examples/widgets/ops"},
     { include = "examples/widgets/my"},
-    { include = "examples/doc_samples"},
+    { include = "examples/widgets/ops"},
     { include = "examples/widgets/cli"}
     ]
 

pyegeria-0.8.4.8/examples/doc_samples/Create_Collection_Sample.py

@@ -1,320 +0,0 @@
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-
-This sample creates the collection structure show in https://egeria-project.org/types/0/0021-Collections
-
-"""
-
-import time
-
-from rich import print
-from rich.console import Console
-
-from pyegeria import (
-    CollectionManager,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-)
-
-view_server = "view-server"
-platform_url = "https://localhost:9443"
-user = "erinoverview"
-console = Console(width=200)
-
-try:
-    c_client = CollectionManager(view_server, platform_url, user_id=user)
-
-    token = c_client.create_egeria_bearer_token(user, "secret")
-    start_time = time.perf_counter()
-
-    # Create a Data Products Root collection
-    anchor_guid = None
-    parent_guid = None
-    parent_relationship_type_name = None
-    parent_at_end1 = False
-    display_name = "Digital Products Root"
-    description = "This is the root catalog for digital products"
-    collection_type = "Digital Products Root"
-    is_own_anchor = True
-
-    response = c_client.create_root_collection(
-        anchor_guid,
-        parent_guid,
-        parent_relationship_type_name,
-        parent_at_end1,
-        display_name,
-        description,
-        collection_type,
-        is_own_anchor,
-    )
-    # Create first folder for Agriculture Insights
-    parent_guid = response
-    parent_relationship_type_name = "CollectionMembership"
-    display_name = "Agriculture Insights Collection"
-    description = "A folder for agricultural insights data product collections"
-    collection_type = "Digital Product Marketplace"
-
-    folder1 = c_client.create_folder_collection(
-        None,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        True,
-        "DATE_CREATED",
-        None,
-    )
-    print(f"\n\n created a folder with guid {folder1}")
-    # create second folder for Earth Observations
-    display_name = "Earth Observation Data Collection"
-    description = "A folder for Earth Observation data product collections"
-
-    folder2 = c_client.create_folder_collection(
-        None,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        True,
-        "DATE_CREATED",
-        None,
-    )
-    print(f"\n\n created a folder with guid {folder2}")
-
-    # create a digital product, child of folder 1, for Land Use products
-    parent_guid = folder1
-    parent_relationship_type_name = "CollectionMembership"
-    display_name = "Land Use Classification"
-    description = "Land use classification assets"
-    collection_type = "Digital Product"
-    classification_name = "Digital Product"
-    body_3 = {
-        "class": "NewDigitalProductRequestBody",
-        "isOwnAnchor": True,
-        "parentGUID": parent_guid,
-        "parentRelationshipTypeName": parent_relationship_type_name,
-        "parentAtEnd1": True,
-        "collectionProperties": {
-            "class": "CollectionProperties",
-            "qualifiedName": f"{classification_name}-{display_name}-{time.asctime()}",
-            "name": display_name,
-            "description": description,
-            "collectionType": collection_type,
-            "collectionOrdering": "DATE_CREATED",
-        },
-        "digitalProductProperties": {
-            "class": "DigitalProductProperties",
-            "productStatus": "ACTIVE",
-            "productName": "Land Use Classifications",
-            "productType": "Geospatial Data Assets",
-            "description": "Land use classification assets",
-            "introductionDate": "2023-12-01",
-            "maturity": "Nacent",
-            "serviceLife": "3 years",
-            "currentVersion": "V.5",
-            "nextVersionDate": "2024-12-01",
-            "withdrawDate": "2030-01-01",
-            "additionalProperties": {
-                "thought_id": "a guid",
-                "license": "cc-by-sa",
-            },
-        },
-    }
-    folder3 = c_client.create_digital_product(body_3)
-    print(f"\n\n created a collection with guid {folder3}")
-
-    # create a fourth collection, a digital product, child of folder 2, for Landsat 8
-    parent_guid = folder2
-    display_name = "Landsat 8"
-    description = "Landsat 8 data products"
-
-    body_4 = {
-        "class": "NewDigitalProductRequestBody",
-        "isOwnAnchor": True,
-        "parentGUID": parent_guid,
-        "parentRelationshipTypeName": parent_relationship_type_name,
-        "parentAtEnd1": True,
-        "collectionProperties": {
-            "class": "CollectionProperties",
-            "qualifiedName": f"{classification_name}-{display_name}-{time.asctime()}",
-            "name": display_name,
-            "description": description,
-            "collectionType": collection_type,
-            "collectionOrdering": "DATE_CREATED",
-        },
-        "digitalProductProperties": {
-            "class": "DigitalProductProperties",
-            "productStatus": "ACTIVE",
-            "productName": "Landsat 8 Imagery",
-            "productType": "Geospatial Data Assets",
-            "description": description,
-            "introductionDate": "2024-01-01",
-            "maturity": "Mature",
-            "serviceLife": "3 years",
-            "currentVersion": "V1.5",
-            "nextVersion": "2024-06-01",
-            "withdrawDate": "2030-01-01",
-            "additionalProperties": {
-                "thought_id": "a guid",
-                "license": "cc-by-sa",
-            },
-        },
-    }
-    folder4 = c_client.create_digital_product(body_4)
-    print(f"\n\n created a collection with guid {folder4}")
-
-    # Now create a 5th collection for sentinel 2 data
-    parent_guid = folder2
-    display_name = "Sentinel 2"
-    description = "Sentinel 2 products"
-    parent_relationship_type_name = "CollectionMembership"
-    collection_type = "Digital Product Marketplace"
-
-    folder5 = c_client.create_folder_collection(
-        None,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        True,
-        "DATE_CREATED",
-        None,
-    )
-    # Create a DigitalProduct for Level-1B
-    parent_guid = folder5
-    display_name = "Sentinel 2 - Level 1B"
-    description = "Level 1B of Sentinel 2"
-
-    body_6 = {
-        "class": "NewDigitalProductRequestBody",
-        "anchor_guid": parent_guid,
-        "isOwnAnchor": False,
-        "parentGUID": parent_guid,
-        "parentRelationshipTypeName": parent_relationship_type_name,
-        "parentAtEnd1": True,
-        "collectionProperties": {
-            "class": "CollectionProperties",
-            "qualifiedName": f"{classification_name}-{display_name}-{time.asctime()}",
-            "name": display_name,
-            "description": description,
-            "collectionType": collection_type,
-            "collectionOrdering": "DATE_CREATED",
-        },
-        "digitalProductProperties": {
-            "class": "DigitalProductProperties",
-            "productStatus": "ACTIVE",
-            "productName": "Sentinel 2 - Level 1B",
-            "productType": "Geospatial Data Assets",
-            "description": description,
-            "introductionDate": "2024-01-01",
-            "maturity": "Mature",
-            "serviceLife": "3 years",
-            "currentVersion": "V1.5",
-            "nextVersion": "2024-06-01",
-            "withdrawDate": "2030-01-01",
-            "additionalProperties": {
-                "thought_id": "a guid",
-                "license": "cc-by-sa",
-            },
-        },
-    }
-    folder6 = c_client.create_digital_product(body_6)
-    print(f"\n\n created a collection with guid {folder6}")
-
-    # now lets create a digital product for - Level - 1c
-    parent_guid = folder5
-    display_name = "Sentinel 2 - Level 1C"
-    description = "Level 1C of Sentinel 2"
-    body_7 = {
-        "class": "NewDigitalProductRequestBody",
-        "anchor_guid": parent_guid,
-        "isOwnAnchor": False,
-        "parentGUID": parent_guid,
-        "parentRelationshipTypeName": parent_relationship_type_name,
-        "parentAtEnd1": True,
-        "collectionProperties": {
-            "class": "CollectionProperties",
-            "qualifiedName": f"{classification_name}-{display_name}-{time.asctime()}",
-            "name": display_name,
-            "description": description,
-            "collectionType": collection_type,
-            "collectionOrdering": "DATE_CREATED",
-        },
-        "digitalProductProperties": {
-            "class": "DigitalProductProperties",
-            "productStatus": "ACTIVE",
-            "productName": "Sentinel 2 - Level 1B",
-            "productType": "Geospatial Data Assets",
-            "description": description,
-            "introductionDate": "2024-01-01",
-            "maturity": "Mature",
-            "serviceLife": "3 years",
-            "currentVersion": "V1.5",
-            "nextVersion": "2024-06-01",
-            "withdrawDate": "2030-01-01",
-            "additionalProperties": {
-                "thought_id": "a guid",
-                "license": "cc-by-sa",
-            },
-        },
-    }
-    folder7 = c_client.create_digital_product(body_7)
-    print(f"\n\n created a collection with guid {folder7}")
-
-    # now let's create a digital product for - Level - 2A
-    parent_guid = folder5
-    display_name = "Sentinel 2 - Level 2A"
-    description = "Level 2A of Sentinel 2"
-    body_8 = {
-        "class": "NewDigitalProductRequestBody",
-        "anchor_guid": parent_guid,
-        "isOwnAnchor": False,
-        "parentGUID": parent_guid,
-        "parentRelationshipTypeName": parent_relationship_type_name,
-        "parentAtEnd1": True,
-        "collectionProperties": {
-            "class": "CollectionProperties",
-            "qualifiedName": f"{classification_name}-{display_name}-{time.asctime()}",
-            "name": display_name,
-            "description": description,
-            "collectionType": collection_type,
-            "collectionOrdering": "DATE_CREATED",
-        },
-        "digitalProductProperties": {
-            "class": "DigitalProductProperties",
-            "productStatus": "ACTIVE",
-            "productName": "Sentinel 2 - Level 1B",
-            "productType": "Geospatial Data Assets",
-            "description": description,
-            "introductionDate": "2024-01-01",
-            "maturity": "Mature",
-            "serviceLife": "3 years",
-            "currentVersion": "V1.5",
-            "nextVersion": "2024-06-01",
-            "withdrawDate": "2030-01-01",
-            "additionalProperties": {
-                "thought_id": "a guid",
-                "license": "cc-by-sa",
-            },
-        },
-    }
-    folder8 = c_client.create_digital_product(body_8)
-    print(f"\n\n created a collection with guid {folder8}")
-
-except (
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-) as e:
-    console.print_exception(show_locals=True)
-
-finally:
-    c_client.close_session()

pyegeria-0.8.4.8/examples/doc_samples/Create_Sustainability_Collection_Sample.py

@@ -1,149 +0,0 @@
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-
-This sample creates a collection structure for a sustainability reporting project. It is
-simplistic but shows how we can set up a collection hierarchy that can hold different kinds of
-assets.
-
-"""
-
-import time
-
-from rich import print
-from rich.console import Console
-
-from pyegeria import (
-    CollectionManager,
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-)
-
-view_server = "view-server"
-platform_url = "https://localhost:9443"
-user = "erinoverview"
-console = Console()
-
-try:
-    c_client = CollectionManager(view_server, platform_url, user_id=user)
-
-    token = c_client.create_egeria_bearer_token(user, "secret")
-    start_time = time.perf_counter()
-
-    # Create a root collection for the sustainability project
-    parent_guid = None
-    parent_relationship_type_name = None
-    display_name = "Root Sustainability Collection"
-    description = "The root collection for our sustainability reporting project."
-    collection_type = "Sustainability Collection"
-
-    root = c_client.create_root_collection(
-        None,
-        parent_guid,
-        parent_relationship_type_name,
-        False,
-        display_name,
-        description,
-        collection_type,
-        True,
-    )
-    print(f"\n\n created a root with guid {root}")
-    # create a folder for Scope 1 Emissions
-    anchor_guid = root
-    parent_guid = root
-    parent_relationship_type_name = "CollectionMembership"
-    display_name = "Scope 1 Emissions"
-    description = "A folder for information about scope 1 emissions."
-    collection_type = "Sustainability Collection"
-
-    scope1_folder = c_client.create_folder_collection(
-        anchor_guid,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        False,
-        "DATE_CREATED",
-        None,
-    )
-    print(f"\n\n created scope1_folder with guid {scope1_folder}")
-
-    # create a folder for Scope 2 Emissions.
-    anchor_guid = root
-    parent_guid = root
-    parent_relationship_type_name = "CollectionMembership"
-    display_name = "Scope 2 Emissions"
-    description = "A folder for information about scope 2 emissions."
-    collection_type = "Sustainability Collection"
-
-    scope2_folder = c_client.create_folder_collection(
-        anchor_guid,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        False,
-        "DATE_CREATED",
-        None,
-    )
-    print(f"\n\n created scope2_folder with guid {scope2_folder}")
-
-    # create a folder for Scope 3 Emissions.
-    anchor_guid = root
-    parent_guid = root
-    parent_relationship_type_name = "CollectionMembership"
-    display_name = "Scope 3 Emissions"
-    description = "A folder for information about scope 3 emissions."
-    collection_type = "Sustainability Collection"
-
-    scope3_folder = c_client.create_folder_collection(
-        anchor_guid,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        False,
-        "DATE_CREATED",
-        None,
-    )
-    print(f"\n\n created scope3_folder with guid {scope3_folder}")
-
-    # create a folder for Business Travel Emissions.
-    anchor_guid = root
-    parent_guid = scope3_folder
-    parent_relationship_type_name = "CollectionMembership"
-    display_name = "Business Travel Emissions"
-    description = "A folder for information about scope 3 business travel emissions."
-    collection_type = "Sustainability Collection"
-
-    travel_folder = c_client.create_folder_collection(
-        anchor_guid,
-        parent_guid,
-        parent_relationship_type_name,
-        True,
-        display_name,
-        description,
-        collection_type,
-        False,
-        "DATE_CREATED",
-        None,
-    )
-    print(f"\n\n created travel_folder with guid {travel_folder}")
-
-
-except (
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-) as e:
-    console.print_exception(show_locals=True)
-
-finally:
-    c_client.close_session()