python-app.yml

# 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: Python application

on:
  push:
    branches: [ main ]
  pull_request:
    branches: [ main ]

jobs:
  build:

    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: Set up Python 3.10
      uses: actions/setup-python@v2
      with:
        python-version: "3.10"
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install flake8 pytest
        pip install .
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # Lint with the following exceptions
        # - F403: import *
        # - F405: import *
        # - W504: whitespace after binary operator (I prefer having the whitespace)
        flake8 eci --count --exit-zero --statistics --ignore=F403,F405,W504 --max-line-length=120
    - name: Test with pytest
      run: |
        pytest
    - name: Build readthedocs
      run: |
        cd docs
        pip install sphinx sphinx-rtd-theme
        make html