Jupyter Notebooks Plugin

Easily integrate the Jupyter Notebooks open document format in Open edX




The Jupyter Notebooks plugin integrates Jupyter Notebooks into the Open edX platform. This extension simplifies the process of incorporating Jupyter functionality into Open edX, enabling the installation of the official Jupyter XBlock, running a Docker-based JupyterHub instance with containerized environments for students, and providing flexibility for customization through various configuration settings.

The plugin offers clear installation instructions, usage guidelines for enabling Jupyter XBlock in Studio, and detailed configurations for both JupyterHub and the JupyterLab environment.

The Jupyter Notebooks plugin is crafted with you in mind — whether you’re an educator, course instructor, or administrator using the Open edX platform. Here’s why it’s particularly beneficial for you:

  1. Educators and Instructors: If you’re keen on incorporating hands-on, interactive learning experiences using Jupyter Notebooks within the Open edX environment, this plugin is tailored for you
  2. Course Developers: As someone responsible for designing and developing course content on the Open edX platform, this plugin offers a smooth integration of Jupyter functionality into your courses
  3. Administrators: As an Open edX administrator, if you’re aiming to extend the platform’s capabilities by adding support for Jupyter Notebooks, this plugin is designed to meet your needs
  4. Online Learning Platforms: If you represent organizations or institutions running online learning platforms with Open edX, and you aspire to provide a richer, more interactive learning experience through Jupyter integration, this plugin is your solution
  5. Technical Instructors: If you’re an instructor teaching technical or data-driven courses and you want to leverage the capabilities of Jupyter Notebooks for coding exercises, data analysis, and interactive content, look no further

Key Features

  1. Jupyter XBlock Installation: Installs the official Jupyter XBlock within the Open edX LMS and Studio, providing an easy way to incorporate Jupyter functionality into courses
  2. Docker-Based JupyterHub Instance: Sets up and runs a JupyterHub instance using Docker, facilitating the allocation of Docker containers to students for running custom Jupyter Notebooks
  3. Containerized Environments: Allocates Docker containers with limited CPU and memory resources to students, ensuring controlled and isolated environments for executing Jupyter Notebooks
  4. Kubernetes Compatibility (Caution): Acknowledges compatibility with Kubernetes but advises users that it has not been extensively battle-tested, it also encourages reporting of any issues and suggests referring to more production-ready Kubernetes environments if needed
  5. User-Friendly Installation and Configuration: Provides clear and straightforward installation steps using the Tutor plugin system and offers easy configuration through Tutor settings, allowing customization of various parameters related to Docker images, host configurations, and LTI (Learning Tools Interoperability) settings
  6. Integration with Studio: Guides users through the process of enabling the Jupyter XBlock in the Open edX Studio environment and allows users to create advanced Jupyter XBlocks within the Studio for interactive content creation
  7. Detailed Configuration Options: Defines a range of configurable settings through Tutor, enabling users to customize parameters such as Docker image references, host configurations, and specific JupyterHub settings
  8. JupyterHub and JupyterLab Customization: Provides templates for configuring the JupyterHub instance, allowing users to override settings and add custom LTI keys. Demonstrates how to customize the JupyterLab environment by creating Tutor plugins and modifying the Dockerfile





This Tutor plugin is maintained by Muhammad Hassan Siddiqi from Edly. Community support is available from the official Open edX forum. Do you need help with this plugin? See the troubleshooting section from the Tutor documentation.


This software is licensed under the terms of the AGPLv3.



Last updated:

11th Dec, 2023