jupyterlab-conda-store

信息	链接
项目
工作流程
发布

A JupyterLab 扩展，用于conda-store。

[!注意] 此扩展仅与 JupyterLab >= 4.0 兼容。

安装 📦

先决条件

您需要将conda-store安装并运行在您的本地计算机上以使用此扩展。此外

• JupyterLab >= 4.0
• Python >= 3.8

您可以使用pip安装扩展

pip install jupyterlab-conda-store

要删除扩展，请执行以下操作

pip uninstall jupyterlab-conda-store

安装开发版本 🚀

先决条件

1. 为了构建扩展包，您需要在本地计算机上安装NodeJS > 18。
2. Python >= 3.8 和 pip。

构建和链接扩展

[!NOTE] jlpm 命令是JupyterLab附带安装的yarn的固定版本。在下面的命令中，您可以使用yarn或npm代替jlpm。

1. 将此存储库克隆到您的本地计算机

   git clone https://github.com/conda-incubator/jupyterlab-conda-store.git
   

2. 切换到jupyterlab-conda-store目录

    cd jupyterlab-conda-store
   

3. 创建新的conda环境

   conda env create -f environment.yml
   
   # activate the environment
   conda activate jupyterlab-conda-store
   

4. 以开发模式安装软件包

   python -m pip install -e .
   

5. 现在您需要将扩展的开发版本链接到JupyterLab并重新构建TypeScript源

   # Install the extension dependencies
   jlpm install
   # Link your development version of the extension with JupyterLab
   jupyter labextension develop . --overwrite
   

6. 在首次安装或进行一些更改后，为了在本地JupyterLab中查看它们，请重新运行以下命令

   # Rebuild extension Typescript source after making changes
   jlpm run build
   

7. 运行JupyterLab并检查安装是否成功

   # Run JupyterLab
   jupyter lab
   

[!TIP] 有时您可能需要使用命令npm run clean:slate清理本地存储库。这将清理存储库，并重新安装和重新构建。

在您对贡献进行编码时，可以运行以下命令进行代码检查

jlpm run lint:check

卸载开发版本

1. 删除扩展

   pip uninstall jupyterlab-conda-store
   

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

发布

要创建jupyterlab-conda-store发布版本

1. 在存储库中打开一个新的new_release问题并填写发布详情。
2. 按照新发布检查列表中的步骤操作。

[!TIP] 按照a href="./RELEASE.md" rel="nofollow">RELEASE.md中的步骤操作以确保一切按预期工作。

行为准则 🤝

为了保证一个友好和欢迎的社区，我们要求所有社区成员遵守我们的行为准则。

许可证 📃

jupyterlab-conda-store是在BSD 3-Clause License下开发的。