docs: add store example (#128)

Author: gadomski

docs/examples/example_store.py

@@ -0,0 +1,45 @@
+# type: ignore
+"""
+# Using object storage
+
+[obstore](https://github.com/developmentseed/obstore) is a new, powerful Python library for getting from and putting to object storage.
+**rustac** can use anything that implements [obstore.store.ObjectStore][], and also provides its own zero-dependency version in **rustac.store**.
+"""
+
+# %%
+# ## Using **rustac.store**.
+
+import contextily
+import pandas
+import rustac
+from rustac.store import HTTPStore
+from geopandas import GeoDataFrame
+
+store = HTTPStore("https://raw.githubusercontent.com/stac-utils/rustac-py/refs/heads/main/data")
+items = await rustac.read("100-sentinel-2-items.parquet", store=store)
+print(len(items["features"]))
+
+data_frame = GeoDataFrame.from_features(items)
+data_frame["datetime"] = pandas.to_datetime(data_frame["datetime"])
+axis = data_frame.set_crs(epsg=4326).to_crs(epsg=3857).plot(alpha=0.5, edgecolor="k")
+contextily.add_basemap(axis, source=contextily.providers.CartoDB.Positron)
+axis.set_axis_off()
+
+
+# %%
+# There's a [whole set][rustac.store.ObjectStore] of provided object storage backends.
+# See <https://developmentseed.org/obstore/latest/authentication/> for how you might configure authenticate with those backends.
+
+# %%
+# ## Using **obstore.store.ObjectStore**.
+#
+# If you're doing work with **obstore** directly, you can re-use the same `ObjectStore`.
+
+from obstore.store import HTTPStore
+
+store = HTTPStore("https://raw.githubusercontent.com/stac-utils/rustac-py/refs/heads/main/data")
+items = await rustac.read("100-sentinel-2-items.parquet", store=store)
+
+# Notice how there's a warning?
+# That's because we have to copy the `ObjectStore` when we pass it in to **rustac**.
+# This means it can be a bit more efficient to use `rustac.store` if you're only working with **rustac**.

pyproject.toml

@@ -77,6 +77,7 @@ docs = [
     "mkdocs-gallery>=0.10.4",
     "mkdocs-material[imaging]>=9.5.45",
     "mkdocstrings[python]>=0.27.0",
+    "obstore>=0.6.0",
     "pystac-client>=0.8.5",
 ]