https://github.com/jupyterlab-contrib/jupyterlab-kernelspy

A Jupyter Lab extension for inspecting messages to/from a kernel
https://github.com/jupyterlab-contrib/jupyterlab-kernelspy

jupyterlab jupyterlab-extension kernel

Last synced: 4 months ago
JSON representation

A Jupyter Lab extension for inspecting messages to/from a kernel

• Host: GitHub
• URL: https://github.com/jupyterlab-contrib/jupyterlab-kernelspy
• Owner: jupyterlab-contrib
• License: other
• Created: 2018-04-20T16:11:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2023-10-08T08:15:21.000Z (9 months ago)
• Last Synced: 2024-03-17T11:20:45.866Z (4 months ago)
• Topics: jupyterlab, jupyterlab-extension, kernel
• Language: TypeScript
• Size: 662 KB
• Stars: 78
• Watchers: 7
• Forks: 12
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-jupyter-resources - GitHub - 15% open · ⏱️ 20.07.2022): (JupyterLab扩展)
• best-of-jupyter - GitHub - 15% open · ⏱️ 08.10.2023): (JupyterLab Extensions)

README

        
# jupyterlab-kernelspy

[![Extension status](https://img.shields.io/badge/status-ready-success 'ready to be used')](https://jupyterlab-contrib.github.io/)

[![Github Actions Status](https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/workflows/Build/badge.svg)](https://github.com/jupyterlab-contrib/jupyterlab-kernelspy/actions?query=workflow%3ABuild)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/jupyterlab-contrib/jupyterlab-kernelspy/master?urlpath=lab) [![PyPI](https://img.shields.io/pypi/v/jupyterlab-kernelspy)](https://pypi.org/project/jupyterlab-kernelspy)

A Jupyter Lab extension for inspecting messages to/from a kernel.

![screenshot](https://raw.githubusercontent.com/jupyterlab-contrib/jupyterlab-kernelspy/master/screenshot.png)

## Requirements

- JupyterLab

## Install

```bash

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:

```bash

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 install

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

The `jlpm` command is JupyterLab's pinned version of

[yarn](https://yarnpkg.com/) that is installed with JupyterLab. You may use

`yarn` or `npm` in lieu of `jlpm` below.

```bash

# Clone the repo to your local environment

# Change directory to the jupyterlab-kernelspy directory

# 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.

```bash

# 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:

```bash

jupyter lab build --minimize=False

```

### Uninstall

```bash

pip uninstall jupyterlab-kernelspy

```