Refactor setup.py and publish workflow (#59)

This change includes building PortAudio for the specific platform on install. Prior to this, the user had to install PortAudio from the system package manager before installing PyAudio. Now, we can ship with Pyaudio included and give users microphone support just from the pip install. Another part of this refactor, introduced the ability to build multi-platform wheels through ciwheelbuilder. This should make installing spokestack faster/easier for all platforms.

Author: will-rice

.github/workflows/github-deploy.yml

@@ -0,0 +1,73 @@
+name: Build and upload to PyPI
+
+on:
+  push:
+  pull_request:
+  release:
+    types:
+      - published
+
+jobs:
+  build_wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, windows-2019, macos-10.15]
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: "3.8"
+
+      - name: Install Visual C++ for Python 2.7
+        if: runner.os == 'Windows'
+        run: choco install vcpython27 -f -y
+
+      - name: Build wheels
+        uses: joerick/cibuildwheel@v1.10.0
+
+      - uses: actions/upload-artifact@v2
+        with:
+          path: ./wheelhouse/*.whl
+
+  build_sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
+
+      - uses: actions/setup-python@v2
+        name: Install Python
+        with:
+          python-version: "3.8"
+
+      - name: Build sdist
+        run: python setup.py sdist
+
+      - uses: actions/upload-artifact@v2
+        with:
+          path: dist/*.tar.gz
+
+  upload_pypi:
+    needs: [build_wheels, build_sdist]
+    runs-on: ubuntu-latest
+    # publish when a GitHub Release is created
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - uses: actions/download-artifact@v2
+        with:
+          name: artifact
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@master
+        with:
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_PASSWORD }}

.github/workflows/python-publish.yml

@@ -1,3 +1,6 @@
 [submodule "spokestack/extensions/webrtc/filter_audio"]
 path = spokestack/extensions/webrtc/filter_audio
 url = https://github.com/irungentoo/filter_audio.git
+[submodule "spokestack/extensions/portaudio"]
+path = spokestack/extensions/portaudio
+url = https://github.com/PortAudio/portaudio

.gitmodules

@@ -0,0 +1 @@
+recursive-include spokestack/extensions/portaudio

MANIFEST.in

@@ -1,2 +1,2 @@
 [build-system]
-requires = ["setuptools", "wheel", "Cython"]
+requires = ["setuptools", "wheel", "numpy", "Cython"]

pyproject.toml

@@ -7,6 +7,7 @@ license_files = LICENSE.txt
 # black compatible flake8 config
 max-line-length = 88
 extend-ignore = E203, W503
+exclude = spokestack/extensions
 
 [tool.isort]
 # black compatible isort config

setup.cfg

@@ -1,8 +1,57 @@
 import os
+import subprocess
+import sys
+
+from setuptools import Extension, find_packages, setup
+from setuptools.command.build_py import build_py
+
+
+try:
+    from numpy import get_include
+except ImportError:
+    subprocess.check_call([sys.executable, "-m", "pip", "install", "numpy"])
+    from numpy import get_include
+
+try:
+    from Cython.Build import cythonize
+except ImportError:
+    subprocess.check_call([sys.executable, "-m", "pip", "install", "Cython"])
+    from Cython.Build import cythonize
+
+
+class CustomBuild(build_py):  # type: ignore
+    """Custom build command to build PortAudio."""
+
+    def run(self) -> None:
+        """Custom run function that builds and installs PortAudio/PyAudio."""
+
+        if sys.platform == "mingw":
+            # build with MinGW for windows
+            command = ["./configure && make && make install"]
+        elif sys.platform in ["win32", "win64"]:
+            # win32/64 users should install the PyAudio wheel or Conda package
+            command = None
+        else:
+            # macos or linux
+            command = ["./configure && make"]
+
+        if command:
+            # build PortAudio with system specific command
+            subprocess.run(
+                command,
+                shell=True,
+                check=True,
+                cwd="spokestack/extensions/portaudio",
+            )
+            # install PyAudio after PortAudio has been built
+            subprocess.run(
+                [sys.executable, "-m", "pip", "install", "pyaudio"],
+                shell=True,
+                check=True,
+            )
+        # run the normal build process
+        build_py.run(self)
 
-import numpy as np
-import setuptools
-from Cython.Build import cythonize
 
 SOURCES = [
     os.path.join("spokestack/extensions/webrtc", source)
@@ -40,17 +89,17 @@
 ]
 
 EXTENSIONS = [
-    setuptools.Extension(
+    Extension(
         "spokestack.extensions.webrtc.agc",
         ["spokestack/extensions/webrtc/agc.pyx"] + SOURCES,
         include_dirs=["filter_audio/agc/include/"],
     ),
-    setuptools.Extension(
+    Extension(
         "spokestack.extensions.webrtc.nsx",
         ["spokestack/extensions/webrtc/nsx.pyx"] + SOURCES,
         include_dirs=["filter_audio/ns/include/"],
     ),
-    setuptools.Extension(
+    Extension(
         "spokestack.extensions.webrtc.vad",
         ["spokestack/extensions/webrtc/vad.pyx"] + SOURCES,
         include_dirs=["filter_audio/agc/include/"],
@@ -59,23 +108,23 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
-setuptools.setup(
+setup(
     name="spokestack",
-    version="0.0.17",
+    version="0.0.18",
     author="Spokestack",
     author_email="support@spokestack.io",
     description="Spokestack Library for Python",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/spokestack/spokestack-python",
-    packages=setuptools.find_packages(),
+    packages=find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
         "License :: OSI Approved :: Apache Software License",
         "Operating System :: OS Independent",
     ],
     python_requires=">=3.8",
-    setup_requires=["setuptools", "numpy", "Cython"],
+    setup_requires=["setuptools", "wheel", "numpy", "Cython"],
     install_requires=[
         "numpy",
         "Cython",
@@ -84,6 +133,7 @@
         "requests",
     ],
     ext_modules=cythonize(EXTENSIONS),
-    include_dirs=[np.get_include()],
+    include_dirs=[get_include()],
+    cmdclass={"build_py": CustomBuild},
     zip_safe=False,
 )