Skip to main content

Python kernel for JupyterLite powered by Pyodide

Project description

jupyterlite-pyodide-kernel

A Python kernel for JupyterLite powered by Pyodide,

ci-badge lite-badge docs-badge

🚧 This is a work in progress 🚧

The Pyodide kernel is currently being extracted from the main JupyterLite repository to this repo. See the JupyterLite issue for background and current status.

⚠️ below denotes instructions that are incomplete or subject to change.

Requirements

  • python >=3.8
  • jupyterlite >=0.1.0b19

⚠️ At present, jupyterlite-pyodide-kernel is only compatible with the in-development version mentioned above, and requires nodejs

A normal install does not require nodejs, but a development install does.

Install

⚠️ jupyterlite-pyodide-kernel is not yet published on PyPI.

For now, the contributing guide describes how to build the package locally.

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:

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

Project details


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.0.3.tar.gz (259.6 kB view details)

Uploaded Source

Built Distribution

jupyterlite_pyodide_kernel-0.0.3-py3-none-any.whl (276.8 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for jupyterlite_pyodide_kernel-0.0.3.tar.gz
Algorithm Hash digest
SHA256 a4ef01c744128ab1bf859f722f1657e832e2a9a77e3408dda13a3bae354c1b6a
MD5 23766de54247827540daf09f9eb03bfd
BLAKE2b-256 d7df3849db05d45e1b51cda69665bc213b8fc8e36cd1cd1cee0c3afab1bf8adf

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for jupyterlite_pyodide_kernel-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 42c54fb0ba91e9288e267fda0ed99b2c5f538a1a2241927351f05fd20580a440
MD5 c68eed919e790fd89abd81a208c9ee01
BLAKE2b-256 fcc786ce1749f4f3d4109c1ad5b8442e74f7cd8594296c57875097d7ca453248

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page