Skip to content

documentation: Update quickstart README #1174

documentation: Update quickstart README

documentation: Update quickstart README #1174

Workflow file for this run

name: Python Checks
on:
# Runs at every push on main
push:
branches: main
# Runs at every pull request
pull_request:
types: [opened, synchronize, reopened]
# Runs at every pull request review
pull_request_review:
types: submitted
# Runs manually via Run Workflow in GitHub Actions
workflow_dispatch:
# Runs every Monday at 12:00 UTC
schedule:
- cron: '0 12 * * 1'
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Python
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
cache: 'pip'
# Dependencies
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install -r base-requirements.txt
pip install ruff mypy
# Ruff
- name: Ruff
run: |
ruff check --output-format=github .
ruff check --select I --output-format=github .
# MyPy
- name: MyPy
run: mypy --explicit-package-bases .
# Set PYTHONPATH
- name: Set PYTHONPATH
run: echo "PYTHONPATH=$(pwd)" >> $GITHUB_ENV