--wip-- [skip ci]

Author: gadomski

Cargo.lock

@@ -25,6 +25,9 @@ dependencies = []
 
 [project.optional-dependencies]
 arrow = ["arro3-core>=0.4.5"]
+docs = [
+    "jinja2>=3.1.4",
+]
 
 [project.scripts]
 stacrs = "stacrs:main"

docs/example.ipynb

@@ -2,7 +2,7 @@ use crate::Result;
 use pyo3::{
     exceptions::PyException,
     prelude::*,
-    types::{PyDict, PyList},
+    types::{PyCapsule, PyDict, PyList},
     IntoPyObjectExt,
 };
 use pyo3_arrow::PyTable;
@@ -134,3 +134,9 @@ impl DuckdbClient {
         Ok(collections)
     }
 }
+
+// TODO this probably should live in a different mod
+#[pyfunction]
+pub fn from_arrow(table: &Bound<PyCapsule>) -> () {
+    todo!()
+}

pyproject.toml

@@ -24,6 +24,7 @@ fn stacrs(py: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(migrate::migrate, m)?)?;
     m.add_function(wrap_pyfunction!(migrate::migrate_href, m)?)?;
     m.add_function(wrap_pyfunction!(read::read, m)?)?;
+    m.add_function(wrap_pyfunction!(duckdb::from_arrow, m)?)?;
     m.add_function(wrap_pyfunction!(search::search, m)?)?;
     m.add_function(wrap_pyfunction!(search::search_to, m)?)?;
     m.add_function(wrap_pyfunction!(version::version, m)?)?;

src/duckdb.rs

@@ -212,6 +212,21 @@ async def read(
         >>> item = await stacrs.read("item.json")
     """
 
+async def from_arrow(
+    table: arro3.core.Table,
+) -> dict[str, Any]:
+    """
+    Converts an [arrow3.core.table][] to a STAC item collection.
+
+    Requires **stacrs** to be installed with the `arrow` extra.
+
+    Args:
+        table: The table
+
+    Returns:
+        dict[str, Any]: The STAC item collection
+    """
+
 async def search(
     href: str,
     *,

src/lib.rs

@@ -1,4 +1,5 @@
 import pytest
+import stacrs
 from geopandas import GeoDataFrame
 from stacrs import DuckdbClient
 
@@ -45,3 +46,6 @@ def test_search_to_arrow(client: DuckdbClient) -> None:
     table = client.search_to_arrow("data/100-sentinel-2-items.parquet")
     data_frame = GeoDataFrame.from_arrow(table)
     assert len(data_frame) == 100
+    table = data_frame.to_arrow()
+    item_collection = stacrs.from_arrow(table)
+    assert len(item_collection["features"]) == 100