Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupyter-widgets/jupyterlab-sidecar
A sidecar output widget for JupyterLab
https://github.com/jupyter-widgets/jupyterlab-sidecar
jupyterlab-extension
Last synced: 2 days ago
JSON representation
A sidecar output widget for JupyterLab
- Host: GitHub
- URL: https://github.com/jupyter-widgets/jupyterlab-sidecar
- Owner: jupyter-widgets
- License: bsd-3-clause
- Created: 2018-03-26T09:23:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-08-30T15:30:11.000Z (over 1 year ago)
- Last Synced: 2024-11-22T07:05:00.061Z (21 days ago)
- Topics: jupyterlab-extension
- Language: TypeScript
- Size: 3.72 MB
- Stars: 251
- Watchers: 15
- Forks: 39
- Open Issues: 39
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-jupyter-widgets - jupyterlab-sidecar - sidecar output widget for JupyterLab (Packages for Development / Venues for Publication)
- awesome-jupyter-resources - GitHub - 68% open · ⏱️ 04.07.2021): (JupyterLab扩展)
- best-of-jupyter - GitHub - 74% open · ⏱️ 30.08.2023): (JupyterLab Extensions)
- awesome-starred - jupyter-widgets/jupyterlab-sidecar - A sidecar output widget for JupyterLab (others)
README
# Sidecar
[](https://travis-ci.org/jupyter-widgets/jupyterlab-sidecar)
[](https://codecov.io/gh/jupyter-widgets/jupyterlab-sidecar)
A sidecar output widget for JupyterLab
## Installation
```bash
pip install sidecar
```
or
```bash
conda install sidecar
```
If you use JupyterLab <=2:
```bash
jupyter labextension install @jupyter-widgets/jupyterlab-manager
jupyter labextension install @jupyter-widgets/jupyterlab-sidecar
```
## Usage
The sidecar widget is used as a context manager, just like ipywidgets' output
widget.
```python
from sidecar import Sidecar
from ipywidgets import IntSlider
sc = Sidecar(title='Sidecar Output')
sl = IntSlider(description='Some slider')
with sc:
display(sl)
```
When a single output is displayed in a Sidecar, it is allowed to occupy all of
the vertical space available. If more content is displayed, the natural height
is used instead.
## Development
```bash
# Create a new conda environment
conda create -n jupyterlab-sidecar -c conda-forge jupyterlab ipywidgets nodejs -y
# Activate the conda environment
conda activate jupyterlab-sidecar
# 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.
```bash
# 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:
```bash
jupyter lab build --minimize=False
```
## Uninstall
```bash
pip uninstall sidecar
```
or
```bash
conda uninstall sidecar
```