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] 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.

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.10.0.tar.gz (1.5 MB view details)

Uploaded Source

Built Distribution

jupyter_scheduler-2.10.0-py3-none-any.whl (525.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_scheduler-2.10.0.tar.gz.

File metadata

  • Download URL: jupyter_scheduler-2.10.0.tar.gz
  • Upload date:
  • Size: 1.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for jupyter_scheduler-2.10.0.tar.gz
Algorithm Hash digest
SHA256 c94b40da27bb9e873566e3ccf34d4f8ab914124d41163727cc9bea91eca8f3db
MD5 76a1e80575bdd3f2c5ee853881ec32e0
BLAKE2b-256 26139224eb98ef2daea1cc89b09b6dc43e46060eae154749b2eebabcdd40fdac

See more details on using hashes here.

File details

Details for the file jupyter_scheduler-2.10.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyter_scheduler-2.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b57073a8f711a541d9c55a005649153466dc8ace617697b13174ba32eb324e1b
MD5 a4c11d9620764e6addbfac1fadf86a09
BLAKE2b-256 149cc15e18a22348222d957d753bb91269f1cde09ed9292cd18e84ca3c473c68

See more details on using hashes here.

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