glue-jupyterlab

JupyterLab的Glue应用程序

概述

Glue是一个开源的数据探索工具，允许用户以直观易懂的方式可视化和分析数据。此JupyterLab扩展将Glue的数据探索功能直接带入JupyterLab，使用户能够在不离开JupyterLab环境的情况下无缝分析和可视化数据。

与Glue-jupyter有什么区别？

glue-jupyter是一个库，可以直接在Python中从Jupyter Notebook（无论是使用经典Notebook还是JupyterLab）创建Glue "应用程序"对象，并使用bqplot或Matplotlib等工具创建Glue "查看器"。

glue-jupyterlab是一个扩展，允许从JupyterLab应用程序直接打开Glue会话。它重用了glue-jupyter的组件来创建查看器和底层的Glue应用程序对象。

要求

• JupyterLab >= 4.0.0,<5

安装

要安装扩展，请执行

pip install glue-jupyterlab

卸载

要删除扩展，请执行

pip uninstall glue-jupyterlab

故障排除

如果您看到前端扩展，但它不起作用，请检查服务器扩展是否已启用

jupyter server extension list

如果服务器扩展已安装并启用，但您看不到前端扩展，请检查前端扩展是否已安装

jupyter labextension list

贡献

开发安装

注意：构建扩展包需要NodeJS。

jlpm 命令是 JupyterLab 预装版本的 yarn，与 JupyterLab 一起安装。您可以使用 yarn 或 npm 替代下面的 jlpm。

# 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

您可以在不同的终端中同时监视源目录并运行 JupyterLab，以监视扩展源代码的变化并自动重新构建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm watch
# Run JupyterLab in another terminal
jupyter lab

在运行监视命令时，每次保存的更改都将立即在本地构建并可供正在运行的 JupyterLab 使用。刷新 JupyterLab 以在浏览器中加载更改（您可能需要等待几秒钟以重建扩展）。

默认情况下，jlpm build 命令为该扩展生成源映射，以便更容易使用浏览器开发工具进行调试。要为 JupyterLab 核心扩展也生成源映射，可以运行以下命令

jupyter lab build --minimize=False

开发卸载

# Server extension must be manually disabled in develop mode
jupyter server extension disable glue-jupyterlab
pip uninstall glue-jupyterlab

在开发模式下，还需要删除由 jupyter labextension develop 命令创建的符号链接。要找到其位置，可以运行 jupyter labextension list 以确定 labextensions 文件夹的位置。然后可以删除该文件夹中的名为 glue-jupyterlab 的符号链接。

测试扩展

服务器测试

此扩展使用 Pytest 对 Python 代码进行测试。

安装测试依赖项（只需安装一次）

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

要执行它们，请运行

pytest -vv -r ap --cov glue-jupyterlab

前端测试

此扩展使用 Jest 对 JavaScript 代码进行测试。

要执行它们，请执行

jlpm
jlpm test

集成测试

此扩展使用 [Playwright] 进行集成测试（也称为用户级测试）。更具体地说，JupyterLab 辅助 Galata 用于处理在 JupyterLab 中测试扩展。

有关更多信息，请参阅 ui-tests 的 README。

打包扩展

请参阅 RELEASE