Merge pull request #37 from pycompression/release_0.4.0

Release 0.4.0

Author: rhpvorderman

.github/workflows/ci.yml

@@ -6,6 +6,8 @@ on:
     branches:
       - develop
       - main
+    tags:
+      - "*"
 
 
 jobs:
@@ -42,19 +44,78 @@ 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
+        os: ["ubuntu-latest"]
+        include:
+          - os: "macos-latest"
+            python-version: 3.8
+    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 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: 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
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v1
+
+  test-dynamic:
+    runs-on: ${{ matrix.os }}
     needs: lint
+    strategy:
+      matrix:
+        python-version:
+          - 3.6
+        os: ["ubuntu-20.04"]
     steps:
       - uses: actions/[email protected]
         with:
@@ -63,22 +124,56 @@ 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.
-        run: sudo apt install yasm
-        if: ${{ matrix.linking_method == 'static' }}
+      - name: Install tox and upgrade setuptools and pip
+        run: pip install --upgrade tox setuptools pip
       - 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)
-        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
+
+  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 twine
+        run: python -m pip install cibuildwheel twine
+      - 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
+        # pypa/gh-action-pypi-publish@master does not work on OSX
+        # Alpha, Beta and dev releases contain a - in the tag.
+        if: contains(github.ref, '-') && startsWith(github.ref, 'refs/tags')
+        run: twine upload --repository-url https://test.pypi.org/legacy/ dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.TEST_PYPI_API_TOKEN }}
+      - name: Publish package to PyPI
+        if: "!contains(github.ref, '-') && startsWith(github.ref, 'refs/tags')"
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

CHANGELOG.rst

@@ -7,6 +7,12 @@ 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.4.0
+-----------------
++ 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
 -----------------
 + Set included ISA-L library at version 2.30.0.

README.rst

@@ -47,19 +47,21 @@ Installation
 ------------
 Installation with pip
 .....................
-Python-isal can be installed with::
 
-    pip install isal
++ Linux and MacOS: ``pip install isal``. Wheels are provided, so installation should
+  be almost instantaneous.
++ Windows: Installation is not supported yet.
 
-This will include a staticallly linked version of isa-l. On Linux, 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 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::
 

buildwheels.sh

@@ -97,12 +97,15 @@ def build_isa_l():
     build_env = os.environ.copy()
     # Add -fPIC flag to allow static compilation
     build_env["CFLAGS"] = build_env.get("CFLAGS", "") + " -fPIC"
-
+    if hasattr(os, "sched_getaffinity"):
+        cpu_count = len(os.sched_getaffinity(0))
+    else:  # sched_getaffinity not available on all platforms
+        cpu_count = os.cpu_count() or 1  # os.cpu_count() can return None
     run_args = dict(cwd=build_dir, env=build_env)
     subprocess.run(os.path.join(build_dir, "autogen.sh"), **run_args)
     subprocess.run([os.path.join(build_dir, "configure"),
                     "--prefix", temp_prefix], **run_args)
-    subprocess.run(["make", "-j", str(len(os.sched_getaffinity(0)))],
+    subprocess.run(["make", "-j", str(cpu_count)],
                    **run_args)
     subprocess.run(["make", "install"], **run_args)
     shutil.rmtree(build_dir)
@@ -111,7 +114,7 @@ def build_isa_l():
 
 setup(
     name="isal",
-    version="0.3.0",
+    version="0.4.0",
     description="Faster zlib and gzip compatible compression and "
                 "decompression by providing python bindings for the isa-l "
                 "library.",
@@ -142,6 +145,8 @@ def build_isa_l():
         "Development Status :: 3 - Alpha",
         "Topic :: System :: Archiving :: Compression",
         "License :: OSI Approved :: MIT License",
+        "Operating System :: POSIX :: Linux",
+        "Operating System :: MacOS"
     ],
     python_requires=">=3.6",
     ext_modules=[

setup.py

@@ -29,4 +29,4 @@
     "__version__"
 ]
 
-__version__ = "0.3.0"
+__version__ = "0.4.0"