Skip to main content

A JupyterLab extension for queuing notebooks executions.

Project description

nbconvert_queue

Github Actions StatusBinder A JupyterLab extension for queuing notebooks executions.

This extension is composed of a Python package named nbconvert_queue for the server extension and a NPM package named nbconvert_queue for the frontend extension.

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install nbconvert_queue

Uninstall

To remove the extension, execute:

pip uninstall nbconvert_queue

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the nbconvert_queue directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable nbconvert_queue
# Rebuild extension Typescript source after making changes
jlpm build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

# Server extension must be manually disabled in develop mode
jupyter server extension disable nbconvert_queue
pip uninstall nbconvert_queue

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named nbconvert_queue within that folder.

Packaging the extension

See RELEASE

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

nbconvert_queue-0.1.0.tar.gz (3.1 MB view details)

Uploaded Source

Built Distribution

nbconvert_queue-0.1.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file nbconvert_queue-0.1.0.tar.gz.

File metadata

  • Download URL: nbconvert_queue-0.1.0.tar.gz
  • Upload date:
  • Size: 3.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for nbconvert_queue-0.1.0.tar.gz
Algorithm Hash digest
SHA256 c541bf9d8b65a1bc564028515640787dd81b2c60817d82afc20db030425df69c
MD5 dc5871ead5acd5977db24b22342db890
BLAKE2b-256 bec38516a6ea5e7d72fc91606e84814b718ffe2e691534fc924fcde1849c1c4a

See more details on using hashes here.

File details

Details for the file nbconvert_queue-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for nbconvert_queue-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 60bc529c85bf19cd7d23bdbeb73ccbbd42e09159af2d7c26b2213be53fdd0acc
MD5 dd3f6f886ee9c86c417f406a968b9b25
BLAKE2b-256 b7cc295fe87244fa0ca2558df9a4b7f75e19f65d55d40f58f01399b52c182902

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