pyegeria 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

examples/doc_samples/Create_Collection_Sample.py

@@ -0,0 +1,292 @@
+"""
+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()
+
+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 = "97bbfe07-6696-4550-bf8b-6b577d25bef0"
+    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()

examples/doc_samples/Create_Sustainability_Collection_Sample.py

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

examples/widgets/catalog_user/__init__.py

@@ -1,10 +0,0 @@
-"""
-SPDX-License-Identifier: Apache-2.0
-Copyright Contributors to the ODPi Egeria project.
-
-catalog user widgets
-"""
-import list_assets
-import view_asset_graph
-import view_glossary
-import view_collection

examples/widgets/catalog_user/list_assets.py

@@ -118,7 +118,7 @@ def display_assets(search_string: str, guid: str=None, server: str = good_server
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
 
-if __name__ == "__main__":
+def main():
     sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -135,4 +135,7 @@ if __name__ == "__main__":
     guid = sus_guid  if args.sustainability else None
 
     search_string = Prompt.ask("Enter the asset you are searching for:", default="*")
-    display_assets(search_string, guid,server, url, userid)
+    display_assets(search_string, guid,server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/catalog_user/view_asset_graph.py

@@ -40,7 +40,7 @@ guid_list = []
 
 def asset_viewer(asset_guid: str, server_name:str, platform_url:str, user:str):
 
-    def build_classifications(classification: dict) -> str:
+    def build_classifications(classification: dict) -> Markdown:
 
         class_md = ""
         for c in classification:
@@ -49,7 +49,7 @@ def asset_viewer(asset_guid: str, server_name:str, platform_url:str, user:str):
                 continue
             class_md += f"* Classification: {c_type}\n"
             class_props = c.get("classificationProperties","---")
-            if type(class_props) is dict:
+            if type(class_props) is list:
                 for prop in class_props.keys():
                     class_md += f"\t* {prop}: {class_props[prop]}\n"
         if class_md == "":
@@ -125,6 +125,7 @@ def asset_viewer(asset_guid: str, server_name:str, platform_url:str, user:str):
         asset_relationships = asset_graph["relationships"]
         asset_class_md = build_classifications(asset_classifications)
 
+
         asset_properties = asset_graph["extendedProperties"]
         prop_md = "\n* Extended Properties:\n"
         for prop in asset_properties:
@@ -189,24 +190,24 @@ def asset_viewer(asset_guid: str, server_name:str, platform_url:str, user:str):
                     f"* Created by: {relationship_created_by} at time {relationship_creation_time}\n"
                 )
                 rel_end1_md = (
-                    f"\n**End1:**\n"
-                    f"\n\t* Type: {rel_end1_type}\n"
+                    f"* End1:\n"
+                    f"\t* Type: {rel_end1_type}\n"
                     f"\t* GUID: {rel_end1_guid}\n"
                     f"\t* Unique Name: {rel_end1_unique_name}\n"
                     )
 
-                # if rel_end1_class_md is not None:
-                #     rel_end1_md =  rel_end1_md + rel_end1_class_md
+                if rel_end1_class_md is not None:
+                    rel_end1_md = rel_end1_class_md + rel_end1_md
 
                 rel_end2_md = (
-                    f"\n**End2:**\n"
-                    f"\n\t* Type: {rel_end2_type}\n"
+                    f"* End2:\n"
+                    f"\t* Type: {rel_end2_type}\n"
                     f"\t* GUID: {rel_end2_guid}\n"
                     f"\t* Unique Name: {rel_end2_unique_name}\n"
                 )
 
-                # if rel_end2_class_md is not None:
-                #     rel_end1_md = rel_end1_md + rel_end2_class_md
+                if rel_end2_class_md is not None:
+                    rel_end1_md = rel_end2_class_md + rel_end1_md
                 #
                 # for prop in relationship_properties.keys():
                 #     relationship_md += f"* {prop}: {relationship_properties[prop]}\n"
@@ -228,7 +229,7 @@ def asset_viewer(asset_guid: str, server_name:str, platform_url:str, user:str):
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -242,3 +243,6 @@ if __name__ == "__main__":
 
     asset_guid = Prompt.ask("Enter the Asset GUID to view:", default="8e35b39e-6ee7-4d60-aff5-4b09406c5e79")
     asset_viewer(asset_guid,server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/catalog_user/view_collection.py

@@ -63,7 +63,7 @@ def collection_viewer(root: str, server_name: str, platform_url: str, user: str)
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -77,3 +77,6 @@ if __name__ == "__main__":
 
     root_collection = Prompt.ask("Enter the Root Collection to start from:", default="Digital Products Root")
     collection_viewer(root_collection, server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/catalog_user/view_glossary.py

@@ -115,7 +115,7 @@ def display_glossary_terms(search_string: str, guid: str=None, server: str = goo
         print_exception_response(e)
         assert e.related_http_code != "200", "Invalid parameters"
 
-if __name__ == "__main__":
+def main():
     sus_guid = "f9b78b26-6025-43fa-9299-a905cc6d1575"
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -132,4 +132,7 @@ if __name__ == "__main__":
     guid = sus_guid  if args.sustainability else None
 
     search_string = Prompt.ask("Enter the term you are searching for:", default="*")
-    display_glossary_terms(search_string, guid,server, url, userid)
+    display_glossary_terms(search_string, guid,server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/developer/get_guid_info.py

@@ -11,17 +11,13 @@ A simple display for glossary terms
 """
 
 import argparse
