Skip to content

Update docs

Update docs #36

Workflow file for this run

# This workflow will install Python dependencies, run tests and lint with a
# variety of Python versions. For more information see:
# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Automatic testing
on:
push:
# Run the automatic tests only on the master branch for now. Maybe it could
# be useful to automatically test new branches as well (before merging
# to master), but how to have a specific badge for testing on master, while
# allowing tests on other branches?
branches: [ "master" ]
pull_request:
branches: [ "master" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
steps:
# Get the source code
- uses: actions/checkout@v3
# Install Python (multiple versions due to the matrix)
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
# Install the source code dependencies + pytest (for the next step)
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install pytest
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
# Using Pytest as an orchestrator for our unittest-based test files.
# For some reason, unittest does not seem to find them automatically...
- name: Test with pytest
run: python -m pytest tests