Add Python example to README (#66)

Author: kylebarron

python/README.md

@@ -1,11 +1,86 @@
 # async-tiff
 
-<!-- [![PyPI][pypi_badge]][pypi_link]
+[![PyPI][pypi_badge]][pypi_link]
 
-[pypi_badge]: https://badge.fury.io/py/geoindex-rs.svg
-[pypi_link]: https://pypi.org/project/geoindex-rs/ -->
+[pypi_badge]: https://badge.fury.io/py/async-tiff.svg
+[pypi_link]: https://pypi.org/project/async-tiff/
 
-Fast, async TIFF and GeoTIFF reader for Python.
+Fast, low-level async TIFF and GeoTIFF reader for Python.
 
-<!-- This documentation is for the Python bindings. [Refer here for the Rust crate documentation](https://docs.rs/geo-index). -->
+This documentation is for the Python bindings. [Refer here for the Rust crate documentation](https://docs.rs/async-tiff).
+
+## Examples
+
+### Reading NAIP
+
+```py
+from async_tiff import TIFF
+from async_tiff.store import S3Store
+
+# You'll also need to provide credentials to access a requester pays bucket
+store = S3Store("naip-visualization", region="us-west-2", request_payer=True)
+path = "ny/2022/60cm/rgb/40073/m_4007307_sw_18_060_20220803.tif"
+
+tiff = await TIFF.open(path, store=store, prefetch=32768)
+primary_ifd = tiff.ifds[0]
+
+primary_ifd.geo_key_directory.citation
+# 'NAD83 / UTM zone 18N'
+
+primary_ifd.geo_key_directory.projected_type
+# 26918
+# (EPSG code)
+
+primary_ifd.sample_format
+# [<SampleFormat.Uint: 1>, <SampleFormat.Uint: 1>, <SampleFormat.Uint: 1>]
+
+primary_ifd.bits_per_sample
+# [8, 8, 8]
+
+tile = await tiff.fetch_tile(0, 0, 4)
+decoded_bytes = await tile.decode_async()
+
+# Use rasterio and matplotlib for visualization
+import numpy as np
+from rasterio.plot import reshape_as_raster, show
+
+# Wrap the rust buffer into a numpy array
+arr = np.frombuffer(decoded_bytes, np.uint8)
+
+# We first need to reshape the array into the *existing* "image" axes
+arr = arr.reshape(512, 512, 3)
+
+# Then we need to reshape the "image" axes into "raster" axes
+# https://rasterio.readthedocs.io/en/stable/topics/image_processing.html
+arr = reshape_as_raster(arr)
+show(arr, adjust=True)
+```
+
+![](assets/naip-example.jpg)
+
+
+### Reading Sentinel 2 L2A
+
+```py
+from async_tiff import TIFF
+from async_tiff.store import S3Store
+
+store = S3Store("sentinel-cogs", region="us-west-2", skip_signature=True)
+path = "sentinel-s2-l2a-cogs/12/S/UF/2022/6/S2B_12SUF_20220609_0_L2A/B04.tif"
+
+tiff = await TIFF.open(path, store=store, prefetch=32768)
+primary_ifd = tiff.ifds[0]
+# Text readable citation
+primary_ifd.geo_key_directory.citation
+# EPSG code
+primary_ifd.geo_key_directory.projected_type
+
+primary_ifd.sample_format[0]
+# <SampleFormat.Uint: 1>
+primary_ifd.bits_per_sample[0]
+# 16
+
+tile = await tiff.fetch_tile(0, 0, 0)
+decoded_bytes = await tile.decode_async()
+```
 

python/docs/assets/logo_no_text.png renamed to python/assets/logo_no_text.png

@@ -0,0 +1 @@
+../assets

python/assets/naip-example.jpg

@@ -31,7 +31,7 @@ dev-dependencies = [
     "mkdocstrings-python>=1.13.0",
     "mkdocstrings>=0.27.0",
     "numpy>=1",
-    "obstore",
+    "obstore>=0.5.1",
     "pip>=24.2",
     "pytest-asyncio>=0.24.0",
     "pytest>=8.3.3",

python/docs/assets

@@ -18,7 +18,7 @@ class Tile:
     @property
     def compression_method(self) -> CompressionMethod | int:
         """The compression method used by this tile."""
-    async def decode(
+    async def decode_async(
         self,
         *,
         decoder_registry: DecoderRegistry | None = None,