init

Author: vincentsarago

.circleci/config.yml

@@ -0,0 +1,85 @@
+version: 2
+common: &common
+  working_directory: ~/rio-tiler-mvt
+  steps:
+    - checkout
+    - run:
+        name: install dependencies
+        command: pip install tox codecov pre-commit --user
+    - run:
+        name: run tox
+        command: ~/.local/bin/tox
+    - run:
+        name: run pre-commit
+        command: |
+          if [[ "$CIRCLE_JOB" == "python-3.6" ]]; then
+             ~/.local/bin/pre-commit run --all-files
+          fi
+    - run:
+        name: upload coverage report
+        command: |
+          if [[ "$UPLOAD_COVERAGE" == 1 ]]; then
+             ~/.local/bin/coverage xml
+             ~/.local/bin/codecov
+          fi
+        when: always
+
+jobs:
+  "python-3.6":
+    <<: *common
+    docker:
+      - image: circleci/python:3.6.5
+        environment:
+          - TOXENV=py36
+          - UPLOAD_COVERAGE=1
+
+  "python-3.7":
+    <<: *common
+    docker:
+      - image: circleci/python:3.7.2
+        environment:
+          - TOXENV=py37
+
+  deploy:
+      docker:
+        - image: circleci/python:3.7.2
+          environment:
+            - TOXENV=release
+      working_directory: ~/rio-tiler-mvt
+      steps:
+        - checkout
+        - run:
+            name: verify git tag vs. version
+            command: |
+              VERSION=$(python -c 'import rio_tiler_mvt; print(rio_tiler_mvt.version)')
+              if [ "$VERSION" = "$CIRCLE_TAG" ]; then exit 0; else exit 3; fi
+        - run:
+            name: install dependencies
+            command: pip install tox --user
+        - run:
+            name: init .pypirc
+            command: |
+              echo -e "[pypi]" >> ~/.pypirc
+              echo -e "username = $PYPI_USER" >> ~/.pypirc
+              echo -e "password = $PYPI_PASSWORD" >> ~/.pypirc
+        - run:
+            name: run tox
+            command: ~/.local/bin/tox
+
+workflows:
+  version: 2
+  build_and_deploy:
+    jobs:
+      - "python-3.6"
+      - "python-3.7":
+          filters:  # required since `deploy` has tag filters AND requires `build`
+            tags:
+              only: /.*/
+      - deploy:
+          requires:
+            - "python-3.7"
+          filters:
+            tags:
+              only: /^[0-9]+.*/
+            branches:
+              ignore: /.*/

.gitignore

@@ -102,3 +102,5 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+rio_tiler_mvt/mvt.c

.pre-commit-config.yaml

@@ -0,0 +1,34 @@
+
+repos:
+    -
+        repo: 'https://github.com/ambv/black'
+        # 18.6b1
+        rev: ed50737290662f6ef4016a7ea44da78ee1eff1e2
+        hooks:
+            - id: black
+              args: ['--safe']
+              language_version: python3.6
+    -
+        repo: 'https://github.com/pre-commit/pre-commit-hooks'
+        # v1.3.0
+        rev: a6209d8d4f97a09b61855ea3f1fb250f55147b8b
+        hooks:
+            - id: flake8
+              language_version: python3.6
+              args: [
+                  # E501 let black handle all line length decisions
+                  # W503 black conflicts with "line break before operator" rule
+                  # E203 black conflicts with "whitespace before ':'" rule
+                  '--ignore=E501,W503,E203']
+    -
+        repo: 'https://github.com/chewse/pre-commit-mirrors-pydocstyle'
+        # 2.1.1
+        rev: 22d3ccf6cf91ffce3b16caa946c155778f0cb20f
+        hooks:
+            - id: pydocstyle
+              language_version: python3.6
+              args: [
+                 # Check for docstring presence only
+                 '--select=D1',
+                 # Don't require docstrings for tests
+                 '--match=(?!test).*\.py']

README.md

@@ -1,2 +1,71 @@
 # rio-tiler-mvt
