Skip to content

add documentation to readme #20

add documentation to readme

add documentation to readme #20

Workflow file for this run

name: CI checks
on:
push:
branches:
- main
jobs:
lint:
runs-on: ubuntu-latest
permissions:
contents: 'read'
strategy:
matrix:
python-version: [ '3.8', '3.9' ]
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r requirements-build.txt
poetry install
- name: Lint check
run: |
python -m ruff format --check src/
test:
runs-on: ubuntu-latest
permissions:
contents: 'read'
strategy:
matrix:
python-version: [ '3.8', '3.9' ]
steps:
- name: Check out code
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
pip install --upgrade pip
pip install -r requirements-build.txt
poetry install
- name: Run tests
run: |
python -m pytest