A JupyterLab extension for running notebook jobs. Documentation is available on ReadTheDocs.
This extension is composed of a Python package named jupyter_scheduler
for the server extension and a NPM package named @jupyterlab/scheduler
for the frontend extension. Installation of this extension provides a
REST API to run, query, stop and delete
notebook jobs; the UI provides an interface to create, list and view job
details.
- JupyterLab 4.x (for newer Jupyter Scheduler versions)
- JupyterLab 3.x (for Jupyter Scheduler 1.x)
Important
Starting with v2.7.0, Jupyter Scheduler requires SQLAlchemy 2.x instead of SQLAlchemy 1.x.
Important
JupyterLab 3 reached its end of maintenance date on May 15, 2024. As a result, we will not backport new features to the v1 branch supporting JupyterLab 3 after this date. Fixes for critical issues will still be backported until December 31, 2024. If you are still using JupyterLab 3, we strongly encourage you to upgrade to JupyterLab 4 as soon as possible. For more information, see JupyterLab 3 end of maintenance on the Jupyter Blog.
To install the extension, execute:
pip install jupyter_schedulerTo remove the extension, execute:
pip uninstall jupyter_schedulerPlease refer to our user's guide for more information on installation and usage.
Please refer to our contributor's guide for more information on installation and usage.