Skip to main content

A Python kernel for JupyterLite, powered by Xeus

Project description

jupyterlite-xeus-python-kernel

ci-badge docs-badge

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

jupyterlite-xeus-python

Requirements

  • JupyterLite >= 0.1.0a14

Install

To install the extension, execute:

pip install jupyterlite-xeus-python

Then build your JupyterLite site:

jupyter lite build

Uninstall

To remove the extension, execute:

pip uninstall jupyterlite-xeus-python

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

Uploaded Source

Built Distribution

jupyterlite_xeus_python-0.3.0-py3-none-any.whl (14.4 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlite-xeus-python-0.3.0.tar.gz.

File metadata

File hashes

Hashes for jupyterlite-xeus-python-0.3.0.tar.gz
Algorithm Hash digest
SHA256 a8accfc3e4ebe8a28c4cf5860dab247adb078b892e18d2ee925bf157c4cd0691
MD5 e0c94ee70a92f58e8ce7df1fa89daa52
BLAKE2b-256 f65475a02fa947d0c410be11ea0cc4a25e5d1680c653b5b04579ee7c522dece7

See more details on using hashes here.

Provenance

File details

Details for the file jupyterlite_xeus_python-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_xeus_python-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7e268a416d5f9a6755824cba2dfb65769338486b07fbbb4f5fa94e6a5d19fdb6
MD5 77d87e1a2a3a09f3dc566611ef93d996
BLAKE2b-256 51046aeb2ac78a853892a463c3217c4fa931e58b3f89fe81185ea1bb99fe66f5

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