Skip to main content

A collections of plugins steering an iframe with jupyter remotely

Project description

fails_components_jupyter_launcher

Github Actions Status

This is an extension, where jupyter can be steering inside an iframe. You can load, launch and save different notebooks and applets (created with applet-view extension).

Requirements

  • JupyterLab >= 4.0.0

Install

To install the extension, execute:

pip install fails_components_jupyter_launcher

Uninstall

To remove the extension, execute:

pip uninstall fails_components_jupyter_launcher

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 fails_components_jupyter_launcher directory
jlpm build
# 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 fails_components_jupyter_launcher

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 @fails-components/jupyter-applet-view within that folder.

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

fails_components_jupyter_launcher-0.0.6.tar.gz (59.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file fails_components_jupyter_launcher-0.0.6.tar.gz.

File metadata

File hashes

Hashes for fails_components_jupyter_launcher-0.0.6.tar.gz
Algorithm Hash digest
SHA256 993390d72f03ce9507c9f2da7f264324d11a3c890e0cdcac7b6dafad3cd7f697
MD5 caf9deb31fa13b20dbc2a325c4565ed4
BLAKE2b-256 6912d14a354fade35641b3cfcd333927fe97b4ad5da5e710b50facc6cb482ec2

See more details on using hashes here.

File details

Details for the file fails_components_jupyter_launcher-0.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for fails_components_jupyter_launcher-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 e628f932959370a9e903959737f428b32455a1d6eb910a46963c94ff095dc4dc
MD5 cb89b4e3ef9e9441dd16e2c13e2b1721
BLAKE2b-256 ba28c5b8c1836d4e833f5e5c5458dea002c2f4bbc6a4d5538d8abcb588bb1b33

See more details on using hashes here.

Supported by

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