Using NBGrader to autograde IPython Notebooks.
Guides
December 10, 2021

Using NBGrader for Python Jupyter notebooks in CodeGrade

In 30 seconds...

NBGrader is an automated grading system for Jupyter Notebooks and it’s a nice and easy way to automatically grade cells within a notebook. If you want to learn more about how NBGrader works, you can find their documentation here: https://nbgrader.readthedocs.io/en/stable/.

When you have created an NBGrader assignment, you will have a teacher version containing all the tests (including hidden tests) and a student version, which doesn’t contain the hidden tests. Students will then go on and create their assignment within this template.

In CodeGrade, we have created an NBGrader integration called `cg-nbgrader`, so that you only have to upload the teacher template and CodeGrade will run NBGrader for you. This will also allow your students to simply upload their Jupyter Notebook whenever they’d like and get instant feedback from CodeGrade.

After a student hands in their notebook, NBGrader will instantly run and a score will be presented to the student. Furthermore, the graded notebook will also be available in the Code Viewer, so students can see what they did right, and what they can improve on.

After running the notebook, the executed notebook (including the results) will appear under the AutoTest Output in the Code Viewer.


The score will be outputted from CodeGrade’s NBGrader integration. With a Capture Points test you can capture this score.


Autograde Jupyter Notebooks using the most powerful and easy to use autograder!

Setting up NBGrader in CodeGrade

To start using the NBGrader integration in CodeGrade, you first need to upload the teacher version you get out of NBGrader as a fixture in CodeGrade. This file needs to have the same name as the file that students will hand in. Next, you need to install the CodeGrade NBGrader integration in the “Global setup script”. Simply input the following command `cg-nbgrader install`. If you need to install any pip packages, you can also do that by passing it as an argument to cg-nbgrader `cg-nbgrader install pandas matplotlib`

This is how it might look for you in CodeGrade:

Setting up NBGrader with pip packages in CodeGrade's autograder.

As you can see, I’ve also used a simple trick in the “Per-student setup script” to make sure the notebook the students will hand in has the correct name, by simply copying any `.ipynb` file to the correct filename.

Creating NBGrader tests

Finally, we can create the Capture Points test to execute NBGrader. As “Program to test” use the following command: `cg-nbgrader run STUDENT_FILENAME.ipynb`.

For example:

Creating an NBGrader test in CodeGrade.


That’s all! Simply start the AutoTest and you can use NBGrader with CodeGrade seamlessly!

Youri Voet

Youri Voet

Co-founder and CEO
Youri Voet is co-founder and CEO at CodeGrade. During his studies Computer Science and work as a Teaching Assistant at the University of Amsterdam, he developed CodeGrade together with his co-founders to make their own life easier. Youri works together with many educational institutions to continue to offer them the best CodeGrade experience possible.

Continue reading

CodeGrade Success Story at the University of Nevada, Las Vegas

CodeGrade increases student performance and helps teachers at UNLV. Professors and e-learning experts from the University of Nevada, Las Vegas share how they adopted CodeGrade and how it made their lives easier.

New CodeGrade features now delivered continuously to you!

CodeGrade now uses Continuous Delivery (CD) to deploy new bug fixes, tweaks and features even quicker and smoother to our customers. We chat with CodeGrade CTO Thomas Schaper to learn more about this improvement!

5 reasons to use CodeGrade in your high school coding classroom

Coding education is growing, especially in high schools. Find out how CodeGrade can support K12 students.

Teaching Intro to Python with CodeGrade

The CodeGrade Introduction to Python course is an 8-week basic Python course. Students are not required to have any prior knowledge on programming or Python. This course will cover the basic concepts of programming up to Python specific modules and OOP design. It is available for all instructors now.

Sign up to our newsletter

Book a quick 30-minute demo and see how it works for you!