Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elyra-ai/streamlit-extension
A JupyterLab extension to open a streamlit app within JupyterLab.
https://github.com/elyra-ai/streamlit-extension
jupyterlab jupyterlab-extension streamlit
Last synced: 4 months ago
JSON representation
A JupyterLab extension to open a streamlit app within JupyterLab.
- Host: GitHub
- URL: https://github.com/elyra-ai/streamlit-extension
- Owner: elyra-ai
- License: apache-2.0
- Created: 2022-06-03T20:17:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-20T04:47:18.000Z (over 1 year ago)
- Last Synced: 2024-04-23T09:58:00.800Z (9 months ago)
- Topics: jupyterlab, jupyterlab-extension, streamlit
- Language: Python
- Homepage:
- Size: 949 KB
- Stars: 5
- Watchers: 3
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Streamlit JupyterLab Extension
[](https://github.com/elyra-ai/streamlit-extension/actions/workflows/build.yml)
An extension to open a streamlit app within JupyterLab.
## Requirements
- JupyterLab >= 3.0
## Install
To install the extension, execute:
```bash
pip install elyra-streamlit-extension
```
## Uninstall
To remove the extension, execute:
```bash
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:
```bash
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:
```bash
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](https://yarnpkg.com/) that is installed with JupyterLab. You may use
`yarn` or `npm` in lieu of `jlpm` below.
```bash
# 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.
```bash
# 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:
```bash
jupyter lab build --minimize=False
```
### Development uninstall
```bash
# 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](RELEASE.md)