https://github.com/jupyter-server/jupyter-scheduler
Run Jupyter notebooks as jobs
https://github.com/jupyter-server/jupyter-scheduler
jupyter jupyterlab jupyterlab-extension
Last synced: 9 months ago
JSON representation
Run Jupyter notebooks as jobs
- Host: GitHub
- URL: https://github.com/jupyter-server/jupyter-scheduler
- Owner: jupyter-server
- License: bsd-3-clause
- Created: 2022-09-08T18:27:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-13T00:00:54.000Z (over 1 year ago)
- Last Synced: 2024-04-14T16:27:01.073Z (over 1 year ago)
- Topics: jupyter, jupyterlab, jupyterlab-extension
- Language: TypeScript
- Homepage: https://jupyter-scheduler.readthedocs.io
- Size: 2.18 MB
- Stars: 172
- Watchers: 14
- Forks: 19
- Open Issues: 77
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# jupyter_scheduler
[](https://github.com/jupyter-server/jupyter-scheduler/actions/workflows/build.yml)[](https://mybinder.org/v2/gh/jupyter-server/jupyter-scheduler/main?urlpath=lab)
A JupyterLab extension for running notebook jobs. Documentation is available on
[ReadTheDocs](https://jupyter-scheduler.readthedocs.io).
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](https://blog.jupyter.org/jupyterlab-3-end-of-maintenance-879778927db2) on the Jupyter Blog.
## Install
To install the extension, execute:
```bash
pip install jupyter_scheduler
```
## Uninstall
To remove the extension, execute:
```bash
pip uninstall jupyter_scheduler
```
## User's guide
Please refer to our [user's guide](https://jupyter-scheduler.readthedocs.io/en/latest/users/index.html)
for more information on installation and usage.
## Contributing
Please refer to our [contributor's guide](https://jupyter-scheduler.readthedocs.io/en/latest/contributors/index.html)
for more information on installation and usage.