Merge pull request #23 from tilery/PreCommitAndWheels

add pre-commit and cibuildwheel

Author: vincentsarago

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+ignore = E501,W503,E203
+exclude = .git,__pycache__,docs/source/conf.py,old,build,dist
+max-line-length = 90

.github/codecov.yml

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

.github/workflows/ci.yml

@@ -11,59 +11,126 @@ on:
 
 jobs:
   tests:
-    runs-on: ubuntu-latest
+    name: ${{ matrix.name }}
+    runs-on: ${{ matrix.os }}
     strategy:
+      fail-fast: false
       matrix:
-        python-version: [3.5, 3.6, 3.7, 3.8, 3.9]
+        include:
+          - {name: Windows, python: '3.10', os: windows-latest}
+          - {name: Mac, python: '3.10', os: macos-latest}
+          - {name: 'Ubuntu', python: '3.10', os: ubuntu-latest}
+          - {name: '3.11', python: '3.11.0-rc.2 - 3.11', os: ubuntu-latest}
+          - {name: '3.9', python: '3.9', os: ubuntu-latest}
+          - {name: '3.8', python: '3.8', os: ubuntu-latest}
+          - {name: '3.7', python: '3.7', os: ubuntu-latest}
+          - {name: '3.6', python: '3.6', os: ubuntu-latest}
+          - {name: '3.5', python: '3.5', os: ubuntu-latest}
 
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v4
         with:
-          python-version: ${{ matrix.python-version }}
+          python-version: ${{ matrix.python }}
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install tox
           git submodule update --init
+          python -m pip install -e .["test"]
 
-      # Run tox using the version of Python in `PATH`
-      - name: Run Tox
-        run: tox -e py
+      - name: Run pre-commit
+        if: ${{ matrix.name == 'Ubuntu' }}
+        run: |
+          python -m pip install pre-commit
+          pre-commit run --all-files
 
-  publish:
+      - name: Run Tests
+        run: |
+          python -m pytest --cov vtzero --cov-report xml --cov-report term-missing
+
+      - name: Upload Results
+        if: ${{ matrix.name == 'Ubuntu' }}
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: ${{ matrix.python }}
+          fail_ci_if_error: false
+
+  #######################################################################################
+  # Deploy
+  #######################################################################################
+  build_wheels:
     needs: [tests]
-    runs-on: ubuntu-latest
     if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'release'
+    name: ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v1
+      - uses: actions/checkout@v3
+
+      # Used to host cibuildwheel
+      - uses: actions/setup-python@v4
         with:
-          python-version: "3.x"
+          python-version: '3.10'
+
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.11.1
 
       - name: Install dependencies
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install tox setuptools cython>=0.29.23
           git submodule update --init
-          python setup.py build_ext --inplace
 
-      - name: Set tag version
-        id: tag
-        # https://stackoverflow.com/questions/58177786/get-the-current-pushed-tag-in-github-actions
-        run: echo ::set-output name=tag::${GITHUB_REF#refs/*/}
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_SKIP: 'pp*'
+          CIBW_ARCHS_MACOS: auto universal2
 
-      - name: Set module version
-        id: module
-        # https://stackoverflow.com/questions/58177786/get-the-current-pushed-tag-in-github-actions
-        run: echo ::set-output name=version::$(python setup.py --version)
+      - uses: actions/upload-artifact@v3
+        with:
+          path: ./wheelhouse
 
-      - name: Build and publish
-        if: steps.tag.outputs.tag == steps.module.outputs.version
-        env:
-          TOXENV: release
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-        run: tox
+  build_sdist:
+    needs: [tests]
+    if: startsWith(github.event.ref, 'refs/tags') || github.event_name == 'release'
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - uses: actions/setup-python@v4
+        name: Install Python
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install numpy Cython
+          git submodule update --init
+
+      - name: Build sdist
+        run: python setup.py sdist
+
+      - uses: actions/upload-artifact@v3
+        with:
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_PASSWORD }}

.pre-commit-config.yaml

@@ -0,0 +1,27 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 22.3.0
+    hooks:
+      - id: black
+        language_version: python
+        args: [--safe]
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.10.1
+    hooks:
+      - id: isort
+        language_version: python
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 5.0.4
+    hooks:
+      - id: flake8
+        language_version: python
+
+  - repo: https://github.com/PyCQA/pydocstyle
+    rev: 6.1.1
+    hooks:
+      - id: pydocstyle
+        language_version: python
+        additional_dependencies:
+          - toml

CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Release Notes
 
+### 0.0.1b3 - 2022-10-25
+
+- add python 3.9, 3.10, 3.11 support
+- add python wheels
+- update vendor submodules
 
 ### 0.0.1b2 - 2021-06-16
 

example/__init__.py

@@ -1,17 +1,19 @@
-from vtzero.tile import VectorTile, Tile, Layer, Point, Polygon, Linestring
+"""Example of python-vtzero usage."""
+
+from vtzero.tile import Layer, Linestring, Point, Polygon, Tile, VectorTile
 
 # Create MVT
 tile = Tile()
 
 # Add a layer
-layer = Layer(tile, b'my_layer')
+layer = Layer(tile, b"my_layer")
 
 # Add a point
 feature = Point(layer)
 feature.add_points(1)
 feature.set_point(10, 10)
