Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/drvinceknight/nbchkr
https://github.com/drvinceknight/nbchkr
automated-assessment jupyter-notebook notebook students
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/drvinceknight/nbchkr
- Owner: drvinceknight
- License: mit
- Created: 2020-06-26T16:16:12.000Z (over 4 years ago)
- Default Branch: dev
- Last Pushed: 2024-03-27T09:49:40.000Z (10 months ago)
- Last Synced: 2024-06-20T00:44:30.628Z (7 months ago)
- Topics: automated-assessment, jupyter-notebook, notebook, students
- Language: Python
- Homepage: https://nbchkr.readthedocs.io
- Size: 857 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://doi.org/10.5281/zenodo.3999365)
# nbchkr: Notebook checker
A lightweight solution to mark/grade/check notebook assignments.
# How
## Installation
```bash
$ pip install nbchkr
```
## Preparation
Write a jupyter notebook `main.ipynb`, using tags to denote specific cells:
- `answer:` A cell where students are expected to write their answers.
- `score:` A cell with assert statements to check an answer. Worth
`` marks.
- `hide` A cell that should not be shown.
See documentation for further examples and features.
## Release
Create a student version of the notebook:
```bash
$ nbchkr release --source main.ipynb --output student.ipynb
```
## Check
Given a student notebook notebook: `submitted.ipynb`
```bash
$ 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:
```bash
$ nbchkr check --source main.ipynb --submitted submissions/*.ipynb --feedback-suffix -feedback.md --output data.csv
```
# Why?
An alternative to this tool is
[nbgrader](https://nbgrader.readthedocs.io/en/stable/) 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](nbchkr.readthedocs.io)