jupyterlab-collaborative-input

在JupyterLab中显示协作输入

需求

• JupyterLab >= 4.0

安装

使用pip安装此包，请运行

pip install jupyterlab_collaborative_input

贡献

开发安装

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

jlpm命令是JupyterLab捆绑的yarn版本，与JupyterLab一起安装。您可以使用yarn或npm代替下面的jlpm。

# Clone the repo to your local environment
# Change directory to the jupyterlab_collaborative_input directory
# Install package in development mode
pip install -e .
# Link your development version of the extension with JupyterLab
jupyter labextension develop . --overwrite
# 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

发布

在开始之前，您需要先运行： pip install twine jupyter_packaging

1. 更新 package.json 中的版本，并在 CHANGELOG.md 中更新发布日期
2. 提交步骤 1 中的更改，为其添加标签，然后推送

git commit -am <msg>
git tag vX.Z.Y
git push && git push --tags

3. 创建工件

rm -rf dist build jupyterlab_collaborative_input/labextension
jlpm run build
python setup.py sdist bdist_wheel

4. 对此进行测试 PyPI。您也可以从这里安装以进行测试

twine upload --repository-url https://test.pypi.org/legacy/ dist/*
# In a new venv
pip install --index-url https://test.pypi.org/simple/ jupyterlab_collaborative_input

5. 上传到 PyPI

twine upload dist/*

卸载

pip uninstall jupyterlab_collaborative_input