trame-jupyter-extension

trame通信层的JupyterLab扩展

此扩展由名为 trame-jupyter-extension 的Python包（用于服务器扩展）和名为 trame-jupyter-extension 的NPM包（用于前端扩展）组成。

需求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install trame-jupyter-extension

卸载

要删除扩展，请执行

pip uninstall trame-jupyter-extension

故障排除

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

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 trame-jupyter-extension directory
# Install package in development mode
pip install -e "."
# 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 trame-jupyter-extension
# 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 trame-jupyter-extension
pip uninstall trame-jupyter-extension

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

打包扩展

请参阅 RELEASE