papyri_lab

纸草的JupyterLab扩展

此扩展由名为 papyri_lab 的Python包（用于服务器扩展）和名为 papyri-lab 的NPM包（用于前端扩展）组成。

需求

• JupyterLab >= 4.0.0

安装

要安装扩展，请执行

pip install papyri_lab

卸载

要删除扩展，请执行

pip uninstall papyri_lab

故障排除

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

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 papyri_lab 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 papyri_lab
# 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

开发卸载

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

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

测试扩展

服务器测试

此扩展使用Pytest进行Python代码测试。

安装测试依赖项（仅需一次）

pip install -e ".[test]"
# Each time you install the Python package, you need to restore the front-end extension link
jupyter labextension develop . --overwrite

要执行它们，请运行

pytest -vv -r ap --cov papyri_lab

前端测试

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

要执行它们，请执行

jlpm
jlpm test

集成测试

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

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

打包扩展

见RELEASE