Skip to main content

A Lua kernel for JupyterLite, powered by Xeus

Project description

jupyterlite-xeus-lua-kernel

Github Actions Status

A Lua kernel for JupyterLite running in the browser.

jupyterlite-xeus-lua

Requirements

  • JupyterLite >= 0.1.0a14

Install

To install the extension, execute:

pip install jupyterlite_xeus_lua

Then build your JupyterLite site:

jupyter lite build

Uninstall

To remove the extension, execute:

pip uninstall jupyterlite_xeus_lua

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

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-lua 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-lua-0.3.3.tar.gz (2.3 MB view details)

Uploaded Source

Built Distribution

jupyterlite_xeus_lua-0.3.3-py3-none-any.whl (2.2 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlite-xeus-lua-0.3.3.tar.gz.

File metadata

  • Download URL: jupyterlite-xeus-lua-0.3.3.tar.gz
  • Upload date:
  • Size: 2.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for jupyterlite-xeus-lua-0.3.3.tar.gz
Algorithm Hash digest
SHA256 131b6315c759b525c928fbf6716ce6454e488bc6154da2f9c31e5fe14fe0293f
MD5 3247bd4f305c8830d24f8c170fdf7213
BLAKE2b-256 b3764231596f951f12c5fcf370c97818130ccd5b59a773ac9432e75b07a367f9

See more details on using hashes here.

File details

Details for the file jupyterlite_xeus_lua-0.3.3-py3-none-any.whl.

File metadata

File hashes

Hashes for jupyterlite_xeus_lua-0.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 ae739f641ee61f500a3afa3c38ca47412b7d1af31eafd4bbd31661f649146e4d
MD5 7ffa13b365330242bd1a76bcbc77d7c3
BLAKE2b-256 a106b234b376e0f7d0244445f5653d29b5106bd5052f8bd5084ef6d77610604f

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