Skip to content
Back to pull request #15

Add API documentation #175

Sign in to view logs

Add API documentation

Add API documentation #175

Workflow file for this run

.github/workflows/ci.yaml at 4fa7307
name: Continuous integration
on: [push, pull_request]
env:
REQUIRED_PACKAGES: make
jobs:
format-code:
name: Check code format
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Check code format
run: make check-format
format-import:
name: Check imports sorting
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Check code import format
run: make check-import-sorting
lint-style:
name: Check code style
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Check code style
run: make check-style
lint-typing:
name: Check static typing
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Check code static typing
run: make check-typing
lint-poetry:
name: Check poetry configuration
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Check poetry configuration
run: make check-poetry
lint-docs:
name: Check documentation
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Check docs
run: make check-docs
build-docs:
name: Build documentation
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Build docs
run: make build-docs
test:
name: Run test suite
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Run test suite
run: make test
test-update:
name: Run test suite with updated dependencies
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES}
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Update locked dependencies
run: make update
- name: Run test suite
run: make test
test-pip:
name: Run test suite with pip installation
strategy:
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: "3.9"
- name: Install SDK
run: pip install .
- name: Run test suite
run: python -m unittest -v
test-readme:
name: Run example code from readme
runs-on: ubuntu-latest
container: python:3.9-slim
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Install required packages
run: apt update && apt install -y ${REQUIRED_PACKAGES} cargo
- name: Install tangler
run: cargo install [email protected]
- name: Install Poetry
run: pip install poetry
- name: Create virtual environment
run: make install
- name: Extract code from readme
run: /github/home/.cargo/bin/tangler python < README.md > readme.py
- name: Run code from readme
run: poetry run python readme.py