Skip to content

Update README.md

Update README.md #12

Workflow file for this run

name: Enforce Code Quality
on:
workflow_dispatch:
pull_request:
push:
branches:
- v2_main
jobs:
lint:
name: Ensuring Types are correct.
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.14"
- name: Create a virtual environment
run: uv venv
- name: Install development dependencies
run: uv pip install -e ".[dev]"
- name: Run the Linter and Formatter.
run: uv run hatch run dev:lint
# DEV NOTE: @boonhapus, 2025/01/06
# DISABLE UNTIL WE CLEAN UP TYPES
#
# typecheck:
# name: Ensuring Python type-hints are correct.
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v4
# - name: Install uv
# uses: astral-sh/setup-uv@v5
# with:
# version: "0.5.14"
# - name: Create a virtual environment
# run: uv venv
# - name: Install development dependencies
# run: uv pip install -e ".[dev]"
# - name: Run the type checker.
# run: uv run hatch run dev:typecheck
test:
name: Testing on Python ${{ matrix.python-version }} and ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest, macos-latest, windows-latest]
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
steps:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
with:
version: "0.5.14"
python-version: ${{ matrix.python-version }}
- name: Create a virtual environment
run: uv venv
- name: Install development dependencies
run: uv pip install -e ".[dev]"
- name: Run testing
run: uv run hatch run dev:test