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 |
|---|---|---|---|---|---|
| stable | 0.2.* |
>=0.2,<0.3 |
>=4.0.7,<5 |
>=7.0.5,<8 |
- |
| stable | 0.1.* |
>=0.1,<0.2 |
>=3.5,<3.6 |
- | >=0.3,<0.4 |
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 however 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
File details
Details for the file jupyterlite_pyodide_kernel-0.2.3.tar.gz.
File metadata
- Download URL: jupyterlite_pyodide_kernel-0.2.3.tar.gz
- Upload date:
- Size: 195.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5fef56d29d61a22b8ef2dcd123ae4c79bd5187547b2728e7f03f236109fa200b |
|
| MD5 | 7d2849aeae7cb309317acf56a35ccfb3 |
|
| BLAKE2b-256 | 00671a2d1e2e0fdc1a4d17b68bf52d072a84044d289c6ca68a356a3c6e1a0d34 |
Provenance
File details
Details for the file jupyterlite_pyodide_kernel-0.2.3-py3-none-any.whl.
File metadata
- Download URL: jupyterlite_pyodide_kernel-0.2.3-py3-none-any.whl
- Upload date:
- Size: 210.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 32b30d0f5ea5b87470cd36f824589e705c9bdaa8f7072d534aea04ec2c7993dc |
|
| MD5 | 171723849f8f9463fdba0edea193be2e |
|
| BLAKE2b-256 | 413fb1e5d76beaddd94f47cc40b8430cca1e178c3acc53cce8556156991845ac |
