# glue-jupyterlab > A JupyterLab extension for glue-viz Latest version **0.3.0** (published 2023-07-10) · BSD-3-Clause license · 0 weekly downloads ## Install ```sh npm install glue-jupyterlab pnpm add glue-jupyterlab yarn add glue-jupyterlab bun add glue-jupyterlab ``` ## Health **Score 40/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned. ## Facts | | | |---|---| | Version | 0.3.0 | | Published | 2023-07-10 | | First published | 2023-07-10 | | Weekly downloads | 0 | | License | BSD-3-Clause | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 22 | | Unpacked size | 188.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 20 | | Author | QuantStack | | Maintainers | martinrenou | | Keywords | jupyter, jupyterlab, jupyterlab-extension | ## Links - npm: https://www.npmjs.com/package/glue-jupyterlab - Repository: https://github.com/QuantStack/glue-jupyterlab - Issues: https://github.com/QuantStack/glue-jupyterlab/issues - npm.io page: https://npm.io/package/glue-jupyterlab ## Dependencies (22) - [gridstack](https://npm.io/package/gridstack.md) ^6.0.1 - [yjs-widgets](https://npm.io/package/yjs-widgets.md) ^0.3.3 - [@jupyter/ydoc](https://npm.io/package/@jupyter/ydoc.md) ^1.0.2 - [@lumino/widgets](https://npm.io/package/@lumino/widgets.md) ^2.1.0 - [@lumino/commands](https://npm.io/package/@lumino/commands.md) ^2.1.0 - [@lumino/algorithm](https://npm.io/package/@lumino/algorithm.md) ^2.0.0 - [@lumino/coreutils](https://npm.io/package/@lumino/coreutils.md) ^2.1.0 - [@lumino/messaging](https://npm.io/package/@lumino/messaging.md) ^2.0.0 - [@lumino/signaling](https://npm.io/package/@lumino/signaling.md) ^2.1.0 - [@lumino/disposable](https://npm.io/package/@lumino/disposable.md) ^2.1.0 - [@jupyter/docprovider](https://npm.io/package/@jupyter/docprovider.md) ^1.0.0-alpha.8 - [@jupyterlab/apputils](https://npm.io/package/@jupyterlab/apputils.md) ^4.0.0 - [@jupyterlab/launcher](https://npm.io/package/@jupyterlab/launcher.md) ^4.0.2 - [@jupyterlab/mainmenu](https://npm.io/package/@jupyterlab/mainmenu.md) ^4.0.0 - [@jupyterlab/notebook](https://npm.io/package/@jupyterlab/notebook.md) ^4.0.0 - [@jupyterlab/services](https://npm.io/package/@jupyterlab/services.md) ^7.0.0 - [@jupyterlab/coreutils](https://npm.io/package/@jupyterlab/coreutils.md) ^6.0.0 - [@jupyterlab/rendermime](https://npm.io/package/@jupyterlab/rendermime.md) ^4.0.0 - [@jupyterlab/application](https://npm.io/package/@jupyterlab/application.md) ^4.0.0 - [@jupyterlab/docregistry](https://npm.io/package/@jupyterlab/docregistry.md) ^4.0.0 - [@jupyterlab/observables](https://npm.io/package/@jupyterlab/observables.md) ^5.0.0 - [@jupyterlab/ui-components](https://npm.io/package/@jupyterlab/ui-components.md) ^4.0.0 ## Recent versions - 0.3.0 (latest) — 2023-07-10 ## README # glue-jupyterlab The Glue application for JupyterLab [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/QuantStack/glue-jupyterlab/stable?urlpath=lab) ## Overview Glue is an open-source data exploration tool that allows users to visualize and analyze data in a way that is intuitive and easy to understand. This JupyterLab extension brings Glue's data exploration capabilities directly into JupyterLab, allowing users to seamlessly analyze and visualize data without leaving their JupyterLab environment. ![glue-jupyterlab](glue-jupyterlab.png) ## What is the difference with Glue-jupyter? [`glue-jupyter`](https://github.com/glue-viz/glue-jupyter) is a library for creating a Glue "application" object directly in Python from a Jupyter Notebook (either using classic Notebook or JupyterLab) and create Glue "viewers" using tools like bqplot or Matplotlib. glue-jupyterlab is an extension that allows opening Glue sessions directly from the JupyterLab application. It reuses components of glue-jupyter for creating the viewers and the underlying Glue application object. ## Requirements - JupyterLab >= 4.0.0,<5 ## Install To install the extension, execute: ```bash pip install glue-jupyterlab ``` ## Uninstall To remove the extension, execute: ```bash pip uninstall glue-jupyterlab ``` ## 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 glue-jupyterlab directory # Install package in development mode pip install -e ".[test]" # 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 glue-jupyterlab # 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 glue-jupyterlab pip uninstall glue-jupyterlab ``` 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 `glue-jupyterlab` within that folder. ### Testing the extension #### Server tests This extension is using [Pytest](https://docs.pytest.org/) for Python code testing. Install test dependencies (needed only once): ```sh pip install -e ".[test]" # Each time you install the Python package, you need to restore the front-end extension link jupyter labextension develop . --overwrite ``` To execute them, run: ```sh pytest -vv -r ap --cov glue-jupyterlab ``` #### Frontend tests This extension is using [Jest](https://jestjs.io/) for JavaScript code testing. To execute them, execute: ```sh jlpm jlpm test ``` #### Integration tests This extension uses [Playwright] for the integration tests (aka user level tests). More precisely, the JupyterLab helper [Galata](https://github.com/jupyterlab/jupyterlab/tree/master/galata) is used to handle testing the extension in JupyterLab. More information are provided within the [ui-tests](./ui-tests/README.md) README. ### Packaging the extension See [RELEASE](RELEASE.md) --- _Source: https://npm.io/package/glue-jupyterlab · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._