JupyterLab extension of executing the scripts
The extension helps the user execute the script in the terminal and provides multiple common executors, e.g. bash and python. Users can customise the executors in the settings as well.
- JupyterLab >= 4.0
The package can be installed via PyPI
pip install jupyterlab_executor
The executors can be customised from the JupyterLab settings.
Alternatively, the customisation JSON file can be appended into the
users setting directory.
The file path should be
$HOME/.jupyter/lab/user-settings/@gavincyi/jupyterlab-executor/executor.jupyterlab-settings
and the format is like the following
{
"executors": [
{
"name": "bash",
"command": "bash {path} {args}"
},
{
"name": "python",
"command": "python {path} {args}"
},
...
]
}
The executors
variable is a list of descriptions, of which
-
name
is the string shown in the dialog -
command
is the executor command template to run, where{path}
is the file path returned by the content manager in the JupyterLab, andargs
is the arguments passed in by the users.
The environment variables are always appended at the beginning of the command.
For example, the following execution parameters
run the following command on the terminal
PYTHONPATH=. bash test.py --time 1
The following features are not yet completed but on the roadmap.
-
Support script argument template
-
Support default script arguments
The above features will come out very soon.
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 jupyterlab_executor directory
# Install jupyterlab
pip install jupyterlab
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm run 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 run 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 run 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
pip uninstall jupyterlab_executor
The release should follow the below steps
-
make clean
-
make venv
-
Update the version number in
package.json
-
make release