Skip to content

update README

update README #125

Workflow file for this run

name: Python Tests
on:
push:
branches: [main]
paths:
- 'src/**'
pull_request:
paths:
- 'src/**'
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: '3.11.8'
- name: Install Poetry
run: curl -sSL https://install.python-poetry.org/ | python -
- name: Add Poetry to PATH
run: echo "$HOME/.poetry/bin" >> $GITHUB_PATH
- name: Install dependencies
run: poetry install
- name: Check code formatting
run: poetry run ruff format --check src/
- name: Check imports formatting
run: poetry run ruff check src/
# - name: Check type annotations
# run: poetry run mypy --check src/
- name: Run unit tests
run: poetry run make test-ci
- name: Upload coverage to CodeCov
uses: codecov/codecov-action@v4
with:
token: ${{ secrets.CODECOV_SECRET }}
files: coverage.xml
verbose: true