Add PyPI Support

.github/workflows/wheels.yml

@@ -0,0 +1,115 @@
+name: Build and Upload to PyPI
+
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build_wheels:
+
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      # Ensure that a wheel builder finishes even if another fails
+      fail-fast: false
+      matrix:
+        include:
+          # Windows
+          - os: windows-latest
+            python: 38
+            bitness: 64
+            platform_id: win_amd64
+
+          # Ubuntu
+          - os: ubuntu-latest
+            python: 38
+            bitness: 64
+            platform_id: manylinux_x86_64
+            manylinux_image: manylinux2014
+
+          # MacOS
+          - os: macos-latest
+            python: 38
+            bitness: 64
+            platform_id: macosx_x86_64
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+
+      - name: Install Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Add Python Scripts Directory to Path (MacOS)
+        if: matrix.os == 'macos-latest'
+        run: |
+          echo "/Library/Frameworks/Python.framework/Versions/3.8/bin" >> $GITHUB_PATH
+
+      - name: Install `cibuildwheel` (Windows)
+        if: matrix.os == 'windows-latest'
+        run: python -m pip install cibuildwheel
+
+      - name: Install `cibuildwheel` (Linux/MacOS)
+        if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
+        run: python3 -m pip install cibuildwheel
+
+      - name: Build wheels
+        uses: pypa/[email protected]
+        with:
+          package-dir: ${{ matrix.package-dir }}
+        env:
+          CIBW_SKIP: pp* cp36* cp37* cp39* cp310* *-win32 *musllinux*
+          CIBW_ARCHS: auto64
+          CIBW_BUILD: cp${{ matrix.python }}-${{ matrix.platform_id }}
+          CIBW_MANYLINUX_X86_64_IMAGE: ${{ matrix.manylinux_image }}
+          CIBW_BUILD_VERBOSITY: 1
+          CIBW_BEFORE_BUILD_LINUX: |
+            yum install -y wget
+            bash {project}/ci/embree_linux.bash
+          CIBW_BEFORE_BUILD_MACOS: |
+            /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
+            brew install bash
+            bash {project}/ci/embree_macos.bash
+          CIBW_BEFORE_BUILD_WINDOWS: |
+            cmd.exe /c "{project}\\ci\\embree_windows.bat" & python -m pip install delvewheel
+          CIBW_REPAIR_WHEEL_COMMAND_LINUX: |
+            export LD_LIBRARY_PATH="/project/pyembree/embree/lib"
+            auditwheel repair -w {dest_dir} {wheel}
+          CIBW_REPAIR_WHEEL_COMMAND_MACOS: |
+            export DYLD_FALLBACK_LIBRARY_PATH="${GITHUB_WORKSPACE}/pyembree/embree/lib"
+            delocate-listdeps {wheel}
+            delocate-wheel --require-archs {delocate_archs} -w {dest_dir} {wheel}
+          CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: >
+            delvewheel repair
+            --add-path %GITHUB_WORKSPACE%\\pyembree\\embree\\bin
+            --no-mangle tbb.dll;tbbmalloc.dll;embree.dll
+            -w {dest_dir} {wheel}
+
+      - uses: actions/upload-artifact@v2
+        with:
+          name: wheels
+          path: ./wheelhouse/*
+
+      - name: Upload To PyPI (Windows)
+        if: |
+          matrix.os == 'windows-latest' &&
+          github.event_name == 'push' &&
+          startsWith(github.ref, 'refs/tags')
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          python -m pip install twine
+          twine upload ./wheelhouse/*
+
+      - name: Upload To PyPI (Linux/MacOS)
+        if: |
+          ( matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest' ) &&
+          github.event_name == 'push' &&
+          startsWith(github.ref, 'refs/tags')
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |
+          python3 -m pip install twine
+          twine upload ./wheelhouse/*

.gitignore

@@ -15,3 +15,12 @@ dist/
 .vscode
 # Rever
 rever/
+
+# Virtual environment folders
+.venv/
+
+# Shared libs
+*.pyd
+
+# Embree folder
+pyembree/embree/

MANIFEST.in

@@ -0,0 +1 @@
+recursive-include pyembree *.pyd *.so

README.rst

@@ -5,19 +5,18 @@ Python Wrapper for Embree
 
 Installation
 ------------
-You can install pyembree (and embree) via the conda-forge package.
+You can install pyembree (and embree) via ``pip``
 
 .. code-block:: bash
 
-    $ conda install -c conda-forge pyembree
+    $ pip install pyembree
 
-
-
-Suppressing errors
+Suppressing Errors
 ------------------
 
 Creating multiple scenes produces some harmless error messages:
 ::
+
     ERROR CAUGHT IN EMBREE
     ERROR: Invalid operation
     ERROR MESSAGE: b'already initialized'

build.py

@@ -0,0 +1,99 @@
+import os
+from typing import Any, Dict, List
+
+import numpy as np
+
+# setuptools must be imported before cython. setuptools overrides the
+# distutils.extension.Extension class. If imported after, the isinstance check in
+# distutils.command.check_extensions_list fails and setuptools gives the erroneous
+# error:
+#
+# "error: each element of 'ext_modules' option must be an Extension instance or 2-tuple"
+#
+# ref: https://github.com/cython/cython/issues/4724
+from setuptools import find_packages  # isort: skip
+from setuptools.command.build_ext import build_ext  # isort: skip
+from setuptools.extension import Extension  # isort: skip
+from Cython.Build import cythonize  # isort: skip
+
+cwd = os.path.dirname(__file__)
+package_dir = os.path.join(cwd, "pyembree")
+dependencies_dir = os.path.join(package_dir, "embree")
+
+version_file = os.path.join(package_dir, "_version.py")
+
+with open(version_file, mode="r") as fd:
+    exec(fd.read())
+
+include = [
+    np.get_include(),
+    os.path.join(dependencies_dir, "include", "embree2"),
+]
+library = [
+    os.path.join(dependencies_dir, "lib"),
+    os.path.join(dependencies_dir, "bin"),
+]
+
+packages = ["pyembree"]
+
+with open("README.rst", encoding="utf-8") as file_:
+    readme = file_.read()
+
+
+def build(setup_kwargs: Dict[str, Any]) -> None:
+    ext_modules: List[Extension] = cythonize(
+        module_list="pyembree/*.pyx",
+        language_level=3,
+        include_path=include,
+    )
+
+    for ext in ext_modules:
+        ext.include_dirs = include
+        ext.library_dirs = library
+        if os.name == "nt":
+            ext.libraries = [
+                "embree",
+                "tbb",
+                "tbbmalloc",
+            ]
+        else:
+            # It is recommended to build against tbb and tbbmalloc, which may improve
+            # the library's runtime performance. However, to be a 'manylinux' wheel, these
+            # must be removed for maximum portability.
+            #
+            # See also `ci/embree_linux.bash`
+            #
+            ext.libraries = [
+                "embree",
+                # "tbb",  # Uncomment to build against tbb
+                # "tbbmalloc"  # Uncomment to build against tbb
+            ]
+
+    setup_kwargs.update(
+        {
+            "name": "pyembree",
+            "version": __version__,
+            "description": "Python wrapper for Intel Embree 2.17.7",
+            "long_description": readme,
+            "long_description_content_type": "text/x-rst",
+            "author": "Anthony Scopatz",
+            "author_email": "[email protected]",
+            "maintainer": "Adam Hendry",
+            "maintainer_email": "[email protected]",
+            "url": "https://github.com/adam-grant-hendry/pyembree",
+            "ext_modules": ext_modules,
+            "cmdclass": {"build_ext": build_ext},
+            "zip_safe": False,
+            "packages": find_packages(),
+            "packages": packages,
+            "python_requires": ">=3.8,<3.9",
+            "classifiers": [
+                "License :: OSI Approved :: BSD License",
+                "Operating System :: POSIX :: Linux",
+                "Operating System :: MacOS :: MacOS X",
+                "Operating System :: Microsoft :: Windows :: Windows 10",
+                "Programming Language :: Python :: 3",
+                "Programming Language :: Python :: 3.8",
+            ],
+        }
+    )

ci/embree_linux.bash

@@ -0,0 +1,35 @@
+#!/bin/bash
+set -xe
+
+VERSION="2.17.7"
+
+rm -rf embree.tar.gz
+rm -rf embree
+
+wget -nv https://github.com/embree/embree/releases/download/v${VERSION}/embree-${VERSION}.x86_64.linux.tar.gz -O embree.tar.gz
+tar -zxvf embree.tar.gz
+rm -f embree.tar.gz
+
+if [[ ! -d pyembree/embree ]]; then
+    mkdir -p pyembree/embree
+fi
+
+# Rename unzipped folder for cdef extern statements
+mv "embree-${VERSION}.x86_64.linux" embree
+
+# It is recommended to build against tbb and tbbmalloc, which may improve
+# the library's runtime performance. However, to be a 'manylinux' wheel, these
+# must be removed for maximum portability.
+#
+# If building against tbb is desired, Intel only provides a symlink to embree in the
+# tarball. Symlinks to the correct versions of the libraries must be made.
+#
+# Uncomment this code to build against tbb:
+#
+# cd embree/lib
+# ln -s libtbb.so.2 libtbb.so
+# ln -s libtbbmalloc.so.2 libtbbmalloc.so
+# cd ../..
+
+# pyembree looks for headers in embree subfolder
+mv embree pyembree

ci/embree_macos.bash

@@ -0,0 +1,21 @@
+#!/bin/bash
+set -xe
+
+VERSION="2.17.7"
+
+rm -rf embree.tar.gz
+rm -rf embree
+
+wget -nv https://github.com/embree/embree/releases/download/v${VERSION}/embree-${VERSION}.x86_64.macosx.tar.gz -O embree.tar.gz
+tar -zxvf embree.tar.gz
+rm -f embree.tar.gz
+
+if [[ ! -d pyembree/embree ]]; then
+    mkdir -p pyembree/embree
+fi
+
+# Rename unzipped folder for cdef extern statements
+mv "embree-${VERSION}.x86_64.macosx" embree
+
+# pyembree looks for headers in embree subfolder
+mv embree pyembree

ci/embree_windows.bat

@@ -0,0 +1,9 @@
+curl -L -o embree.zip https://github.com/embree/embree/releases/download/v2.17.7/embree-2.17.7.x64.windows.zip
+7z x embree.zip
+del embree.zip
+
+@REM Rename unzipped folder for cdef extern statements
+ren embree-2.17.7.x64.windows embree
+
+@REM pyembree looks for headers in embree subfolder
+move /Y embree pyembree