-feature.add_property(b'foo', b'bar')
-feature.add_property(b'x', b'y')
+feature.add_property(b"foo", b"bar")
+feature.add_property(b"x", b"y")
 feature.commit()
 
 # Add a polygon
@@ -47,4 +49,4 @@
     if f.geometry_type == 0:
         break
     features.append(f)
-print(f"Nb Features: {len(features)}")
+print(f"Nb Features: {len(features)}")

pyproject.toml

@@ -2,6 +2,14 @@
 requires = ["setuptools>=40.8.0", "wheel", "Cython>=0.29.23"]
 build-backend = "setuptools.build_meta"
 
-[tool.flake8]
-exclude = ".git,__pycache__,docs/source/conf.py,old,build,dist"
-max-line-length = 90
+[tool.isort]
+profile = "black"
+known_first_party = ["vtzero"]
+default_section = "THIRDPARTY"
+
+[tool.mypy]
+no_strict_optional = "True"
+
+[tool.pydocstyle]
+select = "D1"
+match = "(?!test).*.py"

setup.py

@@ -1,47 +1,47 @@
 """python-vtzero setup."""
 
+from Cython.Build import cythonize
 from setuptools import setup
 from setuptools.extension import Extension
-from Cython.Build import cythonize
 
 with open("README.md") as f:
     long_description = f.read()
 
 ext_options = {
-    'include_dirs': ['./vendor/vtzero/include', './vendor/protozero/include'],
-    'extra_compile_args': ['-O2', '-std=c++11']
+    "include_dirs": ["./vendor/vtzero/include", "./vendor/protozero/include"],
+    "extra_compile_args": ["-O2", "-std=c++11"],
 }
-ext_modules = cythonize([
-    Extension('vtzero.tile', ['vtzero/tile.pyx'], language="c++", **ext_options)
-])
+ext_modules = cythonize(
+    [Extension("vtzero.tile", ["vtzero/tile.pyx"], language="c++", **ext_options)]
+)
 
 extra_reqs = {
-    "test": ["pytest"],
+    "test": ["pytest", "pytest-cov"],
 }
 
 
 setup(
-    name='vtzero',
-    description='Python wrapper for vtzero C++ library.',
+    name="vtzero",
+    description="Python wrapper for vtzero C++ library.",
     long_description=long_description,
     long_description_content_type="text/markdown",
     classifiers=[
-        'License :: OSI Approved :: MIT License',
-        'Intended Audience :: Developers',
-        'Programming Language :: Python :: 3',
-        'Operating System :: POSIX',
-        'Environment :: Web Environment',
-        'Development Status :: 2 - Pre-Alpha',
-        'Topic :: Scientific/Engineering :: GIS'
+        "License :: OSI Approved :: MIT License",
+        "Intended Audience :: Developers",
+        "Programming Language :: Python :: 3",
+        "Operating System :: POSIX",
+        "Environment :: Web Environment",
+        "Development Status :: 2 - Pre-Alpha",
+        "Topic :: Scientific/Engineering :: GIS",
     ],
-    keywords='mvt mapbox vector tile gis',
-    platforms=['POSIX'],
-    author='Yohan Boniface',
-    author_email='[email protected]',
-    license='MIT',
-    packages=['vtzero'],
+    keywords="mvt mapbox vector tile gis",
+    platforms=["POSIX"],
+    author="Yohan Boniface",
+    author_email="[email protected]",
+    license="MIT",
+    packages=["vtzero"],
     ext_modules=ext_modules,
-    provides=['vtzero'],
+    provides=["vtzero"],
     include_package_data=True,
     extras_require=extra_reqs,
 )

tests/test_fixtures.py

@@ -1,11 +1,11 @@
 import json
 from pathlib import Path
 
-from vtzero.tile import VectorTile
-
 import pytest
 
-ROOT = Path(__file__).parent.parent / 'vendor/mvt-fixtures/fixtures'
+from vtzero.tile import VectorTile
+
+ROOT = Path(__file__).parent.parent / "vendor/mvt-fixtures/fixtures"
 
 # Magic: Generate tests from yml.
 # def pytest_generate_tests(metafunc):
@@ -28,36 +28,37 @@
 def fixture():
     def _(id):
         path = ROOT / id
-        with (path / 'info.json').open('r') as f:
+        with (path / "info.json").open("r") as f:
             info = json.loads(f.read())
-        with (path / 'tile.json').open('r') as f:
+        with (path / "tile.json").open("r") as f:
             data = json.loads(f.read())
-        with (path / 'tile.mvt').open('rb') as f:
+        with (path / "tile.mvt").open("rb") as f:
             mvt = f.read()
         return info, data, mvt
+
     return _
 
 
 def first_feature(tile):
     assert not tile.empty()
     assert len(tile) == 1
     layer = next(tile)
-    assert layer.name == b'hello'
+    assert layer.name == b"hello"
     assert layer.version == 2
     assert layer.extent == 4096
     assert len(layer) == 1
     return next(layer)
 
 
 def test_empty_tile(fixture):
-    info, data, mvt = fixture('001')
+    info, data, mvt = fixture("001")
     tile = VectorTile(mvt)
     assert tile.empty()
     assert len(tile) == 0
 
 
 def test_single_point_without_id(fixture):
-    info, data, mvt = fixture('002')
+    info, data, mvt = fixture("002")
     tile = VectorTile(mvt)
     feature = first_feature(tile)
     assert not feature.has_id()