Merge pull request #51 from AdaptiveParticles/versioning

tag-based versioning and deployment

Author: cheesema

.github/workflows/build-test.yml

@@ -35,6 +35,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
         with:
+          fetch-depth: 0
           submodules: true
 
       - name: Submodule recursive
@@ -93,13 +94,12 @@ jobs:
         run: |
           python -m venv venv
           source venv/bin/activate
-          pip install wheel
-          pip install setuptools
+          pip install wheel setuptools setuptools_scm
           python3 setup.py bdist_wheel -b ${{ env.CMAKE_BUILD_DIR }}
 
       - name: Python Install
         run: |
-          pip install --find-links=dist pyapr
+          pip install dist/pyapr*.whl
 
       - name: Python Test
         run: |

.github/workflows/main.yml

@@ -1,22 +1,26 @@
 # This is a basic workflow to help you get started with Actions
 
-name: Build and Deploy
+name: build
 
 # Controls when the workflow will run
 on:
   # Triggers the workflow on push or pull request events but only for the master branch
   push:
-    branches: [master, develop]
+    branches:
+      - master
+    tags:
+      - "v*"
   pull_request:
-    branches: [ master, develop ]
+    branches:
+      - master
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  job:
-    name: ${{ matrix.os }}-build-and-test
+  build-wheels:
+    name: ${{ matrix.os }} build and test wheels
     runs-on: ${{ matrix.os }}
     strategy:
       fail-fast: false
@@ -25,17 +29,13 @@ jobs:
         include:
           - os: windows-latest
             triplet: x64-windows
-            openmp: ON
-            builddir: dist/wheelhouse
-            builddir1: dist
+            builddir: dist
           - os: ubuntu-latest
             triplet: x64-linux
             builddir: wheelhouse
-            builddir1: wheelhouse
           - os: macos-latest
             triplet: x64-osx
             builddir: wheelhouse
-            builddir1: wheelhouse
     env:
       # Indicates the CMake build directory where project files and binaries are being produced.
       CMAKE_BUILD_DIR: ${{ github.workspace }}/builddir/
@@ -45,16 +45,17 @@ jobs:
       CIBW_BUILD: "cp36-* cp37-* cp38-* cp39-*"
       CIBW_ARCHS: "auto64"
       CIBW_MANYLINUX_X86_64_IMAGE: "manylinux_2_24"
-      TWINE_USERNAME: __token__
-      CIBW_BUILD_VERBOSITY: 3
+      CIBW_BUILD_VERBOSITY: 1
       CIBW_REPAIR_WHEEL_COMMAND_MACOS: "pip uninstall -y delocate && pip install git+https://github.com/Chia-Network/delocate.git && delocate-listdeps {wheel} && delocate-wheel -w {dest_dir} -v {wheel}"
-#      CIBW_BEFORE_TEST_LINUX: "pip install -r requirements.txt"
-#      CIBW_TEST_COMMAND_LINUX: "python3 -m unittest discover -s ${{ github.workspace }}"
+      CIBW_REPAIR_WHEEL_COMMAND_WINDOWS: "pip install -U wheel delvewheel && python fix_windows_wheel.py {wheel} {dest_dir}"
+      CIBW_TEST_COMMAND: "python3 -m unittest discover -s {project}"
+      CIBW_TEST_SKIP: "*-win_amd64"  # skip tests on windows
       CIBW_BEFORE_BUILD_LINUX: "apt update && apt install -y libtiff5-dev libhdf5-dev"
 
     steps:
       - uses: actions/checkout@v2
         with:
+          fetch-depth: 0
           submodules: true
 
       - name: Submodule recursive
@@ -81,7 +82,7 @@ jobs:
           key: |
             ${{ hashFiles( 'external/LibAPR/vcpkg.json' ) }}-${{ hashFiles( '.git/modules/vcpkg/HEAD' )}}-${{ matrix.triplet }}-invalidate
 
-      - name: check file paths
+      - name: Check file paths
         run: |
           cd ${{ github.workspace }}/external/LibAPR/vcpkg/scripts/buildsystems/
           ls
@@ -111,24 +112,84 @@ jobs:
 
       - name: Run cibuildwheel
         run: |
-          python3 -m cibuildwheel --output-dir ${{matrix.builddir1}}
+          python3 -m cibuildwheel --output-dir ${{matrix.builddir}}
 
-      - name: Fix windows wheels
-        if: contains(matrix.os,'windows')
+      - name: Upload wheels as artifacts
+        uses: actions/upload-artifact@v2
+        with:
+          name: ${{ matrix.os }}-wheels
+          path: ${{matrix.builddir}}/
+          retention-days: 5
+
+  windows-tests:
+    name: windows py${{ matrix.python-version }} tests
+    runs-on: windows-latest
+    needs: build-wheels
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+        include:
+          - os: windows-latest
+            triplet: x64-windows
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          submodules: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Download wheels from artifacts
+        uses: actions/download-artifact@v2
+        with:
+          name: windows-latest-wheels
+          path: wheelhouse
+
+      - name: Set version string
+        shell: bash
+        run: echo "py_version_str=cp$(echo ${{ matrix.python-version }} | tr -d -c 0-9)" >> $GITHUB_ENV
+
+      - name: Install package from wheel
+        shell: bash
         run: |
