Merge pull request #116 from automl/better-action-workflow

ci: Test against 3.9,  3.10 and 3.11

Author: sarah-segel

.github/workflows/docs.yml

@@ -1,5 +1,9 @@
 name: docs
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 on:
   # Trigger manually
   workflow_dispatch:
@@ -22,19 +26,22 @@ env:
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
+    defaults:
+      run:
+        shell: bash # Default to using bash on all
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Setup Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: 3.9
 
     - name: Install dependencies
       run: |
         pip install .
-        pip install .[dev]
+        pip install ".[dev]"
 
     - name: Make docs
       run: |

.github/workflows/pytest.yml

@@ -1,25 +1,50 @@
 name: tests
-on: [ push ]
+
+# Cancel previous tests for this branch if a new commit is pushed
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+on:
+  # Allow manual trigger of workflow
+  workflow_dispatch:
+
+  # Run tests on push/merge to main
+  push:
+    branches:
+      - main
+
+  # Run tests on anything that has a pull request to main/development
+  pull_request:
+    branches:
+      - main
+      - development
+
 jobs:
   pytest:
-    name: PyTest
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Add conda to system path
-        run: |
-          # $CONDA is an environment variable pointing to the root of the miniconda directory
-          echo $CONDA/bin >> $GITHUB_PATH
+    name: Test ${{ matrix.python-version }}-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    defaults:
+      run:
+        shell: bash # Default to using bash on all
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10"] # "3.11" fails due to swig
+        os: ["ubuntu-latest"] # "macos-latest", "windows-latest" fails due to swig
 
+    steps:
+      - uses: actions/checkout@v4
       - name: Setup Python 3.9
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.9
+          python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
-          conda install -c anaconda swig
-          make install-dev
-          
-      - name: Run pytest 
+          pip install swig
+          python -m pip install ".[dev]"
+
+      - name: Run pytest
         run: pytest tests

pyproject.toml

@@ -3,53 +3,53 @@
 
 [tool.pytest.ini_options]
 testpaths = ["tests"]      # path to the test directory
-minversion = "3.8"
+minversion = "3.9"
 addopts = "--cov=deepcave" # Should be package name
 
 [tool.coverage.run]
 branch = true
 context = "deepcave" # Should be package name
 omit = [
-    "deepcave/__init__.py", # Has variables only needed for setup.py
+  "deepcave/__init__.py", # Has variables only needed for setup.py
 ]
 
 [tool.coverage.report]
 show_missing = true
 skip_covered = true
 exclude_lines = [
-    "pragma: no cover",
-    '\.\.\.',
-    "raise NotImplementedError",
-    "if TYPE_CHECKING",
+  "pragma: no cover",
+  '\.\.\.',
+  "raise NotImplementedError",
+  "if TYPE_CHECKING",
 ] # These are lines to exclude from coverage
 
 [tool.black]
-target-version = ['py38']
+target-version = ['py39']
 line-length = 100
 
 [tool.isort]
-py_version = "38"
+py_version = "39"
 profile = "black" # Play nicely with black
 src_paths = ["deepcave", "tests"]
 known_types = ["typing", "abc"] # We put these in their own section "types"
 known_test = ["tests"]
 known_first_party = ["deepcave"]
 sections = [
-    "FUTURE",
-    "TYPES",
-    "STDLIB",
-    "THIRDPARTY",
-    "FIRSTPARTY",
-    "TEST",
-    "LOCALFOLDER",
+  "FUTURE",
+  "TYPES",
+  "STDLIB",
+  "THIRDPARTY",
+  "FIRSTPARTY",
+  "TEST",
+  "LOCALFOLDER",
 ] # section ordering
 multi_line_output = 3 # https://pycqa.github.io/isort/docs/configuration/multi_line_output_modes.html
 
 [tool.pydocstyle]
 convention = "numpy"
 add-ignore = [ # http://www.pydocstyle.org/en/stable/error_codes.html
-    "D105", # Missing docstring in magic method
-    "D212", # Multi-line docstring summary should start at the first line
+  "D105", # Missing docstring in magic method
+  "D212", # Multi-line docstring summary should start at the first line
 ]
 
 [tool.mypy]
@@ -68,5 +68,5 @@ module = ["setuptools.*"]     # Add modules that give import errors here
 ignore_missing_imports = true
 
 [[tool.mypy.overrides]]
-module = ["tests.*"]                # pytest uses decorators which are not typed in 3.8
+module = ["tests.*"]                # pytest uses decorators which are not typed in 3.9
 disallow_untyped_decorators = false # decorators in testing are not all annotated

setup.py

@@ -1,12 +1,12 @@
-# -*- encoding: utf-8 -*-
+from __future__ import annotations
+
 import setuptools
 from deepcave import version
 
 
 def read_file(file_name):
     with open(file_name, encoding="utf-8") as fh:
-        text = fh.read()
-    return text
+        return fh.read()
 
 
 extras_require = {
@@ -50,7 +50,7 @@ def read_file(file_name):
         exclude=["*.tests", "*.tests.*", "tests.*", "tests"],
     ),
     include_package_data=True,
-    python_requires=">=3.9, <3.10",
+    python_requires=">=3.9, <3.11",
     install_requires=read_file("./requirements.txt").split("\n"),
     extras_require=extras_require,
     entry_points={
@@ -60,6 +60,7 @@ def read_file(file_name):
     platforms=["Linux"],
     classifiers=[
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
         "Development Status :: 3 - Alpha",
         "Natural Language :: English",
         "Environment :: Console",