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:
_betaand_rcpackages 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:
virtualenvmambaconda
Ensure the local development environment has:
gitnodejs 20python >=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
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.0a1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e6f119a5e64554a6ade5c420b8c2f2b93c86d5a05c58cdcc466b1ea59bf80d3b |
|
| MD5 | d446941018d51ec1dd7ed739edf7fa6f |
|
| BLAKE2b-256 | 9ffc882caa5e4bd0d7424ca2fa8deecdc339720284861a429d0aed66477712ac |
Hashes for jupyterlite_pyodide_kernel-0.2.0a1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4048ae9f757cfd51a15ae44329610c72ad7e1f1a8dd920240098845962a9a215 |
|
| MD5 | cfb4256c3226005d9395006eec507ca2 |
|
| BLAKE2b-256 | 58941eb71609f5ed097a8dfd5e4edd833dc2ee7bebd40c3cf201eec8855c163a |
