jupyterlab_ws_chat

Jupyterlab的聊天扩展，基于WebSocket进行消息交换。

此包由名为jupyterlab_ws_chat的服务器端Python包和名为jupyterlab-ws-chat-extension的NPM包组成

需求

• JupyterLab >= 4.0.0

安装

要安装包，执行

pip install jupyterlab_ws_chat

卸载

要删除包，执行

pip uninstall jupyterlab_ws_chat

贡献

开发安装

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

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

# Clone the repo to your local environment
# Change directory to the python/jupyterlab-ws-chat 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 jupyterlab_ws_chat
# Rebuild 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 jupyterlab_ws_chat
pip uninstall jupyterlab_ws_chat

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

测试包

前端测试

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

要执行它们，请执行

jlpm
jlpm test

集成测试

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

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

打包扩展

参见RELEASE