Configure Renovate

.flake8

@@ -6,6 +6,6 @@ max-line-length = 88
 # D100-D107: Missing docstrings
 # D200: One-line docstring should fit on one line with quotes.
 extend-ignore = E203,E402,F401,D100,D101,D102,D103,D104,D105,D106,D107,D200
-docstring-convention = numpy
+; docstring-convention = numpy
 # Ignore missing docstrings within unit testing functions.
 per-file-ignores = **/tests/:D100,D101,D102,D103,D104,D105,D106,D107

.github/pull_request_template.md

@@ -1,5 +1,5 @@
 <!-- Change the ## to your pull request number -->
-![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/vbadenas/9b54bd086e121233d2ad9a62d2136258/raw/frarch__pull_##.json)
+![Coverage Badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/victorbadenas/9b54bd086e121233d2ad9a62d2136258/raw/frarch__pull_##.json)
 
 **Notes for reviewer:**
 

.github/workflows/docs.yaml

@@ -0,0 +1,66 @@
+# Docs workflow
+#
+# Ensures that the docs can be built with sphinx.
+# - On every push and PR, checks the HTML documentation builds on linux.
+# - On every PR and tag, checks the documentation builds as a PDF on linux.
+# - If your repository is public, on pushes to the default branch (i.e. either
+#   master or main), the HTML documentation is pushed to the gh-pages branch,
+#   which is automatically rendered at the publicly accessible url
+#   https://USER.github.io/PACKAGE/
+
+name: docs
+
+on: [push, pull_request]
+
+jobs:
+  docs-html:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Build HTML docs
+      uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "docs/"
+
+    - name: Determine default branch
+      run: |
+        DEFAULT_BRANCH=$(git remote show origin | awk '/HEAD branch/ {print $NF}')
+        echo "default_branch=$DEFAULT_BRANCH" >> $GITHUB_ENV
+        echo "default_branch_ref=refs/heads/$DEFAULT_BRANCH" >> $GITHUB_ENV
+
+    - name: Determine whether repo is public
+      run: |
+        REMOTE_HTTP=$(git remote get-url origin | sed -e "s|:\([^/]\)|/\1|g" -e "s|^git@|https://|" -e "s|\.git$||")
+        echo "Probing $REMOTE_HTTP"
+        if wget -q --method=HEAD ${REMOTE_HTTP}; then IS_PUBLIC=1; else IS_PUBLIC=0; fi
+        echo "is_public=$IS_PUBLIC"
+        echo "is_public=$IS_PUBLIC" >> $GITHUB_ENV
+
+    - name: Deploy to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == env.default_branch_ref && env.is_public == 1
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: "docs/_build/html/"
+
+  # docs-pdf:
+  #   if: |
+  #     github.event_name == 'pull_request' ||
+  #     startsWith(github.ref, 'refs/tags/')
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #   - uses: actions/checkout@v2
+
+  #   - name: Build PDF docs
+  #     uses: ammaraskar/sphinx-action@master
+  #     with:
+  #       docs-folder: "docs/"
+  #       pre-build-command: "apt-get update -y && apt-get install -y latexmk texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended"
+  #       build-command: "make latexpdf"
+
+  #   - uses: actions/upload-artifact@v2
+  #     if: startsWith(github.ref, 'refs/tags')
+  #     with:
+  #       name: Documentation
+  #       path: docs/_build/latex/*.pdf

.github/workflows/python-app.yml

@@ -1,23 +1,9 @@
 # This workflow will install Python dependencies, run tests and lint with a single version of Python
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: frarch CI
-
-on:
-  push:
-    branches:
-      - master
-      - development
-      - feature_*
-      - fix_*
-    tags:
-      - v*
-  pull_request:
-    branches:
-      - master
-      - development
-      - feature_*
-      - fix_*
+name: CI
+
+on: [push, pull_request]
 
 jobs:
   build:
@@ -28,7 +14,7 @@ jobs:
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python }}
       uses: actions/setup-python@v2
       with:
@@ -42,27 +28,30 @@ jobs:
   unittest:
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
         python: [3.7, 3.8, 3.9]
-    runs-on: ${{ matrix.os }}
-    needs: [ build ]
+    runs-on: ubuntu-latest
+    needs: [build]
+
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
+
     - name: Set up Python ${{ matrix.python }}
       uses: actions/setup-python@v2
       with:
         python-version: ${{ matrix.python }}
+
     - name: install
       run: |
         python -m pip install --upgrade pip
         pip install coverage
         python setup.py -q install
+
     - name: test
       run: |
-        coverage run -m unittest discover
-        coverage report -m --omit='tests/*'
+        coverage run -m unittest discover -s tests/unit
+        coverage report -m --omit='tests/unit/*'
 
-    - if: ${{ matrix.python == '3.9' && matrix.os == 'ubuntu-latest' }}
+    - if: ${{ matrix.python == '3.9' }}
       name: Get Coverage for badge
       run: |
         coverage json
@@ -75,7 +64,7 @@ jobs:
         echo $BRANCH_NAME
         echo "BRANCH=$(echo ${BRANCH_NAME})" >> $GITHUB_ENV
 
-    - if: ${{ matrix.python == '3.9' && matrix.os == 'ubuntu-latest' }}
+    - if: ${{ matrix.python == '3.9' }}
       name: Create the Badge
       uses: schneegans/[email protected]
       with:
@@ -85,14 +74,62 @@ jobs:
         label: Test Coverage
         message: ${{ env.COVERAGE }}
         color: green
-        namedLogo: Python
+        namedLogo: codecov
+
+  unittest-cross-platform:
+    strategy:
+      matrix:
+        os: [macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    needs: [build]
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Python 3.9
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+
+    - name: install
+      run: |
+        python -m pip install --upgrade pip
+        pip install coverage
+        python setup.py -q install
+
+    - name: test
+      run: |
+        coverage run -m unittest discover -s tests/unit
+        coverage report -m --omit='tests/unit/*'
 
-  release-and-package:
+  functional:
+    strategy:
+      matrix:
+        python: [3.7, 3.8, 3.9]
     runs-on: ubuntu-latest
     needs: [build, unittest]
     steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python }}
+      uses: actions/setup-python@v2
+      with:
+        python-version: ${{ matrix.python }}
+    - name: install
+      run: |
+        python -m pip install --upgrade pip
+        pip install coverage
+        python setup.py -q install
+    - name: functional-test
+      run: |
+        cd tests/functional
+        ./runFunctionalTests.sh
+
+  package-and-release:
+    runs-on: ubuntu-latest
+    needs: [build, unittest, functional]
+    steps:
     - name: checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Set up Python 3.7
       uses: actions/setup-python@v2