+
+[![Packaging status](https://badge.fury.io/py/rio-tiler-mvt.svg)](https://badge.fury.io/py/rio-tiler-mvt)
+[![CircleCI](https://circleci.com/gh/cogeotiff/rio-tiler-mvt.svg?style=svg)](https://codecov.io/gh/cogeotiff/rio-tiler-mvt)
+[![codecov](https://codecov.io/gh/cogeotiff/rio-tiler-mvt/branch/master/graph/badge.svg)](https://circleci.com/gh/cogeotiff/rio-tiler-mvt)
+
+
 A rio-tiler plugin to translate tile array to MVT (using python-vtzero)
+
+![](https://user-images.githubusercontent.com/10407788/57476379-72cf6000-7264-11e9-979d-bf9f486518c2.png)
+
+https://medium.com/devseed/cog-talk-part-1-whats-new-941facbcd3d1
+
+## Install
+
+### Requirements
+
+rio-tiler-mvt use [python-vtzero](https://github.com/tilery/python-vtzero) wrapper to encode point and polygons to MVT. Because VTZERO is a C++ library, python-vtzero is written in Cython, thus cython~=0.28 is required to compile this library.
+
+```bash
+$ pip install cython~=0.28 # see https://github.com/tilery/python-vtzero#requirements
+
+$ pip install rio-tiler-mvt
+```
+Or 
+```bash
+$ git clone https://github.com/cogeotiff/rio-tiler-mvt
+$ cd rio-tiler-mvt
+$ pip install -e .
+```
+
+## Rio-tiler + Mapbox Vector tiles
+
+### API
+
+`mvt.encoder(data, mask, band_names=[], layer_name="my_layer", feature_type="point")`
+
+Inputs:
+- data : raster tile data to encode
+- mask : mask data
+- band_names : Raster band's names
+- layer_name : Layer name
+- feature_type : Feature type (point or polygon)
+
+Returns:
+- mvt : Mapbox Vector Tile encoded data.
+
+
+## Contribution & Development
+
+Issues and pull requests are more than welcome.
+
+**dev install**
+
+```bash
+$ git clone https://github.com/cogeotiff/rio-tiler-mvt.git
+$ cd rio-tiler-mvt
+$ pip install -e .[dev]
+```
+
+**Python3.6 only**
+
+This repo is set to use `pre-commit` to run *flake8*, *pydocstring* and *black* ("uncompromising Python code formatter") when commiting new code.
+
+```bash
+$ pre-commit install
+```
+
+
+## Implementation
+[cogeo-mosaic](https://github.com/developmentseed/cogeo-mosaic.git)

codecov.yml

@@ -0,0 +1,8 @@
+comment: off
+
+coverage:
+    status:
+        project:
+            default:
+                target: auto
+                threshold: 5

requirements.txt

@@ -0,0 +1,2 @@
+numpy
+vtzero

rio_tiler_mvt/__init__.py

@@ -0,0 +1,5 @@
+"""rio-tiler-mvt: MVT encoder."""
+
+import pkg_resources
+
+version = pkg_resources.get_distribution(__package__).version

rio_tiler_mvt/mvt.pyx

@@ -0,0 +1,54 @@
+
+import numpy 
+
+from vtzero.tile import Tile, Layer, Point, Polygon
+
+cimport numpy
+
+cpdef bytes encoder(
+    data,
+    mask,
+    list band_names = [],
+    str layer_name = "my_layer",
+    str feature_type = "point",
+):
+    cdef int sc = 4096 // data.shape[1]
+    cdef tuple indexes = numpy.where(mask)
+
+    cdef tuple idx
+    cdef int x, y
+
+    if not band_names:
+        band_names = [
+          f"band{ix}" for ix in range(1, data.shape[0] + 1)
+        ]
+
+    mvt = Tile()
+    mvt_layer = Layer(mvt, layer_name.encode())
+    for idx in zip(indexes[1], indexes[0]):
+        x, y = idx
+        x *= sc
+        y *= sc
+
+        if feature_type == 'point':
+            feature = Point(mvt_layer)
+            feature.add_point(x + sc / 2, y - sc / 2)
+        
+        elif feature_type == 'polygon':
+            feature = Polygon(mvt_layer)
+            feature.add_ring(5)
+            feature.set_point(x, y)
+            feature.set_point(x + sc, y)
+            feature.set_point(x + sc, y - sc)
+            feature.set_point(x, y - sc)
+            feature.set_point(x, y)
+        
+        # TODO: fix https://github.com/tilery/python-vtzero/issues/3
+        for bidx in range(data.shape[0]):
+            feature.add_property(
+                band_names[bidx].encode(), 
+                str(data[bidx, idx[1], idx[0]]).encode()
+            )
+        feature.commit()
+
+    return mvt.serialize()

setup.py

@@ -0,0 +1,52 @@
+"""Setup for rio-tiler-mvt."""
+
+from setuptools.extension import Extension
+from setuptools import setup, find_packages
+from Cython.Build import cythonize
+
+import numpy
+
+# Runtime requirements.
+inst_reqs = ["numpy", "vtzero"]
+
+vt = "vector-tile-base @ git+https://github.com/mapbox/vector-tile-base"
+extra_reqs = {
+    "test": [vt, "rio-tiler", "pytest", "pytest-cov"],
+    "dev": [vt, "rio-tiler", "pytest", "pytest-cov", "pre-commit"],
+}
+
+ext_options = {"include_dirs": [numpy.get_include()]}
+ext_modules = cythonize(
+    [
+        Extension(
+            "rio_tiler_mvt.mvt",
+            ["rio_tiler_mvt/mvt.pyx"],
+            **ext_options
+        )
+    ]
+)
+
+setup(
+    name="rio-tiler-mvt",
+    version="0.0.1b",
+    description=u"""A rio-tiler plugin to encode tile array to MVT""",
+    python_requires=">=3",
+    classifiers=[
+        "Intended Audience :: Information Technology",
+        "Intended Audience :: Science/Research",
+        "License :: OSI Approved :: BSD License",
+        "Programming Language :: Python :: 3.6",
+        "Topic :: Scientific/Engineering :: GIS",
+    ],
+    keywords="COG MVT mapbox vectortile GIS",
+    author=u"Vincent Sarago",
+    author_email="[email protected]",
+    url="https://github.com/cogeotiff/rio-tiler-mvt",
+    license="BSD",
+    packages=find_packages(exclude=["ez_setup", "examples", "tests"]),
+    include_package_data=True,
+    zip_safe=False,
+    install_requires=inst_reqs,
+    extras_require=extra_reqs,
+    ext_modules=ext_modules,
+)

tests/fixtures/test.tif

@@ -0,0 +1,55 @@
+"""tests ard_tiler.mosaic."""
+
+import os
+
+from rio_tiler.main import tile as cogTiler
+from rio_tiler_mvt.mvt import encoder
+
+import vector_tile_base
+
+asset = os.path.join(os.path.dirname(__file__), "fixtures", "test.tif")
+x = 72
+y = 63
+z = 7
+
+tile, mask = cogTiler(asset, x, y, z)
+
+
+def test_mvt_encoder():
+    """Test MVT encoder."""
+    # test with default
+    vt = encoder(tile, mask)
+    mvt = vector_tile_base.VectorTile(vt)
+    assert len(mvt.layers) == 1
+    layer = mvt.layers[0]
+    assert layer.name == "my_layer"
+    assert layer.extent == 4096
+    assert layer.version == 2
+    assert len(layer.features) == 16
+    feat = layer.features[0]
+    assert feat.type == "point"
+    props = feat.properties
+    assert len(props) == 1
+    assert props["band1"] == "14.9334077835083"
+
+    # Test polygon
+    vt = encoder(tile, mask, feature_type="polygon")
+    mvt = vector_tile_base.VectorTile(vt)
+    layer = mvt.layers[0]
+    feat = layer.features[0]
+    assert feat.type == "polygon"
+    props = feat.properties
+    assert props["band1"] == "14.9334077835083"
+
+    # Test band name
+    vt = encoder(tile, mask, band_names=["pop"])
+    mvt = vector_tile_base.VectorTile(vt)
+    props = mvt.layers[0].features[0].properties
+    assert props["pop"] == "14.9334077835083"
+
+    # Test layer name
+    vt = encoder(tile, mask, layer_name="facebook")
+    mvt = vector_tile_base.VectorTile(vt)
+    assert len(mvt.layers) == 1
+    layer = mvt.layers[0]
+    assert layer.name == "facebook"