grader-adv-python

This repository contains a Docker image that is a modification of the Python PrairieLearn grading image.

The main modifications relate to an improved set of feedback functions.

Installation

Obtain a copy of the grader by using:

docker pull prairielearn/prairielearn
docker pull jamesbalamuta/grader-adv-python

Deployment to DockerHub

To automate the deployment to DockerHub, the .github/workflows/docker-image.yml requires two secrets to be set:

DOCKERHUB_TOKEN
DOCKERHUB_USERNAME

These are set under the repository's Secret tab.

Development notes

Expectation Design

When designing the new code expectation features, the focus was on improving how differences are expressed to the end user.

We took inspiration from:

• cpython/Lib/unittest/case.py
• r-lib/testthat/R/expectation.R

Moreover, we referred to 3.3. Special Method Names for guidance on customizing Python classes.

Re-create local test environment

To experiment with the class outside of the docker container, please setup the conda environment as described in dev-grader.yml. In shell, type:

conda env create -f dev-grader.yml
conda activate dev-grader

Once done, deactivate the environment with:

conda deactivate