Skip to main content

A JupyterLab extension.

Project description

interactivede

Github Actions Status Binder A JupyterLab extension.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install interactivede

Uninstall

To remove the extension, execute:

pip uninstall interactivede

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

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

interactivede-1.0.1.tar.gz (360.1 kB view details)

Uploaded Source

Built Distribution

interactivede-1.0.1-py3-none-any.whl (154.9 kB view details)

Uploaded Python 3

File details

Details for the file interactivede-1.0.1.tar.gz.

File metadata

  • Download URL: interactivede-1.0.1.tar.gz
  • Upload date:
  • Size: 360.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for interactivede-1.0.1.tar.gz
Algorithm Hash digest
SHA256 e21b5ec3149ceeb99d6ff8faf16b1134a14ba0dd6da69b5154310800c7020256
MD5 3b31e6182d91fa489bd21a1a90463546
BLAKE2b-256 d657e605806632b1bba5bace2c8eeffd13154417ca0191ebc2f480986655e889

See more details on using hashes here.

File details

Details for the file interactivede-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for interactivede-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c519a81dcdf9cc70973edaee12eb2a88b292a5c4699b96b76878d813f548345c
MD5 3f2007ce344989ea795fcb928abe1fd1
BLAKE2b-256 abce69acb730bc39dca243c63a1227aab807bea9c27d6b6e5cb5f6422c1b4f0a

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