TylerADavis / otter-grader

Local autograding library for Jupyter Notebooks

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Otter-Grader

Build Status codecov Documentation Status Demo Custom badge

Otter-grader is a new, open-source, local grader from the Division of Data Science, External Pedagogy Infrastructure at UC Berkeley. It is designed to be a scalable grader that utilizes temporal docker containers in order to remove the traditional overhead requirement of a live server.

Installation

Otter-grader can be installed using pip:

pip install otter-grader

Docker

Otter also requires you to have its Docker image installed, which is where it executes notebooks. The docker image can be installed in two ways:

Pull from DockerHub

To pull the image from DockerHub, run docker pull ucbdsinfra/otter-grader.

Download the Dockerfile from GitHub

To install from the GitHub repo, follow the steps below:

  1. Clone the GitHub repo
  2. cd into the otter-grader/docker directory
  3. Build the Docker image with this command: docker build . -t YOUR_DESIRED_IMAGE_NAME

Note: With this setup, you will need to pass in a custom docker image name when using the CLI.

Documentation

You can find the documentation in the demo notebook by clicking the Binder link above, or by viewing the static HTML version here.

About

Local autograding library for Jupyter Notebooks

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Python 98.6%Language:Makefile 0.7%Language:Dockerfile 0.6%Language:Shell 0.1%