Set up PR validation

.github/workflows/lint-test-packages.yml

@@ -0,0 +1,42 @@
+# This workflow will install Python dependencies, run tests and lint.
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Lint and Test Packages
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12.2"]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install pipenv
+        python -m pip install ruff
+    - name: Lint with ruff
+      run: |
+        ruff check
+    - name: Test with unittest
+      run: |
+        cd packages/pythonlab_setup
+        pipenv install
+        cd pythonlab_setup
+        pipenv run python -m unittest
+        cd ../..
+        # Repeat install and run unit tests for any other packages with tests.

README.md

@@ -39,4 +39,9 @@ This tests adds some customization to the output of unit tests, and has a functi
 From the package folder containing `pyproject.toml`, run `python -m build`. The generated `.whl` file will be in the `dist` folder.
 
 ## Run tests
-From the folder containing code and tests, run `python -m unittest`. This will look for tests in all files that start with `test`.
+From the folder containing code and tests, run `pipenv run python -m unittest`. This will look for tests in all files that start with `test`.
+
+# Lint your code
+We use [ruff](https://docs.astral.sh/ruff/installation/) for linting. It is a dev dependency of all of our packages. You can install it on
+your editor of choice for inline suggestions (for example, [VS Code](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)),
+and run it on the command line via `ruff check`. It also runs as part of the PR check process.

packages/pythonlab_setup/Pipfile

@@ -9,6 +9,7 @@ requests = "*"
 matplotlib = "*"
 
 [dev-packages]
+ruff = "*"
 
 [requires]
 python_version = "3.12"

packages/pythonlab_setup/pythonlab_setup/__init__.py

@@ -1,2 +1,2 @@
-from .setup_pythonlab import setup_pythonlab
-from .teardown_pythonlab import teardown_pythonlab
+from .setup_pythonlab import setup_pythonlab as setup_pythonlab
+from .teardown_pythonlab import teardown_pythonlab  as teardown_pythonlab

packages/unittest_runner/Pipfile

@@ -0,0 +1,12 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+
+[dev-packages]
+ruff = "*"
+
+[requires]
+python_version = "3.12"

packages/unittest_runner/unittest_runner/__init__.py

@@ -1 +1 @@
-from .run_tests import run_student_tests, run_validation_tests
+from .run_tests import run_student_tests as run_student_tests, run_validation_tests as run_validation_tests