Skip to main content

Connect JupyterLab to Lightrail AI

Project description

lightrail_jupyterlab

Github Actions Status Connect JupyterLab to Lightrail AI

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install lightrail_jupyterlab

Uninstall

To remove the extension, execute:

pip uninstall lightrail_jupyterlab

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 lightrail_jupyterlab directory
# Install package in development mode
pip install -e "."
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Rebuild extension Typescript source after making changes
jlpm 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 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).

By default, the jlpm build command generates the source maps for this extension to make it easier to debug using the browser dev tools. To also generate source maps for the JupyterLab core extensions, you can run the following command:

jupyter lab build --minimize=False

Development uninstall

pip uninstall lightrail_jupyterlab

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 lightrail-jupyterlab 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

lightrail_jupyterlab-0.1.1.tar.gz (114.2 kB view details)

Uploaded Source

Built Distribution

lightrail_jupyterlab-0.1.1-py3-none-any.whl (29.8 kB view details)

Uploaded Python 3

File details

Details for the file lightrail_jupyterlab-0.1.1.tar.gz.

File metadata

  • Download URL: lightrail_jupyterlab-0.1.1.tar.gz
  • Upload date:
  • Size: 114.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.0

File hashes

Hashes for lightrail_jupyterlab-0.1.1.tar.gz
Algorithm Hash digest
SHA256 35391dc0b2bf852f7b2262f2c13686417b92cc81f65bb90cbebfbc1392de7ab1
MD5 49bc327174179629c5bf1dbeb09a1cb4
BLAKE2b-256 59febc20edc9b04a5ea20c8d95785a675d0431b8bcf8202b9420642033a47886

See more details on using hashes here.

File details

Details for the file lightrail_jupyterlab-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for lightrail_jupyterlab-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e93d56cbf22f9001d498012b1e8aa9432dd213ff0388a8510bf9e9d6f845ec8a
MD5 8148cb60a99907b13768f0835e56802d
BLAKE2b-256 404597177dd046e12ddaa16d38665851f4470ac23d0a48b09c90d6ce2a254209

See more details on using hashes here.

Supported by

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