Jupyter 客户端

jupyter_client 包含 Jupyter 协议 的参考实现。它还提供了用于处理内核的客户端和内核管理 API。

它还提供了 jupyter kernelspec 入口点，用于安装供 Jupyter 前端使用的内核规范。

开发设置

Jupyter 贡献者指南 提供了有关为 Jupyter 项目贡献代码或文档的详细信息。以下是为方便您设置开发环境而提供的简要说明。

编码

您需要在搜索路径中有 Python 和 pip。将 Jupyter Client 的 git 仓库克隆到您的计算机上，例如在 /my/project/jupyter_client 目录下：

cd /my/projects/
git clone git@github.com:jupyter/jupyter_client.git

现在创建一个可编辑安装，并通过执行以下命令下载代码和测试套件的依赖项：

cd /my/projects/jupyter_client/
pip install -e ".[test]"
pytest

最后一个命令运行测试套件以验证设置。在开发过程中，您可以向 pytest 传递文件名，它将只执行这些测试。

文档

Jupyter Client 的文档是使用 Sphinx 从 docs/ 目录中的文件生成的。有关设置 Sphinx 及其可选模块的说明，请参阅文档指南。您还需要 make 命令。 要安装处理 Jupyter Client 文档所需的最小 Sphinx 配置，请执行：

pip install ".[doc]"

以下命令将生成 HTML 格式的文档并检查断开的链接：

cd /my/projects/jupyter_client/docs/
make html linkcheck

将浏览器指向以下 URL 以访问生成的文档：

file:///my/projects/jupyter_client/docs/_build/html/index.html

贡献

jupyter-client 已采用自动代码格式化，因此您无需过多担心代码风格。只要您的代码是有效的，预提交钩子就应该能处理好代码的外观。您可以随时手动调用预提交钩子：

pre-commit run

这将对您的代码进行任何自动格式化，并告诉您它无法自动修复的任何错误。您还可以在文本编辑器中安装 black 集成 以自动格式化代码。

如果您在使用 pre-commit install 设置预提交钩子之前已经提交了文件，可以使用 pre-commit run --all-files 修复所有内容。之后，您需要自己进行修复提交。

默认情况下，某些钩子只在 CI 上运行，但您可以通过使用 --hook-stage manual 参数来调用它们。

关于 Jupyter 开发团队

Jupyter 开发团队是所有 Jupyter 项目贡献者的集合。这包括所有 Jupyter 子项目。

在 GitHub 上协调开发的核心团队可以在这里找到：https://github.com/jupyter/。

我们的版权政策

Jupyter 使用共享版权模式。每个贡献者都保留其对 Jupyter 贡献的版权。但需要注意的是，这些贡献通常只是对仓库的更改。因此，Jupyter 源代码整体并不属于任何单个人或机构的版权。相反，它是整个 Jupyter 开发团队的集体版权。如果个别贡献者想要保留他们对特定更改/贡献的版权记录，他们应该在提交更改到 Jupyter 仓库时，在提交消息中注明其版权。

考虑到这一点，任何源代码文件都应使用以下横幅来表明版权和许可条款：

# Copyright (c) Jupyter Development Team.
# Distributed under the terms of the Modified BSD License.