jlab-script-button

A JupyterLab extension that adds a button which can be used to execute scripts in the frontend of JupyterLab.

Usage

Adds a button into the notebook toolbar. Pushing the button starts a temporary python3 kernel named "tmp_kernel_for_executing_button_code", which executes the following:

![ -z $BUTTON_EXTENSION_SCRIPT_PATH ] && jlab_button_script [notebook_path] \ 
                                      || eval $BUTTON_EXTENSION_SCRIPT_PATH [notebook_path]

So if $BUTTON_EXTENSION_SCRIPT_PATH is defined, the button runs the script at said path with the notebook's path as the argument. Otherwise the default script jlab_button_script is used.

(AUTO-GENERATED BY COOKIECUTTER:)

jlab-script-button

A button that executes scripts in the frontend of JupyterLab.

Requirements

• JupyterLab >= 1.0

Install

jupyter labextension install @loncero/jlab-script-button

Contributing

Install

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
# Move to jlab-script-button directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension link .
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build

You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.

# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch

Uninstall

jupyter labextension uninstall @loncero/jlab-script-button