Merge pull request #32 from pycompression/cibuildwheels

Add machinery for automated wheel building.

Author: rhpvorderman

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
     branches:
       - develop
       - main
+    tags:
+      - "*"
 
 
 jobs:
@@ -42,19 +44,49 @@ jobs:
         run: tox -e docs
         env:
           PYTHON_ISAL_LINK_DYNAMIC: True
-  test:
-    runs-on: ubuntu-20.04
+  twine_check:
+    needs: lint
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        python-version:
+          - 3.6
+        os: ["ubuntu-latest" ]
+    steps:
+      - uses: actions/[email protected]
+        with:
+         submodules: recursive
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install build dependencies (Linux)  # Yasm in pypa/manylinux images.
+        run: sudo apt install yasm
+        if: runner.os == 'Linux'
+      - name: Install build dependencies (Macos)
+        run: brew install yasm automake autoconf
+        if: runner.os == 'macOS'
+      - name: Install twine, cython wheel and upgrade setuptools
+        run: pip install --upgrade twine cython wheel setuptools
+      - name: create dists
+        run: python setup.py sdist bdist_wheel
+      - name: check dists
+        run: twine check dist/*
+
+  test-static:
+    needs: lint
+    runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         python-version:
           - 3.6
           - 3.7
           - 3.8
           - 3.9
-        linking_method:
-          - static
-          - dynamic
-    needs: lint
+        os: ["ubuntu-latest"]
+        include:
+          - os: "macos-latest"
+            python-version: 3.8
     steps:
       - uses: actions/[email protected]
         with:
@@ -63,41 +95,85 @@ jobs:
         uses: actions/[email protected]
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install tox and upgrade setuptools and pip
-        run: pip install --upgrade tox setuptools pip
-      - name: Install isal
-        if: ${{ matrix.linking_method == 'dynamic' }}
-        run: sudo apt-get install libisal-dev
-      - name: Install yasm  # Yasm in pypa/manylinux images.
+      - name: Install tox and upgrade setuptools
+        run: pip install --upgrade tox setuptools
+      - name: Install build dependencies (Linux)  # Yasm in pypa/manylinux images.
         run: sudo apt install yasm
-        if: ${{ matrix.linking_method == 'static' }}
-      - name: Run tests (dynamic link)
-        run: tox -e py3
-        env:
-          PYTHON_ISAL_LINK_DYNAMIC: True
-        if: ${{ matrix.linking_method == 'dynamic' }}
-      - name: Run tests (dynamic link)
+        if: runner.os == 'Linux'
+      - name: Install build dependencies (Macos)
+        run: brew install yasm automake autoconf
+        if: runner.os == 'macOS'
+      - name: Run tests
         run: tox -e py3
-        if: ${{ matrix.linking_method == 'static' }}
       - name: Upload coverage report
-        if: ${{ matrix.python-version == 3.6 && matrix.linking_method == 'static'}} # Only upload coverage once
         uses: codecov/codecov-action@v1
 
-  macos:
-    runs-on: macos-latest
+  test-dynamic:
+    runs-on: ${{ matrix.os }}
     needs: lint
+    strategy:
+      matrix:
+        python-version:
+          - 3.6
+        os: ["ubuntu-20.04"]
     steps:
-      - name: Install python 3.6
-        uses: actions/[email protected]
+      - uses: actions/[email protected]
         with:
           submodules: recursive
-      - name: Set up Python 3.6
+      - name: Set up Python ${{ matrix.python-version }}
         uses: actions/[email protected]
         with:
-          python-version: 3.6
+          python-version: ${{ matrix.python-version }}
+      - name: Install isal
+        run: sudo apt-get install libisal-dev
       - name: Install tox and upgrade setuptools and pip
         run: pip install --upgrade tox setuptools pip
-      - name: Install build dependencies
-        run: brew install yasm automake autoconf
-      - name: Run tests
+      - name: Run tests (dynamic link)
         run: tox -e py3
+        env:
+          PYTHON_ISAL_LINK_DYNAMIC: True
+
+  deploy:
+    if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
+    runs-on: ${{ matrix.os }}
+    needs: [lint, docs, test-static, test-dynamic, twine_check]
+    strategy:
+      matrix:
+        os: [ "macos-latest", "ubuntu-latest" ]
+    steps:
+      - uses: actions/[email protected]
+        with:
+          submodules: recursive
+      - uses: actions/setup-python@v2
+        name: Install Python
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==1.8.0
+      - name: Install build dependencies (Macos)
+        run: brew install yasm automake autoconf
+        if: runner.os == 'macOS'
+      - name: Build wheels
+        run: cibuildwheel --output-dir dist
+        env:
+          CIBW_BUILD: "cp3{6,7,8,9}-*"
+          CIBW_SKIP: "*-win32 *-manylinux_i686"  # Skip 32 bit.
+          CIBW_MANYLINUX_X86_64_IMAGE: "manylinux2014"
+          # Below command fails when data is not correctly statically linked
+          # Full tests not needed: these are done prior to building.
+          CIBW_TEST_COMMAND: "python -c 'from isal import isal_zlib, igzip; isal_zlib.adler32(b\"bla\")'"
+      - name: Build sdist
+        if: "runner.os == 'Linux'"
+        run: python setup.py sdist
+      - name: Publish package to TestPyPI
+        uses: pypa/gh-action-pypi-publish@master
+        # Alpha, Beta and dev releases contain a - in the tag.
+        if: contains(github.ref, '-') && startsWith(github.ref, 'refs/tags')
+        with:
+          user: __token__
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@master
+        if: "!contains(github.ref, '-') && startsWith(github.ref, 'refs/tags')"
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

CHANGELOG.rst

@@ -7,8 +7,10 @@ Changelog
 .. This document is user facing. Please word the changes in such a way
 .. that users understand how the changes affect the new version.
 
-version 0.3.1-dev
+version 0.4.0-dev
 -----------------
++ Move wheel building to cibuildwheel on github actions CI. Wheels are now
+  provided for Mac OS as well.
 + Make a tiny change in setup.py so python-isal can be build on Mac OS X.
 
 version 0.3.0

README.rst

@@ -48,23 +48,20 @@ Installation
 Installation with pip
 .....................
 
-+ Linux: ``pip install isal``. Wheels are provided, so installation should
++ Linux and MacOS: ``pip install isal``. Wheels are provided, so installation should
   be almost instantaneous.
-+ MacOS: make sure ``gcc``, ``yasm``, ``automake`` and ``autoconf`` packages
-  are installed. These can be installed via `Homebrew <https://brew.sh/>`_ with
-  ``brew install gcc yasm automake autoconf``. Then proceed with ``pip
-  install isal``. The package will be build on your computer.
 + Windows: Installation is not supported yet.
 
-The installation will include a staticallly linked version of isa-l. On Linux,
-wheels are provided. If a wheel is not provided for your system the
+The installation will include a staticallly linked version of isa-l. On Linux
+and MacOS, wheels are provided. If a wheel is not provided for your system the
 installation will build ISA-L first in a temporary directory. Please check the
 `ISA-L homepage <https://github.com/intel/isa-l>`_ for the build requirements.
 
 The latest development version of python-isal can be installed with::
 
     pip install git+https://github.com/rhpvorderman/python-isal.git
 
+This requires having the build requirements installed.
 If you wish to link
 dynamically against a version of libisal installed on your system use::