astronbs

JupyterLab扩展，用于将模板笔记本放置在当前目录

此扩展由一个名为astronbs的Python包（服务器扩展）和一个名为astronbs的NPM包（前端扩展）组成。

需求

• JupyterLab >= 3.0

安装

要安装扩展，执行

pip install astronbs

卸载

要删除扩展，执行

pip uninstall astronbs

故障排除

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

jupyter server extension list

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

jupyter labextension list

贡献

开发安装

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

《jlpm》命令是JupyterLab预装的yarn的版本，与JupyterLab一起安装。您可以使用以下命令替代《jlpm》：yarn 或 npm。

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

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

测试扩展

服务器测试

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

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

pip install -e ".[test]"

要执行它们，运行

pytest -vv -r ap --cov astronbs

前端测试

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

要执行它们，执行

jlpm
jlpm test

集成测试

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

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

打包扩展

见RELEASE