jupyterlab-urdf

用于JupyterLab的URDF查看器和编辑器扩展。

需求

• JupyterLab >= 4.0.0

安装

要安装此扩展，请执行

pip install jupyterlab-urdf

卸载

要移除此扩展，请执行

pip uninstall jupyterlab-urdf

贡献

开发安装

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

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

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

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

测试扩展

前端测试

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

要执行它们，执行

jlpm
jlpm test

集成测试

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

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

打包扩展

见 RELEASE