A Jupyter Lab extension for inspecting messages to/from a kernel
Project description
jupyterlab-kernelspy
A JupyterLab extension for inspecting messages to/from a kernel.
Prerequisites
- JupyterLab
Installation
pip install jupyterlab-kernelspy
Update
From JupyterLab 3.0 onwards, extensions are distributed as Python packages. Use the same Python package manager you used to install the extension to update it.
For JupyterLab 0.34 - 2.2.x, you can update the extension to the latest compatible version with:
jupyter labextension update jupyterlab-kernelspy
Usage
Once the extension is installed, it should add a button to your notebook toolbar (a yellow {:}
icon).
Click this button to open a log view for that notebook.
Contributing
Development
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-kernelspy directory (python package dir)
# Install the 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).
Uninstall
pip uninstall jupyterlab-kernelspy
jupyter labextension uninstall jupyterlab-kernelspy
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyterlab-kernelspy-3.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d985c7247593532e29426c1fce2ef296fa7e21ae5b05370c18b573d94406ad2 |
|
MD5 | 463230a384add26230ba918c01f46784 |
|
BLAKE2b-256 | 2ed33e28a9f42e2fa425a9486a8332eb0d545083d6de639f52a485945a7f8046 |
Hashes for jupyterlab_kernelspy-3.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c2371c5c2217ea6a09f2e7f5075841b7369a8939da4eea37bb53815a45b83255 |
|
MD5 | b056c2533ced073844fafb07da778da5 |
|
BLAKE2b-256 | c1a0b55ebc14925d86d636725c170e32ed88e392cf6ee688b85b152b5279872e |