rth / pyodide-kernel

Python kernel for JupyterLite powered by Pyodide

jupyterlite-pyodide-kernel

A Python kernel for JupyterLite powered by Pyodide,

Requirements

• python >=3.8
• jupyterlite >=0.1.0b19

Install

To install the Pyodide kernel labextension and the CLI addons for jupyter lite, run:

pip install jupyterlite-pyodide-kernel

Then build your JupyterLite site:

jupyter lite build

⚠️ The documentation for advanced configuration is available from the main JupyterLite documentation site:

• configuring
• command line interface

Uninstall

To remove the extension, run:

pip uninstall jupyterlite-pyodide-kernel

Development Install

Below is an short overview of getting up and running quickly. Please see the contributing guide for full details.

Development Requirements

Recommended a Python virtual environment provided by a tool of choice, e.g.

• virtualenv
• mamba
• conda

Ensure the local development environment has:

• git
• nodejs 18
• python >=3.8

Development Quick Start

git clone https://github.com/jupyterlite/pyodide-kernel
cd pyodide-kernel
npm run quickstart

Then, serve the built demo site, documentation, and test reports with Python's built-in http server:

jlpm serve