Skip to content

DOC: Update README

DOC: Update README #14

Workflow file for this run

# This workflow will install Python dependencies, run tests and lint with a single version of Python
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: CI
on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]
permissions:
contents: read
jobs:
tests:
name: "Python ${{ matrix.python-version }}"
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macos-12, ubuntu-latest]
python-version: ["3.8", "3.9", "3.10"]
steps:
- uses: "actions/checkout@v3"
with:
fetch-depth: 0
# Setup env
- uses: "actions/setup-python@v3"
with:
python-version: "${{ matrix.python-version }}"
- name: "Install dependencies on ${{ matrix.os }} for Python ${{ matrix.python-version }}"
run: |
python -m pip install --upgrade pip
pip install .
- name: "Generate coverage report on ${{ matrix.os }} for Python ${{ matrix.python-version }}"
run: |
pip install pytest pytest-cov
pytest --cov=./ --cov-report=xml --cov-append