Skip to main content

An extension to open a streamlit app within JupyterLab

Project description

Streamlit JupyterLab Extension

Github Actions Status

An extension to open a streamlit app within JupyterLab.

Requirements

  • JupyterLab >= 3.0

Install

To install the extension, execute:

pip install elyra-streamlit-extension

Uninstall

To remove the extension, execute:

pip uninstall elyra-streamlit-extension

Troubleshoot

If you are seeing the frontend extension, but it is not working, check that the server extension is enabled:

jupyter server extension list

If the server extension is installed and enabled, but you are not seeing the frontend extension, check the frontend extension is installed:

jupyter labextension list

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 streamlit_extension directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# Server extension must be manually installed in develop mode
jupyter server extension enable streamlit_extension
# 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

# Server extension must be manually disabled in develop mode
jupyter server extension disable streamlit_extension
pip uninstall elyra-streamlit-extension

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 @elyra/streamlit-extension 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

elyra-streamlit-extension-0.1.0.tar.gz (56.6 kB view details)

Uploaded Source

Built Distribution

elyra_streamlit_extension-0.1.0-py3-none-any.whl (120.5 kB view details)

Uploaded Python 3

File details

Details for the file elyra-streamlit-extension-0.1.0.tar.gz.

File metadata

File hashes

Hashes for elyra-streamlit-extension-0.1.0.tar.gz
Algorithm Hash digest
SHA256 26ffc8e9830a4a19edff57f9413d1521918679b99f3ab4ecb242d5c1ecadd931
MD5 19756069fcf5b6457961d1fee0767a0d
BLAKE2b-256 9abc4c7879258e9a3790a15a01f41abde6a0893c2c99b27212289cf05c2eeb26

See more details on using hashes here.

File details

Details for the file elyra_streamlit_extension-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for elyra_streamlit_extension-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9595766ee19aab73b0ed5dc76b7338702851b2de99da6fd43e64424e8aedec55
MD5 dcc173cd7cd3a365de50aa40448ee55a
BLAKE2b-256 22eae0f95501f10aa16d9458f881bcc4fa5dd84c892e545791b6e84468ff7489

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