Merge pull request #49 from pycompression/release_0.6.0

Release 0.6.0

Author: rhpvorderman

.github/workflows/ci.yml

@@ -9,7 +9,6 @@ on:
     tags:
       - "*"
 
-
 jobs:
   lint:
     runs-on: ubuntu-20.04
@@ -25,26 +24,14 @@ jobs:
         run: pip install tox
       - name: Lint
         run: tox -e lint
-  docs:
-    needs: lint
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/[email protected]
-        with:
-          submodules: recursive
-      - name: Set up Python 3.6
-        uses: actions/[email protected]
-        with:
-          python-version: 3.6
-      - 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: Build docs
-        run: tox -e docs
-        env:
-          PYTHON_ISAL_LINK_DYNAMIC: True
-  mypy:
+
+  package-checks:
+    strategy:
+      matrix:
+        tox_env:
+          - docs
+          - mypy
+          - twine_check
     needs: lint
     runs-on: ubuntu-20.04
     steps:
@@ -59,38 +46,10 @@ jobs:
         run: sudo apt-get install libisal-dev
       - name: Install tox and upgrade setuptools and pip
         run: pip install --upgrade tox setuptools pip
-      - name: Mypy checks
-        run: tox -e mypy
+      - name: Run tox -e ${{ matrix.tox_env }}
+        run: tox -e ${{ matrix.tox_env }}
         env:
           PYTHON_ISAL_LINK_DYNAMIC: True
-  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
@@ -105,7 +64,9 @@ jobs:
         os: ["ubuntu-latest"]
         include:
           - os: "macos-latest"
-            python-version: 3.8
+            python-version: 3.6
+          - os: "windows-latest"
+            python-version: 3.6
     steps:
       - uses: actions/[email protected]
         with:
@@ -120,33 +81,45 @@ jobs:
         run: sudo apt install yasm
         if: runner.os == 'Linux'
       - name: Install build dependencies (Macos)
-        run: brew install yasm automake autoconf
+        run: brew install nasm automake autoconf
         if: runner.os == 'macOS'
+      - name: Set MSVC developer prompt
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
+      - name: Install nasm (Windows)
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
       - name: Run tests
         run: tox -e py3
       - name: Upload coverage report
         uses: codecov/codecov-action@v1
 
+  # Test if the python-isal conda package can be build. Which is linked
+  # dynamically to the conda isa-l package.
   test-dynamic:
     runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        # This is needed for miniconda, see:
+        # https://github.com/marketplace/actions/setup-miniconda#important.
+        shell: bash -l {0}
     needs: lint
     strategy:
       matrix:
-        python-version:
-          - 3.6
-        os: ["ubuntu-20.04"]
+        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
     steps:
       - uses: actions/[email protected]
         with:
           submodules: recursive
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2.2.1
+      - name: Install miniconda.
+        uses: conda-incubator/setup-miniconda@v2.0.1 # https://github.com/conda-incubator/setup-miniconda.
         with:
-          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
+          channels: conda-forge,defaults
+      - name: Install requirements (universal)
+        run: conda install isa-l python tox
+      - name: Set MSVC developer prompt
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
       - name: Run tests (dynamic link)
         run: tox -e py3
         env:
@@ -155,10 +128,10 @@ jobs:
   deploy:
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
     runs-on: ${{ matrix.os }}
-    needs: [lint, docs, test-static, test-dynamic, twine_check]
+    needs: [lint, package-checks, test-static, test-dynamic]
     strategy:
       matrix:
-        os: [ "macos-latest", "ubuntu-latest" ]
+        os: ["macos-latest", "ubuntu-latest", "windows-latest"]
     steps:
       - uses: actions/[email protected]
         with:
@@ -168,17 +141,26 @@ jobs:
       - name: Install cibuildwheel twine
         run: python -m pip install cibuildwheel twine
       - name: Install build dependencies (Macos)
-        run: brew install yasm automake autoconf
+        run: brew install nasm automake autoconf
         if: runner.os == 'macOS'
+      - name: Set MSVC developer prompt
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
+      - name: Install nasm (Windows)
+        uses: ilammy/[email protected]
+        if: runner.os == 'Windows'
+      - name: Install cibuildwheel twine wheel
+        run: python -m pip install cibuildwheel twine wheel
       - 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\")'"
+          # Fully test the build wheels again.
+          CIBW_TEST_REQUIRES: "pytest"
+          # Simple test that requires the project to be build correctly
+          CIBW_TEST_COMMAND: "pytest {project}/tests/test_igzip.py"
       - name: Build sdist
         if: "runner.os == 'Linux'"
         run: python setup.py sdist

CHANGELOG.rst

