Skip to content

Refactor NGFF module and migrate to Pydantic v2 #455

Refactor NGFF module and migrate to Pydantic v2

Refactor NGFF module and migrate to Pydantic v2 #455

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://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
name: lint, style, and tests
on:
pull_request:
branches:
- main
- unified-api
jobs:
style:
name: Style Check
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10"]
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install black
- name: Check code styling with Black
run: |
black --diff -S -t py310 iohub
black --check -S -t py310 iohub
lint:
name: Lint Check
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10"]
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8
- name: Check code with Flake8
# E203 conflicts with black
run: |
flake8 iohub --extend-ignore=E203
isort:
name: isort Check
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10"]
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install isort
- name: Check code with isort
run: |
isort --check iohub
tests:
needs: [style, lint, isort]
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["3.10", "3.11", "3.12"]
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install ".[dev]"
- name: Test with pytest
run: |
pytest -v --cov=./ --cov-report=xml
# this checks that docs build and examples run
# but does not deploy to GH Pages
docs:
needs: [style, lint, isort]
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-python@v4
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install ".[doc]"
- name: Test docs build
working-directory: ./docs
run: |
make build