JupyterLab Kernel Usage

预先通知：此扩展正在向上游贡献；未来版本将在 jupyter-server/jupyter-resource-usage 下发布。

这是一个JupyterLab的扩展，可以在侧边栏中查看内核使用情况。

该扩展由名为jupyterlab_kernel_usage的Python包（用于服务器扩展）和名为jupyterlab-kernel-usage的NPM包（用于前端扩展）组成。

要求

此用法仅适用于ipykernel >= 6.11.0的IPython内核。

贡献

开发

使用提供的environment.yaml文件来安装conda环境。

conda deactivate && \
  make env-rm && \
  make env
conda activate jupyterlab-kernel-usage

# Install the server and frontend in dev mode.
make install-dev

# In terminal 1, Start the jupyterlab.
# open http://localhost:8234?token=...
make jlab

# In terminal 2, start the extension building in watch mode.
make watch

当对扩展进行更改时，您需要执行jupyter labextension build，或者，在存储库的根目录下启动jlpm run watch以在每次更改时重新构建。对于前端扩展的更改，您无需重新启动或重新构建JupyterLab，但对于Python代码的更改则需要重新启动服务器。

开发安装

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

jlpm命令是JupyterLab安装的yarn的固定版本。您可以使用yarn或npm替代下面的jlpm。

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

开发卸载

# Server extension must be manually disabled in develop mode
jupyter server extension disable jupyterlab_kernel_usage
pip uninstall jupyterlab_kernel_usage

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

要求

• JupyterLab >= 3.0

安装

要安装扩展，请执行

pip install jupyterlab_kernel_usage

卸载

要删除扩展，请执行

pip uninstall jupyterlab_kernel_usage

故障排除

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

jupyter server extension list

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

jupyter labextension list

打包扩展

请参阅RELEASE