nbcollate 0.3.1

Collate Jupyter classroom assignment and submission notebooks

The nbcollate package combines a set of Jupyter notebooks into a single notebook.

It also provides a command-line interface, nbcollate.

Example

nbcollate assignment.ipynb student-*.ipynb

Creates the file assignment-collated.ipynb from the files in test/files.

Installation

pip install nbcollate

Usage

nbcollate assignment-1.ipynb students/*/assignment-1.ipynb

nbcollate --help

Related Projects

classroom-tools contains scripts related to using GitHub and Jupyter in education It includes a command-line interface to an older version of this code. That script will eventually be modified to use this package.

A web application with similar functionality is at olin-computing/assignment-dashboard. That application caches the state of GitHub in a local database, and provides a web interface for inspect completion status by student or by question, and for browsing the original and collated notebooks.

Contributing

Set up tools:

pip install -r requirements-dev.txt

Test via any of:

PYTHONPATH=. py.test
python setup.py test

docker build -t nbcollate-pytest .
docker run --rm -it -v `pwd`:/src nbcollate-pytest

Acknowledgements

This package is inspired by original work paulruvolo/SoftDesSp16Prep by Paul Ruvolo at Olin College, extended at osteele/assignment-tools.