nbgrader
latest

User Documentation

  • Highlights
  • The philosophy and the approach
  • Creating and grading assignments
  • Managing the database
  • Exchanging assignment files
  • Exchanging assignment files manually
  • Autograding resources
  • Frequently asked questions
  • Advanced topics
  • API library documentation

Setup and Configuration

  • Installation
  • What is nbgrader?
  • Customizing how the student version of an assignment looks
  • The nbgrader_config.py file
  • Configuration options
  • Command line options
    • Basic commands
      • nbgrader
      • nbgrader generate config
    • Instructor commands
      • nbgrader quickstart
      • nbgrader generate assignment
      • nbgrader validate
      • nbgrader update
      • nbgrader autograde
      • nbgrader generate feedback
      • nbgrader generate solution
      • nbgrader export
      • nbgrader db student add
      • nbgrader db student import
      • nbgrader db student remove
      • nbgrader db student list
      • nbgrader db assignment add
      • nbgrader db assignment import
      • nbgrader db assignment remove
      • nbgrader db assignment list
      • nbgrader release assignment
      • nbgrader release feedback
      • nbgrader list
      • nbgrader collect
      • nbgrader zip collect
    • Student commands
      • nbgrader list
      • nbgrader fetch assignment
      • nbgrader fetch feedback
      • nbgrader validate
      • nbgrader submit
  • Using nbgrader with JupyterHub
  • nbgrader and its exchange service
  • Adding customization plugins

Developer Documentation

  • Overview
  • Developer installation
  • JSON Metadata Format
  • Pull requests
  • Testing
  • Documentation
  • JavaScript dependencies
  • Modifying the Database
  • Releasing a new version

Resources

  • Source repository
  • Jupyter education mailing list
  • changelog
nbgrader
  • Command line options
  • Edit on GitHub

Command line options¶

Basic commands¶

  • nbgrader
  • nbgrader generate config

Instructor commands¶

  • nbgrader quickstart
  • nbgrader generate assignment
  • nbgrader validate
  • nbgrader update
  • nbgrader autograde
  • nbgrader generate feedback
  • nbgrader generate solution
  • nbgrader export

The following commands are used to manage the database:

  • nbgrader db student add
  • nbgrader db student import
  • nbgrader db student remove
  • nbgrader db student list
  • nbgrader db assignment add
  • nbgrader db assignment import
  • nbgrader db assignment remove
  • nbgrader db assignment list

The following commands are meant for instructors, but are only relevant when using nbgrader in a shared server environment:

  • nbgrader release assignment
  • nbgrader release feedback
  • nbgrader list
  • nbgrader collect
  • nbgrader zip collect

Student commands¶

Note that these commands are meant for students, but are only relevant when using nbgrader in a shared server environment.

  • nbgrader list
  • nbgrader fetch assignment
  • nbgrader fetch feedback
  • nbgrader validate
  • nbgrader submit
Previous Next

© Copyright 2015-2017, Jupyter Development Team. Revision c54bc383.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: latest
Versions
latest
stable
0.7.x
main
Downloads
On Read the Docs
Project Home
Builds