pyegeria 0.8.1__tar.gz → 0.8.3__tar.gz

{pyegeria-0.8.1 → pyegeria-0.8.3}/PKG-INFO

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

{pyegeria-0.8.1 → pyegeria-0.8.3}/examples/doc_samples/Create_Collection_Sample.py

@@ -11,16 +11,20 @@ import time
 from rich import print
 from rich.console import Console
 
-from pyegeria import CollectionManager, InvalidParameterException, PropertyServerException, UserNotAuthorizedException
+from pyegeria import (
+    CollectionManager,
+    InvalidParameterException,
+    PropertyServerException,
+    UserNotAuthorizedException,
+)
 
-view_server = 'view-server'
-platform_url = 'https://localhost:9443'
-user = 'erinoverview'
+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)
+    c_client = CollectionManager(view_server, platform_url, user_id=user)
 
     token = c_client.create_egeria_bearer_token(user, "secret")
     start_time = time.perf_counter()
@@ -35,10 +39,16 @@ try:
     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)
+    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"
@@ -46,23 +56,35 @@ try:
     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
-                                                )
+    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
-                                                )
+    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
@@ -73,36 +95,36 @@ try:
     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",
+        "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",
             },
-            "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}")
@@ -113,36 +135,36 @@ try:
     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",
+        "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",
             },
-            "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}")
@@ -154,12 +176,18 @@ try:
     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
-                                                )
+    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"
@@ -195,8 +223,8 @@ try:
             "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}")
@@ -235,8 +263,8 @@ try:
             "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}")
@@ -275,8 +303,8 @@ try:
             "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}")
@@ -284,7 +312,7 @@ try:
 except (
     InvalidParameterException,
     PropertyServerException,
-    UserNotAuthorizedException
+    UserNotAuthorizedException,
 ) as e:
     console.print_exception(show_locals=True)
 

pyegeria-0.8.3/examples/doc_samples/Create_Sustainability_Collection_Sample.py

@@ -0,0 +1,149 @@
+"""
+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()

pyegeria-0.8.3/examples/widgets/cat/get_collection.py

@@ -0,0 +1,139 @@
+#!/usr/bin/env python3
+"""
+SPDX-License-Identifier: Apache-2.0
+Copyright Contributors to the ODPi Egeria project.
+
+A simple viewer for collections - provide the root and we display the hierarchy
+
+"""
+
+import argparse
+import os
+from rich import print
+from rich.panel import Panel
+from rich.prompt import Prompt
+from rich.text import Text
+from rich.tree import Tree
+
+from pyegeria import (
+    CollectionManager,
+    UserNotAuthorizedException,
+    PropertyServerException,
+    InvalidParameterException,
+)
+from pyegeria._exceptions import (
+    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 collection_viewer(
+    root: str,
+    server_name: str,
+    platform_url: str,
+    user: str,
+    user_password: str,
+    jupyter: bool = EGERIA_JUPYTER,
+    width: int = EGERIA_WIDTH,
+):
+    """A simple collection viewer"""
+
+    def walk_collection_hierarchy(
+        collection_client: CollectionManager, root_collection_name: str, tree: Tree
+    ) -> None:
+        """Recursively build a Tree with collection contents."""
+        members = collection_client.get_member_list(root_collection_name)
+        if members:
+            for member in members:
+                style = "bold white on black"
+                text_collection_name = Text(
+                    f"[bold white on black]Name: {member['name']}", style=style
+                )
+                text_qualified_name = Text(
+                    f"* QualifiedName: {member['qualifiedName']}"
+                )
+                text_guid = Text(f"* GUID: {member['guid']}", "green")
+                text_collection_type = Text(
+                    f"* Collection Type: {member['collectionType']}"
+                )
+                text_description = Text(f"* Description: {member['description']}")
+                p = Panel.fit(
+                    f"{text_collection_name}[green]\n{text_qualified_name}\n{text_guid}\n"
+                    f"{text_collection_type}\n{text_description}"
+                )
+                tt = tree.add(p, style=style)
+
+                children = collection_client.get_collection_members(member["guid"])
+                if type(children) is list:
+                    branch = tt.add(
+                        f"[bold magenta on black]Members",
+                        style=style,
+                        guide_style=style,
+                    )
+                    walk_collection_hierarchy(
+                        collection_client, member["qualifiedName"], branch
+                    ),
+        else:
+            tt = tree.add(
+                f"[bold magenta on black]No collections match {root_collection_name}"
+            )
+
+    try:
+        tree = Tree(
+            f"[bold bright green on black]{root}", guide_style="bold bright_blue"
+        )
+        c_client = CollectionManager(server_name, platform_url, user_id=user)
+
+        token = c_client.create_egeria_bearer_token(user, user_password)
+        walk_collection_hierarchy(c_client, root, tree)
+        print(tree)
+
+    except (
+        InvalidParameterException,
+        PropertyServerException,
+        UserNotAuthorizedException,
+    ) as e:
+        print_exception_response(e)
+
+
+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:
+        root_collection = Prompt.ask(
+            "Enter the Root Collection to start from:",
+            default="Root Sustainability Collection",
+        )
+        collection_viewer(root_collection, server, url, userid, user_pass)
+    except KeyboardInterrupt:
+        pass
+
+
+if __name__ == "__main__":
+    main()