Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

interrupt-ipykernel-extension

bernhard-422MIT1.0.0TypeScript support: included

Add a button to reliably interrupt a IPython kernel

jupyter, jupyterlab, jupyterlab-extension

readme

interrupt-ipykernel-extension

Github Actions Status

Add a button to reliably interrupt a IPython kernel

Requirements

  • JupyterLab >= 1.0

Install

jupyter labextension install interrupt-ipykernel-extension

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 interrupt-ipykernel-extension 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 interrupt-ipykernel-extension

changelog

History

1.0.0 (2020-05-07)

  • Added an extension to send sigint to the reote kernel via ssh (needed for Windows)
  • Added Windows support (for OpoenSSH)
  • Added a call to a kernel_customize function for sub classes to inject customizations for the kernel

0.1.0 (2019-09-01)

  • First release on github

0.9.0 (2019-09-03)

  • Restructured pxssh calls
  • Rewrote keeping alive routine
  • Stabilized error detection (cluster not reachable, VPN cut, ipykernel missing)

0.9.2 (2019-09-20)

  • Added code to call ssh_ipykernel as a module to add a kernel
  • Added doc strings to all classes and methods

0.9.3 (2019-09-20)

  • Fixed argument error for env variables in ssh_ipykernel.manage