-import httpx
 import json
-import time
 
-from rich import box
 from rich import print
 from rich.console import Console
 from rich.prompt import Prompt
 from rich.text import Text
 from rich.tree import Tree
-from rich.json import JSON
 
 from pyegeria import (
     InvalidParameterException,
@@ -30,7 +26,6 @@ from pyegeria import (
     print_exception_response,
     Client
 )
-from pyegeria import ProjectManager
 
 
 def display_guid(guid: str, server: str, url: str, username: str):
@@ -67,7 +62,7 @@ def display_guid(guid: str, server: str, url: str, username: str):
         else:
             print_exception_response(e)
 
-if __name__ == "__main__":
+def main():
 
     parser = argparse.ArgumentParser()
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -83,4 +78,7 @@ if __name__ == "__main__":
 
     guid = Prompt.ask("Enter the GUID to retrieve:", default=None)
 
-    display_guid(guid, server, url, userid)
+    display_guid(guid, server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/developer/get_tech_details.py

@@ -7,33 +7,19 @@ A simple viewer for collections - provide the root and we display the hierarchy
 
 """
 
-import time
 import argparse
 
-from rich.box import Box
-from rich.markdown import Markdown
+from rich import print
+from rich.panel import Panel
 from rich.prompt import Prompt
-
-from pyegeria._exceptions import (
-    InvalidParameterException,
-    PropertyServerException,
-    UserNotAuthorizedException,
-    print_exception_response,
-)
-from rich.table import Table
-from rich.live import Live
 from rich.text import Text
 from rich.tree import Tree
-from rich.markdown import Markdown
 
-from rich import print
-from rich.console import Group
-from rich.panel import Panel
-from rich import box, align
-from rich.layout import Layout
-import rich
-from pyegeria import (CollectionManager, UserNotAuthorizedException, PropertyServerException,
+from pyegeria import (UserNotAuthorizedException, PropertyServerException,
                       InvalidParameterException, AutomatedCuration)
+from pyegeria._exceptions import (
+    print_exception_response,
+)
 
 disable_ssl_warnings = True
 
@@ -95,7 +81,7 @@ def tech_viewer(tech: str, server_name:str, platform_url:str, user:str):
         print_exception_response(e)
 
 
-if __name__ == "__main__":
+def main():
     parser = argparse.ArgumentParser()
 
     parser.add_argument("--server", help="Name of the server to display status for")
@@ -109,3 +95,6 @@ if __name__ == "__main__":
 
     tech = Prompt.ask("Enter the Technology to start from:", default="PostgreSQL Server")
     tech_viewer(tech,server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/developer/list_asset_types.py

@@ -74,7 +74,7 @@ def display_asset_types(server: str, url: str, username: str):
         r_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -89,3 +89,6 @@ if __name__ == "__main__":
     guid = None
 
     display_asset_types(server, url, userid)
+
+if __name__ == "__main__":
+    main()

examples/widgets/developer/list_registered_services.py

@@ -116,7 +116,7 @@ def display_registered_svcs(service: str, server: str , url: str,
         a_client.close_session()
 
 
-if __name__ == "__main__":
+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")
@@ -133,3 +133,6 @@ if __name__ == "__main__":
     svc_kind = Prompt.ask("Enter the service type you are searching for:", default="all")
 
     display_registered_svcs(svc_kind, server, url, userid, password=password)
+
+if __name__ == "__main__":
+    main()