jupyterlab-form-js

为bpmn.io/form-js定制的Jupyter小部件库

安装

您可以使用pip进行安装

pip install jupyterlab_form_js

如果您使用的是Jupyter Notebook 5.2或更早版本，您可能还需要启用nbextension

jupyter nbextension enable --py [--sys-prefix|--user|--system] jupyterlab_form_js

开发安装

创建开发环境

conda create -n jupyterlab_form_js-dev -c conda-forge nodejs yarn python jupyterlab
conda activate jupyterlab_form_js-dev

安装Python。这将也会构建TS包。

pip install -e ".[test, examples]"

在开发您的扩展时，您需要手动使用笔记本/实验室前端启用您的扩展。对于实验室，这是通过以下命令完成的

jupyter labextension develop --overwrite .
yarn run build

对于经典笔记本，您需要运行

jupyter nbextension install --sys-prefix --symlink --overwrite --py jupyterlab_form_js
jupyter nbextension enable --sys-prefix --py jupyterlab_form_js

请注意，在Windows上--symlink标志不起作用，因此您将必须在此处每次重新构建您的扩展时都运行install命令。对于某些安装，您可能还需要另一个标志而不是--sys-prefix，但这里不会解释这些标志的含义。

如何查看您的更改

Typescript

如果您使用JupyterLab进行开发，那么您可以在不同的终端中同时运行JupyterLab并监视源目录，以监视扩展的源代码并在自动重建小部件时进行更改。

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

更改后，等待构建完成，然后刷新浏览器，更改应该生效。

Python

如果您修改了Python代码，则需要重新启动笔记本内核以使其生效。

更新版本

要更新版本，请安装tbump并使用它来提升版本。默认情况下，它还会创建一个标签。

pip install tbump
tbump <new-version>