JupyterLite

andrewstetsenko1 pts0 comments

JupyterLite — JupyterLite 0.8.2 documentation

Skip to main content

Back to top

Ctrl+K

Search<br>Ctrl+K

System Settings

Light

Dark

GitHub

PyPI

Search<br>Ctrl+K

System Settings

Light

Dark

GitHub

PyPI

Open demo in a new tab

JupyterLab

Jupyter Notebook

REPL

JupyterLite#

JupyterLite is a JupyterLab distribution that runs entirely in the browser built<br>from the ground-up using JupyterLab components and extensions.

⚡ Status ⚡#

JupyterLite is part of the Project Jupyter<br>Frontends subproject.

Not all the features available in JupyterLab and the Classic Notebook will work with<br>JupyterLite, but many do!

Don’t hesitate to check out the<br>documentation for more<br>information and project updates.

✨ Try it in your browser ✨#

JupyterLite works with both the JupyterLab<br>and Jupyter Notebook interfaces.

Try it with JupyterLab

Try it with Jupyter Notebook

🏗️ Build your own JupyterLite 🏗️#

You can build your own JupyterLite website in a couple of minutes, with custom<br>extensions and packages.

See the<br>documentation for<br>more details.

Browser-based Interactive Computing#

JupyterLite is all about accessible browser-based interactive computing:

Python kernels running in a Web Worker:

Pyodide :<br>jupyterlite-pyodide-kernel

Xeus Python :<br>jupyterlite-xeus

Support for interactive visualization libraries such as altair, bqplot,<br>ipywidgets, matplotlib, and plotly

View hosted example Notebooks and other files, then edit, save, and download from the<br>browser’s IndexDB (or localStorage)

Support for saving settings for JupyterLab/Lite core and federated extensions

Basic session and kernel management to have multiple kernels running at the same time

Support for<br>Code Consoles

Ease of Deployment#

Served via well-cacheable, static HTTP(S), locally or on most static web hosts

Embeddable within larger applications

Requires no dedicated application server much less a container orchestrator

Fine-grained configurability of page settings, including reuse of federated JupyterLab<br>extensions

Version Compatibility#

The table below shows the versions of JupyterLab and Jupyter Notebook bundled with each<br>JupyterLite core release.

jupyterlite-core

jupyterlab

notebook

supported

0.7.0

4.5.0

7.5.0

0.6.0

4.4.3

7.4.3

0.5.0

4.3.4

7.3.2

0.4.0

4.2.4

7.2.0

0.3.0

4.1.1

7.1.0

0.2.0

4.0.7

7.0.6

0.1.0

3.5.3

Note: Only the last two releases are actively supported.

Development install#

See the<br>contributing guide<br>for a development installation.

Related#

JupyterLite is a reboot of several attempts at making a full static Jupyter distribution<br>that runs in the browser, without having to start the Python Jupyter Server on the host<br>machine.

The goal is to provide a lightweight computing environment accessible in a matter of<br>seconds with a single click, in a web browser and without having to install anything.

This project is a collection of packages that can be remixed together in variety of ways<br>to create new applications and distributions. Most of the packages in this repo focus on<br>providing server-like components that run in the browser (to manage kernels, files and<br>settings), so existing JupyterLab extensions and plugins can be reused out of the box.

See also:

p5-notebook: A minimal Jupyter Notebook UI for<br>p5.js kernels running in the browser

jyve: Jupyter Kernels, right inside JupyterLab

Starboard Notebook: In-browser<br>literal notebooks

Basthon: A Jupyter notebook implementation using Pyodide

Notebook.link: A cloud-backed, in-browser notebook platform<br>based on JupyterLite

👥 Contributors#

Join our community and become a contributor today! 🚀

Documentation Contents#

Get Started<br>Using an existing JupyterLite deployment

Deploy your first JupyterLite website on GitHub Pages

Embed a live REPL on a website

Deploy JupyterLite on a standalone server or locally

Configure a JupyterLite site

How-To Guides<br>Configuring a JupyterLite deployment

Contents

Configuring the Pyodide kernel

Configuring the Xeus Python kernel

Configuring the Xeus R kernel

Deploying

Extensions

Advanced configuration

Reference<br>Runtime Configuration Files

Schema

CLI

API

Architecture

Contents

doit

About the Demo

Troubleshooting<br>Not able to access files from the kernel

Clear the browser data

Package compatibility with WebAssembly kernels

Access kernel logs

Migration Guide<br>v0.7.0 to v0.8.0

v0.6.0 to v0.7.0

v0.5.0 to v0.6.0

v0.4.0 to v0.5.0

v0.3.0 to v0.4.0

v0.2.0 to v0.3.0

v0.1.0 to v0.2.0

0.1.0b19 to 0.1.0b20

0.1.0b18 to 0.1.0b19

0.1.0b17 to 0.1.0b18

0.1.0b16 to 0.1.0b17

Contributing<br>Setup

Development...

jupyterlite jupyterlab notebook browser jupyter kernel

Related Articles