Skip to main content

A Python kernel for JupyterLite, powered by Xeus

Project description

jupyterlite-xeus-python

ci-badge docs-badge

The xeus-python Python kernel for JupyterLite running in the browser.

jupyterlite-xeus-python

Install

You can install the kernel with conda/mamba:

mamba install -c conda-forge jupyterlite-xeus-python

Or using pip:

pip install jupyterlite-xeus-python

Then build your JupyterLite site:

jupyter lite build

Pre-installed packages

xeus-python allows you to pre-install packages in the Python runtime. You can pre-install packages by adding an environment.yml file in the JupyterLite build directory, this file will be found automatically by xeus-python which will pre-build the environment when running jupyter lite build.

Furthermore, this automatically installs any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.

Say you want to install NumPy, Matplotlib and ipycanvas, it can be done by creating the environment.yml file with the following content:

name: xeus-python-kernel
channels:
  - https://repo.mamba.pm/emscripten-forge
  - conda-forge
dependencies:
  - numpy
  - matplotlib
  - ipycanvas

Then you only need to build JupyterLite:

jupyter lite build

You can also pick another name for that environment file (e.g. custom.yml), by doing so, you will need to specify that name to xeus-python:

jupyter lite build --XeusPythonEnv.environment_file=custom.yml

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# Clone the repo to your local environment
# Change directory to the jupyterlite-xeus-python directory
# Install package in development mode
python -m pip install -e .

# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite

# Rebuild extension Typescript source after making changes
jlpm run build

You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

Development uninstall

pip uninstall jupyterlite-xeus-python

In development mode, you will also need to remove the symlink created by jupyter labextension develop command. To find its location, you can run jupyter labextension list to figure out where the labextensions folder is located. Then you can remove the symlink named jupyterlite-xeus-python within that folder.

Packaging the extension

See RELEASE

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_xeus_python-1.0.0a1.tar.gz (14.5 MB view details)

Uploaded Source

Built Distribution

jupyterlite_xeus_python-1.0.0a1-py3-none-any.whl (40.2 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlite_xeus_python-1.0.0a1.tar.gz.

File metadata

File hashes

Hashes for jupyterlite_xeus_python-1.0.0a1.tar.gz
Algorithm Hash digest
SHA256 fe6ec26c282b370c7744266985f9ddf81caee258ac4c9adc5cb3cb8d39e0a2c2
MD5 0a6cb4633c401adc6f9d6ad0f8895afd
BLAKE2b-256 557acf8aaaf0ff7a8006c4bbec5508cacf5f9485e84b4f71bddcc2b11320815a

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlite_xeus_python-1.0.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_xeus_python-1.0.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 7de2c76e2ad620ebfde74bc6c65016579d1647de166854d01c11e0618d0693d9
MD5 af258bd99853f4576219832d69439f0f
BLAKE2b-256 01c499db5d434c598aa9d06c98520cced6675b180dabc130faf9e4002c655b77

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