evo-objects 0.2.0__tar.gz → 0.2.1__tar.gz

{evo_objects-0.2.0 → evo_objects-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evo-objects
-Version: 0.2.0
+Version: 0.2.1
 Summary: Python SDK for using the Seequent Evo Geoscience Object API
 Project-URL: Source, https://github.com/SeequentEvo/evo-python-sdk
 Project-URL: Tracker, https://github.com/SeequentEvo/evo-python-sdk/issues
@@ -23,7 +23,7 @@ Description-Content-Type: text/markdown
 <p align="center"><a href="https://seequent.com" target="_blank"><picture><source media="(prefers-color-scheme: dark)" srcset="https://developer.seequent.com/img/seequent-logo-dark.svg" alt="Seequent logo" width="400" /><img src="https://developer.seequent.com/img/seequent-logo.svg" alt="Seequent logo" width="400" /></picture></a></p>
 <p align="center">
     <a href="https://pypi.org/project/evo-objects/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/evo-objects" /></a>
-    <a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/on-push.yaml/badge.svg" alt="" /></a>
+    <a href="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/run-all-tests.yaml"><img src="https://github.com/SeequentEvo/evo-python-sdk/actions/workflows/run-all-tests.yaml/badge.svg" alt="" /></a>
 </p>
 <p align="center">
     <a href="https://developer.seequent.com/" target="_blank">Seequent Developer Portal</a>
@@ -36,23 +36,67 @@ Description-Content-Type: text/markdown
 The Geoscience Object API is Seequent's next-generation cloud offering for geoscience
 data, empowering our users to build responsive modern workflows. 
 
+## Pre-requisites
+
+* Python ^3.10
+* An [application registered in Bentley](https://developer.bentley.com/register/?product=seequent-evo)
+
 ## Installation
 
-```
+```shell
 pip install evo-objects
 ```
 
 ## Usage
 
-See the [Getting started guide](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/evo-objects/docs/quickstart.md) to learn how to use this library.
+See [the evo-sdk-common documentation](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-sdk-common/README.md)
+for information on how to authenticate, then select the organisation, hub and workspace that you would like to use.
+
+### Interacting with the Geoscience Object API
+
+To get up and running quickly with the Evo Objects SDK, start by configuring your
+[environment and API connector](https://github.com/SeequentEvo/evo-python-sdk/blob/main/packages/evo-sdk-common/docs/quickstart.md).
+
+```python
+from evo.objects import ObjectAPIClient
 
+service_client = ObjectAPIClient(environment, connector)
+service_health = await service_client.get_service_health()
+service_health.raise_for_status()
 
+# The data client is an optional utility that provides helpers for uploading and downloading
+# parquet data via pyarrow.Table objects.
+data_client = service_client.get_data_client(manager.cache)
+...
+```
+
+Listing objects is simple, just call the `ObjectAPIClient.list_objects()` method.
+
+```python
+offset = 0
+while True:
+    page = await service_client.list_objects(offset=offset, limit=10)
+    if offset == 0:
+        print(f"Found {page.total} object{'' if page.total == 1 else 's'}")
+    for object in page:
+        print(f"{object.path}: <{object.schema_id}> ({object.id})")
+
+    if page.is_last:
+        break
+    else:
+        offset = page.next_offset
+```
 
-## Developing the library
+You can also get a list of all objects. Internally, this recursively calls the `list_objects()` method until all objects are fetched.
+
+Check out the other methods on the `ObjectAPIClient` for more details on how to upload and download objects, or get object versions.
+
+## Contributing
 
 For instructions on contributing to the development of this library, please refer to the [evo-python-sdk documentation](https://github.com/seequentevo/evo-python-sdk).
 
 ## License
+
 The Python SDK for Evo is open source and licensed under the [Apache 2.0 license.](https://github.com/SeequentEvo/evo-python-sdk/tree/main/packages/evo-objects/./LICENSE.md).
 
 Copyright © 2025 Bentley Systems, Incorporated.

{evo_objects-0.2.0 → evo_objects-0.2.1}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 name = "evo-objects"
 description = "Python SDK for using the Seequent Evo Geoscience Object API"
-version = "0.2.0"
+version = "0.2.1"
 requires-python = ">=3.10"
 license-files = ["LICENSE.md"]
 dynamic = ["readme"]