Skip to main content

A JupyterLab extension for running notebook jobs

Project description

jupyter_scheduler

Github Actions StatusBinder

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.

Requirements

  • JupyterLab 4.x (for newer Jupyter Scheduler versions)
  • JupyterLab 3.x (for Jupyter Scheduler 1.x)

[!IMPORTANT] JupyterLab 3 will reach its end of maintenance date on May 15, 2024, anywhere on Earth. 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.

Install

To install the extension, execute:

pip install jupyter_scheduler

Uninstall

To remove the extension, execute:

pip uninstall jupyter_scheduler

User's guide

Please refer to our user's guide for more information on installation and usage.

Contributing

Please refer to our contributor's guide for more information on installation and usage.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyter_scheduler-2.6.0.tar.gz (1.5 MB view hashes)

Uploaded Source

Built Distribution

jupyter_scheduler-2.6.0-py3-none-any.whl (523.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page