跳转到主要内容

Jupyter协议实现和客户端库

项目描述

Jupyter客户端

Build Status Documentation Status

jupyter_client 包含 Jupyter协议 的参考实现。它还提供用于与内核一起工作的客户端和内核管理API。

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

开发设置

Jupyter贡献指南 提供了有关向Jupyter项目贡献代码或文档的详细信息。以下简要说明设置开发环境的步骤仅供参考。

编码

您需要在搜索路径上安装Python和 pip。将Jupyter客户端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 的文档是由 docs/ 目录中的文件生成的,使用 Sphinx。有关使用可选模块设置 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 钩子将负责其外观。您可以通过以下方式手动调用 pre-commit 钩子:

pre-commit run

这将运行您代码上的任何自动格式化,并告知您它无法自动修复的任何错误。您还可以将 black 集成 安装到您的文本编辑器中以自动格式化代码。

如果您在设置 pre-commit install 的 pre-commit 钩子之前已经提交了文件,您可以使用 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.

项目详情


发布历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解有关安装包的更多信息。

源分发

jupyter_client-8.6.3.tar.gz (342.0 kB 查看哈希值)

上传时间

构建分发

jupyter_client-8.6.3-py3-none-any.whl (106.1 kB 查看哈希值)

上传时间 Python 3

由以下支持