File tree Expand file tree Collapse file tree 2 files changed +11
-1
lines changed
Expand file tree Collapse file tree 2 files changed +11
-1
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,11 @@ An asynchronous [PMTiles] reader for Python.
44
55The [ PMTiles format] is a cloud-native, compressed, single-file archive for storing tiled vector and raster map data.
66
7+ This implementation is fully asynchronous and integrates with [ Obstore] and [ Obspec] for efficiently loading data from remote files.
8+
9+ [ Obstore ] : https://developmentseed.org/obstore/latest/
10+ [ Obspec ] : https://developmentseed.org/obspec/latest/
11+
712[ PMTiles ] : https://docs.protomaps.com/
813[ PMTiles format ] : https://docs.protomaps.com/pmtiles/
914
@@ -17,6 +22,8 @@ pip install async-pmtiles
1722
1823## Example
1924
25+ The easiest way to get started is by using [ Obstore] to fetch remote data.
26+
2027``` python
2128from async_pmtiles import PMTilesReader
2229from obstore.store import HTTPStore
Original file line number Diff line number Diff line change @@ -130,7 +130,10 @@ async def metadata(self) -> dict:
130130 return json .loads (metadata )
131131
132132 async def get_tile (self , x : int , y : int , z : int ) -> Buffer | None :
133- """Load data for a specific tile given its x, y, and z coordinates."""
133+ """Load data for a specific tile given its x, y, and z coordinates.
134+
135+ Note that no decompression is applied.
136+ """
134137 tile_id = zxy_to_tileid (z , x , y )
135138
136139 dir_offset = self .header ["root_offset" ]
You can’t perform that action at this time.
0 commit comments