Skip to main content

jupyterlite-javascript-kernel

Github Actions Status lite-badge

A JavaScript kernel for JupyterLite.

a screenshot showing a notebook with the JavaScript kernel in JupyterLite

Requirements

  • JupyterLite >=0.3.0

This kernel was originally maintained as part of the main JupyterLite repository, and was moved to its own repository for the JupyterLite 0.3.0 release.

Install

To install the extension, execute:

pip install jupyterlite-javascript-kernel

Uninstall

To remove the extension, execute:

pip uninstall jupyterlite-javascript-kernel

Contributing

Development install

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 jupyterlite-javascript-kernel 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 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 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 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

Development uninstall

pip uninstall jupyterlite-javascript-kernel

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named @jupyterlite/javascript-kernel within that folder.

Packaging the extension

See RELEASE

Metadata

Release files for jupyterlite-javascript-kernel 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyterlite-javascript-kernel 0.3.0
File Size Uploaded
jupyterlite_javascript_kernel-0.3.0.tar.gz 177.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlite-javascript-kernel 0.3.0
File Interpreter ABI Platform
jupyterlite_javascript_kernel-0.3.0-py3-none-any.whl Python 3 none any Details

Total release size: 211.6 kB

Release files / jupyterlite_javascript_kernel-0.3.0.tar.gz

Download URL jupyterlite_javascript_kernel-0.3.0.tar.gz
Size 177.9 kB
Tags Source
SHA-256 checksum
How to use checksums
39870efb4cdfe669b99552b4ad21a82f575691e4fdaf77b33bef04ec230889ff
BLAKE2b-256 checksum
How to use checksums
9346ea0a0d72f7eeb6af42deec5d44dfb8ecde9f506a047abad5fe2c2ba3224f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.11.8

Release files / jupyterlite_javascript_kernel-0.3.0-py3-none-any.whl

Download URL jupyterlite_javascript_kernel-0.3.0-py3-none-any.whl
Size 33.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7753c172d3c8bd50d7e7c05d1b667c3fa5566f90d38bf1bdd160f9752e1746b7
BLAKE2b-256 checksum
How to use checksums
6823c09a3dd650daa61fac75fb1e05f224df3b797972d761d3317c1bd03b10ba
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.0.0 CPython/3.11.8
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page