Skip to main content

A lightweight tool to grade notebook assignements

Project description

DOI

nbchkr: Notebook checker

A lightweight solution to mark/grade/check notebook assignments.

How

Installation

$ pip install nbchkr

Preparation

Write a jupyter notebook main.ipynb, using tags to denote specific cells:

  • answer:<label> A cell where students are expected to write their answers.
  • score:<total> A cell with assert statements to check an answer. Worth <total> marks.
  • hide A cell that should not be shown.

See documentation for further examples and features.

Release

Create a student version of the notebook:

$ nbchkr release --source main.ipynb --output student.ipynb

Check

Given a student notebook notebook: submitted.ipynb

$ nbchkr check --source main.ipynb --submitted submitted.ipynb --feedback-suffix -feedback.md --output data.csv

This writes to screen the score (total and for each question) and creates feedback.md as well as reporting the results to data.csv.

Given a pattern of student submissions it is possible to batch check all of them:

$ nbchkr check --source main.ipynb --submitted submissions/*.ipynb --feedback-suffix -feedback.md --output data.csv

Why?

An alternative to this tool is nbgrader which offers a comprehensive course management solution and includes features such as:

  • An email server to be able to communicate with students;
  • The ability to release assignments, feedback and marks directly;
  • Addons to the jupyter notebook interface.

nbchkr is meant to be a lightweight alternative.

Documentation

Full documentation is available at: nbchkr.readthedocs.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nbchkr-0.0.8.tar.gz (707.6 kB view details)

Uploaded Source

Built Distribution

nbchkr-0.0.8-py2.py3-none-any.whl (7.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file nbchkr-0.0.8.tar.gz.

File metadata

  • Download URL: nbchkr-0.0.8.tar.gz
  • Upload date:
  • Size: 707.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for nbchkr-0.0.8.tar.gz
Algorithm Hash digest
SHA256 3e9e599ad62714d914cec0a4dbd5b403c540697bf17db54cd3361ecf5b9b9f7c
MD5 e014499a8d0d0e3130bf28117573675c
BLAKE2b-256 a615185deef51da4e6281648133224ff96a430c5fd07919fbe618f09067bf102

See more details on using hashes here.

File details

Details for the file nbchkr-0.0.8-py2.py3-none-any.whl.

File metadata

  • Download URL: nbchkr-0.0.8-py2.py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.31.0

File hashes

Hashes for nbchkr-0.0.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 3da9e605dca5318b3f4caabe3a2758974838e578538125a1d2d59484935810e4
MD5 7fc7b907f305918270c329d301cf9c91
BLAKE2b-256 c117529b898234c57a9ff2994926251e2f8f7417f0f8aa4b6fa8c9f784c969a7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page