Merge pull request #30 from pycompression/macos

Add macos to ci.yml

Author: rhpvorderman

.github/workflows/ci.yml

@@ -82,3 +82,22 @@ jobs:
       - 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
+    needs: lint
+    steps:
+      - name: Install python 3.6
+        uses: actions/[email protected]
+        with:
+          submodules: recursive
+      - name: Set up Python 3.6
+        uses: actions/[email protected]
+        with:
+          python-version: 3.6
+      - 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
+        run: tox -e py3

CHANGELOG.rst

@@ -7,6 +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
+-----------------
++ 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,14 +47,19 @@ Installation
 ------------
 Installation with pip
 .....................
-Python-isal can be installed with::
 
-    pip install isal
-
-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.
++ Linux: ``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
+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::
 

setup.py

@@ -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)
@@ -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=[