Python kernel for JupyterLite powered by Pyodide
Project description
jupyterlite-pyodide-kernel
A Python kernel for JupyterLite powered by Pyodide,
Requirements
python >=3.8
Compatibility
status | jupyterlite-pyodide-kernel |
jupyterlite-core |
jupyterlab |
notebook |
retrolab |
---|---|---|---|---|---|
alpha | 0.2.* |
0.2.* |
4.0.* |
7.0.* |
- |
stable | 0.1.* |
0.1.* |
3.5.* |
- | 0.3.* |
Installing the matching version of JupyterLab with your package manager can help ensure
matching labextension assets and kernel dependencies, even though this kernel does not
yet work in a full, jupyter_server
-hosted client such as JupyterLab or Notebook.
Install
To install the Pyodide kernel labextension and the CLI addons for jupyter lite
, run:
pip install jupyterlite-pyodide-kernel
or with conda
, mamba
, micromamba
, etc.
conda install -c conda-forge jupyterlite-pyodide-kernel
For more options see the development install or contributing guide.
Usage
Build a JupyterLite site:
jupyter lite build
Some new CLI options are also available:
jupyter lite --help
This should show something like this:
--piplite-wheels=<typedtuple-item-1>...
Local paths or URLs of piplite-compatible wheels to copy and index
Default: ()
Equivalent to: [--PipliteAddon.piplite_urls]
--pyodide=<Unicode>
Local path or URL of a pyodide distribution tarball
Default: ''
Equivalent to: [--PyodideAddon.pyodide_url]
Learn more
⚠️ The documentation for advanced configuration is available from the main JupyterLite documentation site:
Uninstall
To remove the extension, run:
pip uninstall jupyterlite-pyodide-kernel # or howver you installed it
Prerelease Versions
To install pre-release versions with pip
:
pip install --upgrade --pre jupyterlite-pyodide-kernel
Or, similarly for the conda
ecosystem, for alpha
packages:
conda install \
-c conda-forge/label/jupyterlite_core_alpha \
-c conda-forge/label/jupyterlite_pyodide_kernel_alpha \
-c conda-forge \
jupyterlite-pyodide-kernel
Note:
_beta
and_rc
packages would follow a similar channel naming convention
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. one of:
virtualenv
mamba
conda
Ensure the local development environment has:
git
nodejs 20
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for jupyterlite_pyodide_kernel-0.2.0a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76a235d9710a60cfe50ad8fd0d68c50f486205fdec200dea6929c41096d41557 |
|
MD5 | 5b64e57f156637549d89bf20676bb51b |
|
BLAKE2b-256 | 5994b24e017c3946b728623815db30edd4fdba93840282526abc5eea4a7846cc |
Hashes for jupyterlite_pyodide_kernel-0.2.0a2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 77692563e5aafd211b1c97f4cd400bd7f5c3f92f3e115346785aa32adda562b3 |
|
MD5 | b18f5581fde2cc31eca0495e54f01f3e |
|
BLAKE2b-256 | b8b9a5bd235d6a4116f7f434d41bc1f023ad1dbbe7930bd07dac34926e327a83 |