创建新的前端扩展#

简介#

JupyterLite 中有两种类型的扩展

  • 前端扩展

  • 服务器扩展

前端扩展是 JupyterLab 扩展，旨在扩展 JupyterLab 和 Notebook UI 的界面和功能。

此类扩展的示例有

创建扩展#

由于 JupyterLite 重用与 JupyterLab 相同的扩展系统，因此您可以像开发普通的 JupyterLab 扩展一样开发该扩展。

创建新环境#

最佳实践是为扩展的开发创建一个新环境。您可以使用 mamba 来实现此目的

mamba create -n my-jupyterlite-extension -c conda-forge python nodejs
mamba activate my-jupyterlite-extension

遵循扩展教程#

遵循扩展教程以开始使用。

完成教程后，您应该会有一个新的本地文件夹，其中包含在 JupyterLab 中激活的扩展。

在 JupyterLite 中加载扩展#

默认情况下，JupyterLite 能够找到安装在 PREFIX/share/labextensions 下相同环境中的 JupyterLab 扩展。

jupyterlite-core CLI 默认会自动执行此操作。在您的本地环境中

  1. 使用以下命令安装 jupyter lite CLI：pip install jupyterlite-core

  2. 构建网站：jupyter lite build。在构建日志中，您应该会看到类似以下内容，表示扩展已正确找到并复制

...
federated_extensions:copy:ext:jupyterlab_apod
.  pre_build:federated_extensions:copy:ext:jupyterlab_apod
...

  1. 提供网站：jupyter lite serve

然后，在浏览器中打开 https://:8000，您应该能够看到已加载的每日天文图片 (APOD) 扩展。

apod-tutorial

如果您迭代并对扩展进行新的更改

  • 使用 jlpm run build 重建扩展

  • 重新运行 jupyter lite build

  • 刷新页面

注意

默认情况下，jupyterlite-core 包不包含任何内核。如果您希望在测试 JupyterLite 部署中提供 Python 内核，您可以使用 pip 安装 jupyterlite-pyodide-kernel 包，或将其添加到您的依赖项列表中。

发布扩展#

一旦您的扩展运行起来，您可能希望将其发布到 PyPI，以便其他人可以安装它。

默认情况下，从模板创建的扩展与 Jupyter Releaser 兼容。

Jupyter Releaser 简化了发布过程并确保了最佳实践。

您可以在 JupyterLab 文档上了解有关发布扩展的更多信息。