jupyterlab_collaborative_chat

一个基于共享文档的聊天扩展。

此扩展由名为 jupyterlab_collaborative_chat 的服务器扩展Python包和一个名为 jupyterlab-collaborative-chat-extension 的前端扩展NPM包组成。

此扩展注册了一个 YChat 共享文档，并将该文档关联到前端聊天小部件。

要求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install jupyterlab_collaborative_chat

卸载

要删除扩展，请执行

pip uninstall jupyterlab_collaborative_chat

故障排除

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

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 jupyterlab_collaborative_chat directory
# Install package in development mode
pip install -e ".[test]"
# 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_collaborative_chat

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

测试扩展

前端测试

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

要执行它们，请执行

jlpm
jlpm test

集成测试

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

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

打包扩展

参见 RELEASE