course-index 0.1.0__tar.gz

course_index-0.1.0/.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: monthly
+    groups:
+      actions:
+        patterns: ["*"]
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: monthly
+    # dependencies are minimum versions (>=) ; only open security updates, not routine upgrades
+    open-pull-requests-limit: 0

course_index-0.1.0/.github/workflows/python-package.yml

@@ -0,0 +1,144 @@
+# 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
+
+name: build
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+env:
+  package: course_index
+  distribution: course-index
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    env:
+      cov_python_version: "3.13"
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v7
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install the libraries of Qt (for the GUI tests, run with the offscreen platform)
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y --no-install-recommends libegl1 libgl1 libxkbcommon0 libfontconfig1 libdbus-1-3
+    - name: Install TeX Live (for the compilation tests)
+      # only on the coverage run, the other runs skip the compilation tests
+      if: matrix.python-version == env.cov_python_version
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y --no-install-recommends texlive-latex-base texlive-latex-recommended texlive-latex-extra
+    - name: Install ${{ env.distribution }}
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8 pytest pytest-cov
+        pip install -r requirements.txt
+        pip install .
+    - 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
+    - name: Test ${{ env.distribution }} with pytest
+      run: |
+        QT_QPA_PLATFORM=offscreen pytest --cov=$package --cov-report=xml
+    - name: Upload coverage report
+      if: matrix.python-version == env.cov_python_version
+      uses: actions/upload-artifact@v7
+      with:
+        name: coverage-report
+        path: coverage.xml
+  coverage:
+    # only publish the badge for commits on main (not for pull requests)
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    needs: build
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    env:
+      cov_badge_path: docs/coverage.svg
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python
+      uses: actions/setup-python@v7
+      with:
+        python-version: "3.13"
+    - name: Download coverage report
+      uses: actions/download-artifact@v8
+      with:
+        name: coverage-report
+    - name: Make coverage badge
+      run: |
+        pip install genbadge[coverage]
+        genbadge coverage -i coverage.xml -o $cov_badge_path
+    - name: Push coverage badge
+      run: |
+        # keep the badge alone on an orphan branch so that main is never modified by the workflow
+        git config --local user.email "github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        if git fetch --depth=1 origin coverage-badge 2>/dev/null && \
+           git show FETCH_HEAD:$cov_badge_path | cmp -s - $cov_badge_path; then
+          echo "Coverage badge unchanged"
+          exit 0
+        fi
+        git checkout --orphan coverage-badge
+        git rm -rqf --cached .
+        git add $cov_badge_path
+        git commit -m "Update coverage badge"
+        git push origin coverage-badge --force
+  deploy:
+    # only release from main, never from pull requests
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    environment:
+      name: pypi
+      url: https://pypi.org/p/course-index
+    permissions:
+      contents: read
+      id-token: write  # for PyPI trusted publishing (OIDC)
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - uses: actions/checkout@v7
+    - name: Check whether the version is already on PyPI
+      # comparing with PyPI (not with the previous commit) also releases a version whose push did not trigger a deploy
+      id: version
+      run: |
+        version=$(tr -d '[:space:]' < src/$package/VERSION.txt)
+        status=$(curl -s -o /dev/null -w '%{http_code}' --retry 3 "https://pypi.org/pypi/$distribution/$version/json")
+        case "$status" in
+          200) echo "Version $version is already on PyPI" ; echo "new=false" >> "$GITHUB_OUTPUT" ;;
+          404) echo "Version $version is not on PyPI yet" ; echo "new=true" >> "$GITHUB_OUTPUT" ;;
+          *)   echo "::error::Unexpected HTTP status $status from PyPI" ; exit 1 ;;
+        esac
+    - if: steps.version.outputs.new == 'true'
+      name: Cleanup README
+      run: |
+        sed -ri 's/^(##*)\s*:.*:\s*/\1 /g' README.md
+        awk '{if (match($0,"## Supporters")) exit; print}' README.md > README
+        mv -f README README.md
+    - if: steps.version.outputs.new == 'true'
+      name: Set up Python
+      uses: actions/setup-python@v7
+      with:
+        python-version: "3.13"
+    - if: steps.version.outputs.new == 'true'
+      name: Build ${{ env.distribution }} package
+      run: python -m pip install --upgrade build && python -m build
+    - if: steps.version.outputs.new == 'true'
+      name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

course_index-0.1.0/.github/workflows/security.yml

@@ -0,0 +1,31 @@
+# This workflow audits the package dependencies for known vulnerabilities
+# It is separate from python-package.yml so that a new advisory never blocks a release
+
+name: security
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: "0 6 * * 1"  # weekly, catches new advisories between pushes
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  pip-audit:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python
+      uses: actions/setup-python@v7
+      with:
+        python-version: "3.13"
+    - name: Install pip-audit
+      run: python -m pip install --upgrade pip pip-audit
+    - name: Audit dependencies
+      # resolves the dependencies of pyproject.toml in an isolated environment, so only these are audited
+      run: pip-audit .

course_index-0.1.0/.gitignore

@@ -0,0 +1,31 @@
+# Temp files
+*~
+*.backup
+*.bak
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+.eggs/
+
+# Tests and coverage
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+
+# Documentation
+site/
+
+# LaTeX by-products
+*.aux
+*.ilg
+*.ind
+*.log
+*.synctex.gz

course_index-0.1.0/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+mkdocs:
+  configuration: docs/mkdocs.yml
+
+python:
+  install:
+    - requirements: docs/requirements.txt