Skip to main content

A Nelson kernel for JupyterLite, powered by Xeus

Project description

jupyterlite-xeus-nelson

The xeus-nelson Nelson kernel for JupyterLite running in the browser.

Requirements

  • jupyterlite-core >= 0.1.0b20

Install

To install the extension, execute:

pip install jupyterlite-xeus-nelson

Then build your JupyterLite site:

jupyter lite build

Uninstall

To remove the extension, execute:

pip uninstall jupyterlite_xeus_nelson

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_nelson 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_nelson

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-nelson 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-nelson-0.1.4.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

jupyterlite_xeus_nelson-0.1.4-py3-none-any.whl (1.2 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlite-xeus-nelson-0.1.4.tar.gz.

File metadata

File hashes

Hashes for jupyterlite-xeus-nelson-0.1.4.tar.gz
Algorithm Hash digest
SHA256 42336f070660b1fe3e04d6868fc4da0dada18b42a160a357027809b794daef03
MD5 6243bda69f1e0911765323834e07b9f1
BLAKE2b-256 525808770b38ecb38ca5ae57bd859db8baf88ac7868e3e5b711b28d610e74d9e

See more details on using hashes here.

File details

Details for the file jupyterlite_xeus_nelson-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_xeus_nelson-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c0e4dd7d1e3a1a1eca9d2eb596e5d278ffe2878b9d1b74b6e0a111308ea199a0
MD5 d914a26d2460773f559fa39c4801e42d
BLAKE2b-256 dedb6bb6133c5c443a5003174b8654ac27a10c8b1c92cde589564545729257cf

See more details on using hashes here.

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