FEAT: ship with built-in FreeImage

.github/workflows/cd.yaml

@@ -0,0 +1,58 @@
+name: CD
+
+# This action builds FreeImage for various distributions, collects the resulting
+# wheels, and publishes them to pypi
+
+on:
+  workflow_dispatch:
+
+
+jobs:
+  wheels:
+    name: Build wheels on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-20.04, windows-2019]
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.8.1
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_SKIP: "cp36-*"
+          CIBW_REPAIR_WHEEL_COMMAND_LINUX: ""
+
+      - uses: actions/upload-artifact@v3
+        with:
+          name: wheelhouse
+          path: ./wheelhouse/*.whl
+
+  deploy:
+    needs: wheels
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+
+      - name: Install Poetry
+        uses: snok/install-poetry@v1
+        with:
+          virtualenvs-create: True
+          virtualenvs-in-project: True
+
+      - name: Download a single artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: wheelhouse
+          path: ./dist/
+
+      - name: Publish Wheels
+        run : |
+          poetry config pypi-token.pypi ${{ secrets.PYPI_ACCOUNT }}
+          poetry publish

.github/workflows/ci.yaml

@@ -36,59 +36,90 @@ jobs:
           linters: flake8
           run: flake8 .
 
-  cpython:
-    name: "${{ matrix.os }} / CPython ${{ matrix.pyversion }}"
-    runs-on: ${{ matrix.os }}
-    strategy:
-      fail-fast: true
-      matrix:
-        os: ["ubuntu-latest", "macos-latest", "windows-latest"]
-        pyversion: ["3.7", "3.8", "3.9", "3.10"]
-    defaults:
-      run:
-        shell: bash
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 2
-      - name: Set up Python ${{ matrix.pyversion }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ matrix.pyversion }}
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
-        with:
-          virtualenvs-create: True
-          virtualenvs-in-project: True
-      - name: Install Project
-        shell: bash
-        run: |
-          poetry install --no-interaction -v
-      - name: Run Tests
-        run: |
-          source $VENV
-          pytest -v --github-username "anything" --github-token ${{ secrets.GITHUB_TOKEN }}
+  # cpython:
+  #   name: "${{ matrix.os }} / CPython ${{ matrix.pyversion }}"
+  #   runs-on: ${{ matrix.os }}
+  #   strategy:
+  #     fail-fast: true
+  #     matrix:
+  #       os: ["ubuntu-latest", "macos-latest", "windows-latest"]
+  #       pyversion: ["3.7", "3.8", "3.9", "3.10"]
+  #   defaults:
+  #     run:
+  #       shell: bash
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #       with:
+  #         fetch-depth: 2
+  #     - name: Set up Python ${{ matrix.pyversion }}
+  #       uses: actions/setup-python@v2
+  #       with:
+  #         python-version: ${{ matrix.pyversion }}
+  #     - name: Install Poetry
+  #       uses: snok/install-poetry@v1
+  #       with:
+  #         virtualenvs-create: True
+  #         virtualenvs-in-project: True
+  #     - name: Install Project
+  #       shell: bash
+  #       run: |
+  #         poetry install --no-interaction -v
+  #     - name: Run Tests
+  #       run: |
+  #         source $VENV
+  #         pytest -v --github-username "anything" --github-token ${{ secrets.GITHUB_TOKEN }}
+
+  # pypy:
+  #   name: "${{ matrix.os }} / ${{ matrix.pyversion }}"
+  #   runs-on: ${{ matrix.os }}
+  #   strategy:
+  #     fail-fast: true
+  #     matrix:
+  #       os: ["ubuntu-latest", "macos-latest"]
+  #       pyversion: ["pypy-3.7", "pypy-3.8", "pypy-3.9"]
+  #   steps:
+  #     - uses: actions/checkout@v2
+  #     - name: Set up pypy
+  #       uses: actions/setup-python@v2
+  #       with:
+  #         python-version: "${{ matrix.pyversion }}"
+  #     - name: Install Poetry & Project
+  #       shell: bash
+  #       run: |
+  #         pypy3 -m pip install poetry
+  #         pypy3 -m poetry config virtualenvs.in-project true
+  #         pypy3 -m poetry install --no-interaction -v
+  #     - name: Run Unit tests
+  #       run: |
+  #         pypy3 -m poetry run pytest -v --github-username "anything" --github-token ${{ secrets.GITHUB_TOKEN }}
 
-  pypy:
-    name: "${{ matrix.os }} / ${{ matrix.pyversion }}"
+  wheels:
+    name: Build wheels on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     strategy:
-      fail-fast: true
       matrix:
-        os: ["ubuntu-latest", "macos-latest"]
-        pyversion: ["pypy-3.7", "pypy-3.8", "pypy-3.9"]
+        os: [macos-11]
+
     steps:
-      - uses: actions/checkout@v2
-      - name: Set up pypy
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v3
+
+      # Used to host cibuildwheel
+      - uses: actions/setup-python@v3
+
+      - name: Install cibuildwheel
+        run: python -m pip install cibuildwheel==2.8.1
+
+      - name: Build wheels
+        run: python -m cibuildwheel --output-dir wheelhouse
+        env:
+          CIBW_SKIP: "cp36-*"
+          CIBW_REPAIR_WHEEL_COMMAND_LINUX: ""
+          # CIBW_BUILD_VERBOSITY: 3
+        # to supply options, put them in 'env', like:
+        # env:
+        #   CIBW_SOME_OPTION: value
+
+      - uses: actions/upload-artifact@v3
         with:
-          python-version: "${{ matrix.pyversion }}"
-      - name: Install Poetry & Project
-        shell: bash
-        run: |
-          pypy3 -m pip install poetry
-          pypy3 -m poetry config virtualenvs.in-project true
-          pypy3 -m poetry install --no-interaction -v
-      - name: Run Unit tests
-        run: |
-          pypy3 -m poetry run pytest -v --github-username "anything" --github-token ${{ secrets.GITHUB_TOKEN }}
+          name: wheelhouse
+          path: ./wheelhouse/*.whl

.gitignore

@@ -1,7 +1,12 @@
 .venv/
 .vscode/
+.test_images/
 **/__pycache__/
 dist/
+FreeImage/
+build/
+*.egg-info/
+imageio_freeimage/_lib/
 
 *.pyc
 poetry.lock

README.md

@@ -50,8 +50,5 @@ their python code in a browser via pyodide. Those use-cases are more prone to
 problems when ctypes are involved and having them in a dedicated optional
 dependency make this situation easier.
 
-3. Having a dedicated repo for the FreeImage plugin will eventually allow us to
-install the FreeImage library at install time, instead of having to ask users to
-perform post-install steps to download the library. This might also have
-positive implications on platform availability and introspection as we can
-eventually compile FreeImage while building the package.
+3. We can add plumbing to compile FreeImage in CD and ship it precompiled
+   without the need for any post-install actions.