Python kernel for JupyterLite powered by Pyodide

These details have been verified by PyPI

Project links

GitHub Statistics

Maintainers

jtp jupyterlite-bot martinRenou

These details have not been verified by PyPI

Project links

Project description

jupyterlite-pyodide-kernel

A Python kernel for JupyterLite powered by Pyodide,

Requirements

python >=3.8

Compatibility

With Jupyter

status	`jupyterlite-pyodide-kernel`	`jupyterlite-core`	`jupyterlab`	`notebook`	`retrolab`
pre	`0.4.*`	`>=0.4,<0.5`	`>=4.2.0,<4.3`	`>=7.2.0,<7.3`	-
stable	`0.3.*`	`>=0.3,<0.4`	`>=4.1.1,<4.2`	`>=7.1.0,<7.2`	-
stable	`0.2.*`	`>=0.2,<0.3`	`>=4.0.7,<4.1`	`>=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.

With Pyodide

`jupyterlite-pyodide-kernel`	`pyodide`	`python`	`emscripten`
`>=0.1.0,<=0.1.1`	`0.23.*`	`3.10.*`	`3.1.29`
`>=0.1.2,<=0.2.1`	`0.24.*`	`3.10.*`	`3.1.45`
`>=0.2.2,<=0.2.3`	`0.25.*`	`3.11.*`	`3.1.46`
`>=0.3.*,<=0.4.0`	`0.25.*`	`3.11.*`	`3.1.46`
`>=0.4.*,<=0.5.0`	`0.26.*`	`3.12.*`	`3.1.58`

Note that the Emscripten version is strict down to the bugfix version.

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: _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

These details have been verified by PyPI

Project links

GitHub Statistics

Maintainers

jtp jupyterlite-bot martinRenou

These details have not been verified by PyPI

Project links

Release history Release notifications | RSS feed

This version

0.4.4

Nov 18, 2024

0.4.3

Oct 21, 2024

0.4.2

Sep 3, 2024

0.4.1

Jul 30, 2024

0.4.0

Jul 25, 2024

0.4.0rc0 pre-release

Jul 23, 2024

0.4.0b0 pre-release

Jun 21, 2024

0.4.0a2 pre-release

Jun 5, 2024

0.4.0a1 pre-release

Jun 4, 2024

0.4.0a0 pre-release

May 22, 2024

0.3.2

Jun 4, 2024

0.3.1

Mar 30, 2024

0.3.0

Mar 27, 2024

0.3.0a0 pre-release

Feb 16, 2024

0.2.3

Feb 12, 2024

0.2.2

Feb 5, 2024

0.2.1

Jan 17, 2024

0.2.0

Oct 27, 2023

0.2.0a2 pre-release

Sep 28, 2023

0.2.0a1 pre-release

Sep 21, 2023

0.1.3

Sep 26, 2023

0.1.2

Sep 15, 2023

0.1.1

Aug 22, 2023

0.1.0

Aug 3, 2023

0.0.10

Aug 3, 2023

0.0.9

Aug 2, 2023

0.0.8

May 4, 2023

0.0.7

Apr 24, 2023

0.0.6

Mar 31, 2023

0.0.5

Mar 15, 2023

0.0.4

Mar 10, 2023

0.0.3

Mar 10, 2023

0.0.2

Mar 6, 2023

0.0.0a0 pre-release

Jun 21, 2022

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

jupyterlite_pyodide_kernel-0.4.4.tar.gz (526.3 kB view details)

Uploaded Nov 18, 2024 Source

Built Distribution

jupyterlite_pyodide_kernel-0.4.4-py3-none-any.whl (542.4 kB view details)

Uploaded Nov 18, 2024 Python 3

File details

Details for the file jupyterlite_pyodide_kernel-0.4.4.tar.gz.

File metadata

Download URL: jupyterlite_pyodide_kernel-0.4.4.tar.gz
Upload date: Nov 18, 2024
Size: 526.3 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for jupyterlite_pyodide_kernel-0.4.4.tar.gz
Algorithm	Hash digest
SHA256	`802b12afec252f78362773d55f2a236592a6d0c8c1a54f1d059c42f5760ef6fb`
MD5	`37f90e7dc478e6ce3100d833969c53ba`
BLAKE2b-256	`7ff6f23f0760d2a544f3690a04c7cae35f8366a0539e8fcb60c44101a677470a`

See more details on using hashes here.

File details

Details for the file jupyterlite_pyodide_kernel-0.4.4-py3-none-any.whl.

File metadata

Download URL: jupyterlite_pyodide_kernel-0.4.4-py3-none-any.whl
Upload date: Nov 18, 2024
Size: 542.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for jupyterlite_pyodide_kernel-0.4.4-py3-none-any.whl
Algorithm	Hash digest
SHA256	`5569843bad0d1d4e5f2a61b093d325cd9113a6e5ac761395a28cfd483a370290`
MD5	`3a671acf6d6277e0c1f9df91a7ae05a8`
BLAKE2b-256	`ca4c42bb232529ad3b11db6d87de6accb3a9daeafc0fdf5892ff047ee842e0a8`