@@ -7,6 +7,16 @@ 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.6.0
+-----------------
++ ``python -m gzip``'s behaviour has been changed since fixing bug:
+  `bpo-43316 <https://bugs.python.org/issue43316>`_. This bug was not present
+  in ``python -m isal.igzip`` but it handled the error differently than the
+  solution in CPython. This is now corrected and ``python -m isal.igzip``
+  handles the error the same as the fixed ``python -m gzip``.
++ Installation on Windows is now supported. Wheels are provided for Windows as
+  well.
+
 version 0.5.0
 -----------------
 + Fix a bug where negative integers were not allowed for the ``adler32`` and

README.rst

@@ -14,6 +14,10 @@
   :target: https://github.com/LUMC/isal/blob/main/LICENSE
   :alt:
 
+.. image:: https://img.shields.io/conda/pn/conda-forge/python-isal.svg
+  :target: https://github.com/conda-forge/python-isal-feedstock
+  :alt:
+
 .. image:: https://travis-ci.com/pycompression/python-isal.svg?branch=develop
   :target: https://travis-ci.com/github/pycompression/python-isal
   :alt:
@@ -34,7 +38,7 @@ Faster zlib and gzip compatible compression and decompression
 by providing Python bindings for the ISA-L library.
 
 This package provides Python bindings for the `ISA-L
-<https://github.com/intel/isa-l>`_ library. The Intel Infrastructure Storage
+<https://github.com/intel/isa-l>`_ library. The Intel(R) Intelligent Storage
 Acceleration Library (ISA-L) implements several key algorithms in `assembly
 language <https://en.wikipedia.org/wiki/Assembly_language>`_. This includes
 a variety of functions to provide zlib/gzip-compatible compression.
@@ -58,7 +62,7 @@ They can be imported as follows
 
 ``isal_zlib`` and ``igzip`` are meant to be used as drop in replacements so
 their api and functions are the same as the stdlib's modules. Except where
-isa-l does not support the same calls as zlib (See differences below).
+ISA-L does not support the same calls as zlib (See differences below).
 
 A full API documentation can be found on `our readthedocs page
 <https://python-isal.readthedocs.io>`_.
@@ -71,12 +75,14 @@ Installation
 Installation with pip
 .....................
 
-+ Linux and MacOS: ``pip install isal``. Wheels are provided, so installation should
-  be almost instantaneous.
-+ Windows: Installation is not supported yet.
+::
 
-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
+    pip install isal
+
+Installation is supported on Linux, MacOS and Windows. On x86-64 (amd64)
+platforms wheels are provided, so installation should be almost instantaneous.
+The installation will include a staticallly linked version of ISA-L.
+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.
 
@@ -88,7 +94,7 @@ This requires having the build requirements installed.
 If you wish to link
 dynamically against a version of libisal installed on your system use::
 
-     PYTHON_ISAL_LINK_DYNAMIC=true pip install isal
+     PYTHON_ISAL_LINK_DYNAMIC=true pip install isal --no-binary isal
 
 ISA-L is available in numerous Linux distro's as well as on conda via the
 conda-forge channel. Checkout the `ports documentation
@@ -97,9 +103,7 @@ to find out how to install it. It is important that the development headers
 are also installed.
 
 On Debian and Ubuntu the ISA-L libraries (including the development headers)
-can be installed with:
-
-.. code-block::
+can be installed with::
 
   sudo apt install libisal-dev
 
@@ -113,13 +117,11 @@ channel. When used with bioinformatics tools setting up `bioconda
 <http://bioconda.github.io/user/install.html#install-conda>`_
 provides a clear set of installation instructions for conda.
 
-python-isal is available on conda-forge and can be installed with 
-
-.. code-block::
+python-isal is available on conda-forge and can be installed with::
 
   conda install python-isal
 
-This will automatically install the isa-l library dependency as well, since
+This will automatically install the ISA-L library dependency as well, since
 it is available on conda-forge.
 
 Differences with zlib and gzip modules
@@ -129,6 +131,9 @@ Differences with zlib and gzip modules
   in ``isal_zlib`` and ``igzip`` this is the **lowest compression level**.
   This is a design choice that was inherited from the ISA-L library.
 + Compression levels range from 0 to 3, not 1 to 9.
++ ``igzip`` contains a class ``IGzipFile`` instead of ``GzipFile``. Since the
+  compression levels are not compatible, a difference in naming was chosen to
+  reflect this.
 + ``zlib.Z_DEFAULT_STRATEGY``, ``zlib.Z_RLE`` etc. are exposed as
   ``isal_zlib.Z_DEFAULT_STRATEGY``, ``isal_zlib.Z_RLE`` etc. for compatibility
   reasons. However, ``isal_zlib`` only supports a default strategy and will

codecov.yml

@@ -1,4 +1,3 @@
-comment: off
 coverage:
   status:
     project: