Merge branch 'main' of https://github.com/developmentseed/aiopmtiles

Author: vincentsarago

.github/workflows/ci.yml

@@ -31,7 +31,7 @@ jobs:
       - name: Install aiopmtiles
         run: |
           python -m pip install --upgrade pip
-          python -m pip install .["test","aws"]
+          python -m pip install .["test","aws","gcp"]
 
       - name: run pre-commit
         if: ${{ matrix.python-version == env.LATEST_PY_VERSION }}

CONTRIBUTING.md

@@ -7,7 +7,7 @@ Issues and pull requests are more than welcome.
 ```bash
 $ git clone https://github.com/developmentseed/aiopmtiles.git
 $ cd aiopmtiles
-$ python -m pip install -e .["test","dev","aws"]
+$ python -m pip install -e .["test","dev","aws","gcp"]
 ```
 
 You can then run the tests with the following command:

aiopmtiles/io.py

@@ -1,10 +1,9 @@
 """FileSystems for PMTiles Reader."""
 
 import abc
-import os
 from contextlib import AsyncExitStack
 from dataclasses import dataclass, field
-from typing import Any, Dict, Optional
+from typing import Any
 from urllib.parse import urlparse
 
 import aiofiles
@@ -16,6 +15,12 @@
 except ImportError:  # pragma: nocover
     aioboto3 = None  # type: ignore
 
+try:
+    from gcloud.aio.storage import Storage as GcpStorage
+
+except ImportError:  # pragma: nocover
+    GcpStorage = None  # type: ignore
+
 
 @dataclass
 class FileSystem(abc.ABC):
@@ -49,6 +54,9 @@ def create_from_filepath(cls, filepath: str, **kwargs: Any) -> "FileSystem":
         elif parsed.scheme == "s3":
             return S3FileSystem(filepath, **kwargs)
 
+        elif parsed.scheme == "gs":
+            return GcsFileSystem(filepath, **kwargs)
+
         elif parsed.scheme == "file":
             return LocalFileSystem(filepath, **kwargs)
 
@@ -132,3 +140,31 @@ async def __aenter__(self):
         )
         self._obj = await self._resource.Object(parsed.netloc, parsed.path.strip("/"))
         return self
+
+
+@dataclass
+class GcsFileSystem(FileSystem):
+    """GCS filesystem"""
+
+    _client: GcpStorage = field(init=False)
+    _bucket: str = field(init=False)
+    _obj: str = field(init=False)
+
+    def __post_init__(self):
+        """Check for dependency."""
+        assert (
+            GcpStorage is not None
+        ), "'gcloud-aio-storage' must be installed to use GCS FileSystem"
+
+    async def get(self, offset: int, length: int) -> bytes:
+        """Perform a range request"""
+        headers = {"Range": f"bytes={offset}-{offset + length}"}
+        return await self._client.download(self._bucket, self._obj, headers=headers)
+
+    async def __aenter__(self):
+        """Async context management"""
+        parsed_path = urlparse(self.filepath)
+        self._client = await self.ctx.enter_async_context(GcpStorage())
+        self._bucket = parsed_path.netloc
+        self._obj = parsed_path.path.strip("/")
+        return self

docs/docs/usage.md

@@ -29,7 +29,7 @@ async def metadata(url: str = Query(..., description="PMTiles archive URL.")):
     async with Reader(url) as src:
         return await src.metadata()
 
-@spp.get("/tiles/{z}/{x}/{y}", response_class=Response)
+@app.get("/tiles/{z}/{x}/{y}", response_class=Response)
 async def tiles(
     z: int = Path(ge=0, le=30, description="TMS tiles's zoom level"),
     x: int = Path(description="TMS tiles's column"),

pyproject.toml

@@ -28,6 +28,10 @@ dependencies = [
 aws = [
     "aioboto3"
 ]
+gcp = [
+    "gcloud-aio-auth",
+    "gcloud-aio-storage"
+]
 test = [
     "pytest",
     "pytest-cov",
@@ -69,9 +73,9 @@ parallel = true
 
 [tool.coverage.report]
 exclude_lines = [
-  "no cov",
-  "if __name__ == .__main__.:",
-  "if TYPE_CHECKING:",
+    "no cov",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
 ]
 
 [tool.isort]

tests/test_io.py

@@ -4,7 +4,13 @@
 
 import pytest
 
-from aiopmtiles.io import FileSystem, HttpFileSystem, LocalFileSystem, S3FileSystem
+from aiopmtiles.io import (
+    FileSystem,
+    GcsFileSystem,
+    HttpFileSystem,
+    LocalFileSystem,
+    S3FileSystem,
+)
 
 FIXTURES_DIR = os.path.join(os.path.dirname(__file__), "fixtures")
 VECTOR_PMTILES = os.path.join(FIXTURES_DIR, "protomaps(vector)ODbL_firenze.pmtiles")
@@ -16,6 +22,7 @@
         ("myfile.pmtiles", LocalFileSystem),
         ("file:///myfile.pmtiles", LocalFileSystem),
         ("s3://bucket/myfile.pmtiles", S3FileSystem),
+        ("gs://bucket/myfile.pmtiles", GcsFileSystem),
         ("http://url.io/myfile.pmtiles", HttpFileSystem),
         ("https://url.io/myfile.pmtiles", HttpFileSystem),
     ],