jupyterlab_wall

一个用于向用户发出系统事件警报的JupyterLab扩展。

此扩展由名为 jupyterlab_wall 的服务器扩展Python包和名为 jupyterlab-wall 的前端扩展NPM包组成。

需求

• JupyterLab >= 3.0 < 4

安装

pip install jupyterlab_wall

您还需要定义一组应触发的警报，请参阅 'jupyter_jupyterlab_wall_config.py' 中的示例。此配置需要从jupyter配置路径之一集成到您的 jupyter_server_config.py 中才能生效。您可以使用 'jupyter_jupyterlab_wall_config.py' 的内容定义新的 jupyter_server_config.py。

您可以使用以下命令查看所有jupyter路径：

jupyter --paths

例如，您可以将示例警报复制到您的 ${HOME}/.jupyter/ 目录。

cp ./jupyter_jupyterlab_wall_config.py ${HOME}/.jupyter/jupyter_server_config.py

或者，将示例警报追加到现有文件中。

cat ./jupyter_jupyterlab_wall_config.py >> ${HOME}/.jupyter/jupyter_server_config.py

故障排除

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

jupyter server extension list

如果服务器扩展已安装并启用，但您未看到前端扩展，请检查前端扩展是否已安装

jupyter labextension list

您可以检查当前警报配置

jupyter server --show-config

如果没有警报被限制，则内部定义了一个测试警报，您可以将其用于验证扩展是否正常工作。您可以创建文件 '/tmp/alert_test'，如果扩展正常工作，它将在jupyterlab中触发警报。

贡献

开发安装

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

jlpm 命令是JupyterLab的固定版本 yarn，它随JupyterLab一起安装。您可以使用 yarn 或 npm 而不是 jlpm。

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

您可以在不同的终端中同时监视源目录并运行 JupyterLab，以监视扩展的源代码更改并自动重建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

当监视命令运行时，每次保存的更改都将立即在本地上构建并可供正在运行的 JupyterLab 使用。刷新 JupyterLab 以在浏览器中加载更改（您可能需要等待几秒钟以重建扩展）。

默认情况下，jlpm run build 命令为该扩展生成源映射，以便使用浏览器开发者工具进行调试。要为 JupyterLab 核心扩展也生成源映射，可以运行以下命令

jupyter lab build --minimize=False

卸载

pip uninstall jupyterlab_wall