Merge pull request #90 from dianna-ai/test_notebooks

Add testing of tutorial notebooks using nbmake

Author: egpbos

.github/actions/install-python-and-package/action.yml

@@ -0,0 +1,26 @@
+name: "Install Python and DIANNA"
+description: "Installs Python, updates pip and installs DIANNA together with its dependencies."
+inputs:
+  python-version:
+    required: false
+    description: "The Python version to use. Specify major and minor version, e.g. '3.9'."
+    default: "3.9"
+runs:
+  using: "composite"
+  steps:
+    - name: Set up Python ${{ inputs.python-version }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ inputs.python-version }}
+        cache: 'pip'
+        cache-dependency-path: setup.cfg
+    - name: Python info
+      shell: bash {0}
+      run: |
+        which python3
+        python3 --version
+    - name: Upgrade pip and install dependencies
+      shell: bash {0}
+      run: |
+        python3 -m pip install --upgrade pip setuptools
+        python3 -m pip install .[dev,publishing]

.github/workflows/build.yml

@@ -1,4 +1,4 @@
-name: Python package
+name: build
 
 on:
   push:
@@ -20,19 +20,9 @@ jobs:
         python-version: ['3.7', '3.8', '3.9']
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+      - uses: ./.github/actions/install-python-and-package
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Python info
-        shell: bash -l {0}
-        run: |
-          which python3
-          python3 --version
-      - name: Upgrade pip and install dependencies
-        run: |
-          python3 -m pip install --upgrade pip setuptools
-          python3 -m pip install .[dev,publishing]
       - name: Run unit tests
         run: pytest -v
       - name: Verify that we can build the package

.github/workflows/linting.yml

@@ -17,19 +17,7 @@ jobs:
       fail-fast: false
     steps:
       - uses: actions/checkout@v2
-      - name: Set up Python 3.9
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Python info
-        shell: bash -l {0}
-        run: |
-          which python3
-          python3 --version
-      - name: Upgrade pip and install dependencies
-        run: |
-          python3 -m pip install --upgrade pip setuptools
-          python3 -m pip install .[dev,publishing]
+      - uses: ./.github/actions/install-python-and-package
       - name: Check style against standards using prospector
         run: prospector
       - name: Check import order

.github/workflows/notebooks.yml

@@ -0,0 +1,24 @@
+name: notebooks
+
+on:
+  push:
+    branches:
+    - main
+  pull_request:
+    branches:
+    - main
+
+jobs:
+
+  notebooks:  
+    name: Run notebooks on (3.9, ${{ matrix.os }})
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/install-python-and-package
+      - name: Run tutorial notebooks
+        run: pytest --nbmake tutorials

.github/workflows/release.yml

@@ -13,15 +13,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/setup-python@v2
-        name: Install Python
-        with:
-          python-version: '3.9'
-
-      - name: Upgrade pip and install dependencies
-        run: |
-          python3 -m pip install --upgrade pip setuptools
-          python3 -m pip install .[publishing]
+      - uses: ./.github/actions/install-python-and-package
 
       - name: Build wheel
         run: python setup.py bdist_wheel
@@ -36,15 +28,7 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - uses: actions/setup-python@v2
-        name: Install Python
-        with:
-          python-version: '3.9'
-
-      - name: Upgrade pip and install dependencies
-        run: |
-          python3 -m pip install --upgrade pip setuptools
-          python3 -m pip install .[publishing]
+      - uses: ./.github/actions/install-python-and-package
 
       - name: Build sdist
         run: python setup.py sdist

.github/workflows/sonarcloud.yml

@@ -18,17 +18,7 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.9
-      - name: Python info
-        shell: bash -l {0}
-        run: |
-          which python3
-          python3 --version
-      - name: Install dependencies
-        run: python3 -m pip install .[dev]
+      - uses: ./.github/actions/install-python-and-package
       - name: Check style against standards using prospector
         run: prospector --zero-exit --output-format grouped --output-format pylint:pylint-report.txt
       - name: Run unit tests with coverage

setup.cfg

@@ -65,6 +65,7 @@ dev =
     sphinx-autoapi
     torchtext
     coverage [toml]
+    nbmake
 publishing =
     twine
     wheel