Skip to content

Update README with chapter details and optional section #539

Update README with chapter details and optional section

Update README with chapter details and optional section #539

# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
#
# Required secrets:
# - OPENAI_API_KEY: OpenAI API key for running tests that use OpenAI models
# - TAVILY_API_KEY: Tavily API key for web search functionality in tests
name: Python package
on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.11", "3.12"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
- name: Install uv
uses: astral-sh/setup-uv@v3
with:
version: "latest"
- name: Install dependencies for ch5
run: |
python -m pip install --upgrade pip
cd ch5
uv pip install --system -e .
- name: Run ch5 tests
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
TAVILY_API_KEY: ${{ secrets.TAVILY_API_KEY }}
run: |
cd ch5
python tests/run_tests.py
- name: Install dependencies for ch6
run: |
cd ch6
uv pip install --system -e .
- name: Run ch6 tests
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
TAVILY_API_KEY: ${{ secrets.TAVILY_API_KEY }}
run: |
cd ch6
python tests/run_tests.py
- name: Install dependencies for ch7
run: |
cd ch7
uv pip install --system -e .
- name: Run ch7 tests
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
TAVILY_API_KEY: ${{ secrets.TAVILY_API_KEY }}
run: |
cd ch7
python -m pytest tests/ -v