Skip to main content

NGL tool for JupyterLab 3.x.

Project description

jupyterlab_ngl

Github Actions StatusBinder

NGL tool for JupyterLab 3.x.

Requirements

  • JupyterLab >= 3.0

Install

pip install jupyterlab_ngl

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 jupyterlab_ngl 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 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).

By default, the jlpm run 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

Uninstall

pip uninstall jupyterlab_ngl

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

jupyterlab_ngl-0.1.5.tar.gz (1.7 MB view details)

Uploaded Source

Built Distribution

jupyterlab_ngl-0.1.5-py3-none-any.whl (3.8 MB view details)

Uploaded Python 3

File details

Details for the file jupyterlab_ngl-0.1.5.tar.gz.

File metadata

  • Download URL: jupyterlab_ngl-0.1.5.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.9.1

File hashes

Hashes for jupyterlab_ngl-0.1.5.tar.gz
Algorithm Hash digest
SHA256 58395b119ca89e956ee641f1d808136f8060de7db9f36cfb511d4c0ca8ad0021
MD5 5a865c8100d692a1a99fafd0338d9555
BLAKE2b-256 99fda196f0e0d5f0b34354ea73a12d53b39dad3f6fa6e6f05afe2dd3b60c532b

See more details on using hashes here.

File details

Details for the file jupyterlab_ngl-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_ngl-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 3.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.6.1 requests/2.25.1 setuptools/51.0.0.post20201207 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.9.1

File hashes

Hashes for jupyterlab_ngl-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 abc1c5d0e2c722f725669e36e64686e2ccd78d999e965f575d7f881af6df6591
MD5 48209d50d4b8e6b3d0f83d64f3d84a89
BLAKE2b-256 656aa0f32df107a09e39dc1d0d4c136f2189505b19820fd5e0fcb175297f5a16

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