jupygrader 0.1.2

Grade Jupyter notebooks with Python scripts

Jupygrader

---

Table of Contents

• Summary
• Key Features
• Installation
• Update Jupygrader
• Usage
  • Specifying the output directory
• Test
• Build and Publish
  • Build artifact
  • Publish to PyPI
• License

Summary

Jupygrader is a Python package for automated grading of Jupyter notebooks. It provides a framework to:

1. Execute and grade Jupyter notebooks containing student work and test cases
2. Generate comprehensive reports in multiple formats (JSON, HTML, TXT)
3. Extract student code from notebooks into separate Python files
4. Verify notebook integrity by computing hashes of test cases and submissions

Key Features

• Executes notebooks in a controlled, temporary environment
• Preserves the original notebook while creating graded versions
• Adds grader scripts to notebooks to evaluate test cases
• Generates detailed grading results including:
  • Individual test case scores
  • Overall scores and summaries
  • Success/failure status of each test
• Produces multiple output formats for instructors to review:
  • Graded notebook (.ipynb)
  • HTML report
  • JSON result data
  • Plaintext summary
  • Extracted Python code
• Includes metadata like Python version, platform, and file hashes for verification

Jupygrader is designed for educational settings where instructors need to grade student work in Jupyter notebooks, providing automated feedback while maintaining records of submissions and grading results.

Installation

pip install jupygrader

Update Jupygrader

pip install --upgrade jupygrader

Usage

import jupygrader

notebook_file_path = 'path/to/notebook.ipynb'
jupygrader.grade_notebook(notebook_file_path)

Specifying the output directory

import jupygrader

notebook_file_path = 'path/to/notebook.ipynb'
output_dir_path = 'path/to/output'

jupygrader.grade_notebook(
    notebook_path=notebook_file_path,
    output_path=output_dir_path
)

Test

hatch uses pytest as the test runner.

hatch test

Build and Publish

Build artifact

hatch build

Publish to PyPI

hatch publish

# username: __token__
# password: [your-token-value]

Alternatively, you can create a ~/.pypirc file with the token credentials.

~/.pypirc

[pypi]
username = __token__
password = [your-token-value]

License

jupygrader is distributed under the terms of the MIT license.