-          python3 -m pip install wheel
-          python3 -m pip install delvewheel
-          python3 fix_windows_wheel.py
+          ls -R wheelhouse
+          python -m pip install --upgrade pip
+          pip install wheelhouse/pyapr-*${{ env.py_version_str }}*.whl
 
-      - name: Install twine
+      - name: Run tests
         run: |
-          python3 -m pip install twine
+          python -m unittest discover -s ${{ github.workspace }}
+
 
-      - name: Publish to test Pypi
+  deploy:
+    runs-on: ubuntu-latest
+    needs: windows-tests
+    name: publish to pypi
+    if: contains(github.ref, 'tags')  # only run on tagged commits starting with "v*"
+    steps:
+      - name: Download wheels from artifacts
+        uses: actions/download-artifact@v2
+        with:
+          path: wheelhouse
+
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+
+      - name: Install dependencies
         run: |
-          python3 -m twine upload --skip-existing --repository pypi ${{matrix.builddir}}/*.whl -p ${{ secrets.PYPI_API_TOKEN }}
+          python -m pip install --upgrade pip
+          pip install -U twine
 
-#      - name: Test release from pypi 3.7
-#        run: |
-#          pip install pyapr
-#          python3 -m unittest
+      - name: Publish
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+        run: |
+          twine upload wheelhouse/*wheels/*.whl

.gitignore

@@ -109,3 +109,7 @@ venv.bak/
 
 data/
 /processing
+
+# written by setuptools_scm
+**/_version.py
+

INSTALL.md

@@ -0,0 +1,78 @@
+### Dependencies
+
+[LibAPR](https://github.com/AdaptiveParticles/LibAPR) is included as a submodule, and built alongside the wrappers.
+This requires the following packages:
+
+* HDF5 1.8.20 or higher
+* OpenMP > 3.0 (optional, but recommended)
+* CMake 3.6 or higher
+* LibTIFF 4.0 or higher
+
+The Python library additionally requires Python 3, and the packages listed in [requirements.txt](requirements.txt).
+
+### Installing dependencies on Linux
+
+On Ubuntu, install the `cmake`, `build-essential`, `libhdf5-dev` and `libtiff5-dev` packages (on other distributions,
+refer to the documentation there, the package names will be similar). OpenMP support is provided by the GCC compiler
+installed as part of the `build-essential` package.
+
+### Installing dependencies on OSX
+
+On OSX, install the `cmake`, `hdf5` and `libtiff`  [homebrew](https://brew.sh) packages and have the
+[Xcode command line tools](http://osxdaily.com/2014/02/12/install-command-line-tools-mac-os-x/) installed.
+If you want to compile with OpenMP support, also install the `llvm` package (this can also be done using homebrew),
+as the clang version shipped by Apple currently does not support OpenMP.
+
+### Note for windows users
+
+Please see https://github.com/AdaptiveParticles/LibAPR for the latest windows install instructions.
+
+## Building
+
+The repository requires submodules, so the repository needs to be cloned recursively:
+
+```
+git clone --recursive https://github.com/AdaptiveParticles/PyLibAPR.git
+```
+
+It is recommended to use a virtual environment, such as `virtualenv`. To set this up, use e.g.
+
+```
+pip3 install virtualenv
+python3 -m virtualenv myenv
+source myenv/bin/activate
+```
+
+The required Python packages can be installed via the command
+```
+pip install -r requirements.txt 
+```
+
+Once the dependencies are installed, PyLibAPR can be built via the setup.py script:
+```
+python setup.py install
+```
+
+### CMake build options
+
+There are two CMake options that can be given to enable or disable OpenMP and CUDA:
+
+| Option | Description | Default value |
+|:--|:--|:--|
+| PYAPR_USE_OPENMP | Enable multithreading via OpenMP | ON |
+| PYAPR_USE_CUDA | Build available CUDA functionality | OFF |
+| PYAPR_PREFER_EXTERNAL_LIBAPR | Use an installed version of LibAPR (if found) rather than building it from submodules | OFF |
+
+When building via the setup.py script, these options can be set via the environment variable `EXTRA_CMAKE_ARGS`. For example,
+```
+EXTRA_CMAKE_ARGS="-DPYAPR_USE_OPENMP=OFF -DPYAPR_USE_CUDA=OFF" python setup.py install
+```
+will install the package with both OpenMP and CUDA disabled. If building from an installed version of LibAPR in a non-standard
+location, help CMake find it, e.g., by passing `-DCMAKE_PREFIX_PATH=/path/to/APR`.
+
+### OpenMP support on OSX
+
+To use the homebrew-installed clang for OpenMP support on OSX, modify the call above to
+```
+CPPFLAGS="-I/usr/local/opt/llvm/include" LDFLAGS="-L/usr/local/opt/llvm/lib -Wl,-rpath,/usr/local/opt/llvm/lib" CXX="/usr/local/opt/llvm/bin/clang++" CC="/usr/local/opt/llvm/bin/clang" python setup.py install 
+```