https://github.com/quansight-labs/jupyter-widgets-takeover
Takeover jupyterlab with your widgets!
https://github.com/quansight-labs/jupyter-widgets-takeover
Last synced: 5 months ago
JSON representation
Takeover jupyterlab with your widgets!
- Host: GitHub
- URL: https://github.com/quansight-labs/jupyter-widgets-takeover
- Owner: Quansight-Labs
- Created: 2020-02-27T21:01:02.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T18:32:33.000Z (over 4 years ago)
- Last Synced: 2025-04-02T08:06:24.942Z (6 months ago)
- Language: Jupyter Notebook
- Homepage:
- Size: 9.18 MB
- Stars: 4
- Watchers: 6
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jupyter-widgets-takeover
Let your widgets takeover your JupyterLab!
This extension is an *experiment* on how you can control your JupyterLab layout from Python.
Check out the `Demo.ipynb`.
TODO: Add ability to remove more chrome https://github.com/jupyterlab/jupyterlab/issues/2031
## Requirements
* JupyterLab >= 1.0
## Install
```bash
jupyter labextension install jupyter-widgets-takeover @jupyter-widgets/jupyterlab-manager
```
## Contributing
### Install
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
# Move to jupyter-widgets-takeover directory
# Install dependencies
jlpm
# Build Typescript source
jlpm build
# Link your development version of the extension with JupyterLab
jupyter labextension install . @jupyter-widgets/jupyterlab-manager
# Rebuild Typescript source after making changes
jlpm build
# Rebuild JupyterLab after making any changes
jupyter lab build
```
You can watch the source directory and run JupyterLab in watch mode to watch for changes in the extension's source and automatically rebuild the extension and application.
```bash
# Watch the source directory in another terminal tab
jlpm watch
# Run jupyterlab in watch mode in one terminal tab
jupyter lab --watch
```
### Uninstall
```bash
jupyter labextension uninstall jupyter-widgets-takeover
```