ci.yml

name: Python Code Style Check

# Trigger on push to main/master branches or pull requests targeting them
on:
  push:
    branches: [ "main", "master" ]
  pull_request:
    branches: [ "main", "master" ]

permissions:
  contents: read

jobs:
  style_check:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        python-version: ["3.10"] # We can add more versions here, e.g., ["3.8", "3.10"]

    steps:
    # 1. Checkout code
    - uses: actions/checkout@v4

    # 2. Set up Python environment
    - name: Set up Python ${{ matrix.python-version }}
      uses: actions/setup-python@v5
      with:
        python-version: ${{ matrix.python-version }}
        cache: 'pip' # Enable pip caching to speed up future builds

    # 3. Install dependencies
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        # Install linting and formatting tools
        pip install flake8 black==23.9.1

        # Install project dependencies (if requirements.txt exists)
        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
        
    # 4. Linting with flake8
    - name: Lint with flake8
      run: |
        # stop the build if there are Python syntax errors or undefined names
        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

    # 5. Check formatting with Black
    - name: Check formatting with Black
      run: |
        # --check only verifies formatting without modifying files.
        # The CI will fail if the code is not formatted correctly.
        black . --check --verbose