Skip to content

Update README.md

Update README.md #63

Workflow file for this run

name: CI
on:
push:
pull_request:
jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: pip
- name: Install lint dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[lint]
- name: Run ruff
run: ruff check .
- name: Run black
run: black --check .
- name: Run mypy
run: mypy src/spot_api
tests:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ['3.11', '3.12']
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
cache: pip
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[test]
- name: Run tests with coverage
run: |
pytest --cov=spot_api --cov-report=term-missing --cov-fail-under=80
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: pip
- name: Install documentation dependencies
run: |
python -m pip install --upgrade pip
pip install -e .[docs]
- name: Build documentation
working-directory: docs
run: sphinx-build -b html . _build/html