笔记本仪表板分析扩展

一个前端JupyterLab扩展，显示笔记本完成情况的可视化。

需求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install notebookvisu

卸载

要删除扩展，请执行

pip uninstall notebookvisu

贡献

开发安装

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

jlpm 命令是JupyterLab附带的yarn的固定版本。您可以使用 yarn 或 npm 代替 jlpm。

# Clone the repo to your local environment
# Change directory to the notebookvisu directory
# 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 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

开发卸载

pip uninstall notebookvisu

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

测试扩展

前端测试

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

要执行它们，请执行

jlpm
jlpm test

集成测试

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

更多信息请参阅 ui-tests 中的 README。

打包扩展

见 RELEASE