Project Icon

jupyter_client

Jupyter协议实现与内核管理工具

jupyter_client作为Jupyter协议的参考实现,提供内核管理API和客户端功能。它包含jupyter kernelspec入口点,用于安装Jupyter前端内核规范。作为Jupyter生态系统的核心组件,该项目为开发者提供了便捷的内核管理和交互工具,支持代码贡献和文档编写,采用自动代码格式化和共享版权模型。

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.
项目侧边栏1项目侧边栏2
推荐项目
Project Cover

豆包MarsCode

豆包 MarsCode 是一款革命性的编程助手,通过AI技术提供代码补全、单测生成、代码解释和智能问答等功能,支持100+编程语言,与主流编辑器无缝集成,显著提升开发效率和代码质量。

Project Cover

AI写歌

Suno AI是一个革命性的AI音乐创作平台,能在短短30秒内帮助用户创作出一首完整的歌曲。无论是寻找创作灵感还是需要快速制作音乐,Suno AI都是音乐爱好者和专业人士的理想选择。

Project Cover

白日梦AI

白日梦AI提供专注于AI视频生成的多样化功能,包括文生视频、动态画面和形象生成等,帮助用户快速上手,创造专业级内容。

Project Cover

有言AI

有言平台提供一站式AIGC视频创作解决方案,通过智能技术简化视频制作流程。无论是企业宣传还是个人分享,有言都能帮助用户快速、轻松地制作出专业级别的视频内容。

Project Cover

Kimi

Kimi AI助手提供多语言对话支持,能够阅读和理解用户上传的文件内容,解析网页信息,并结合搜索结果为用户提供详尽的答案。无论是日常咨询还是专业问题,Kimi都能以友好、专业的方式提供帮助。

Project Cover

讯飞绘镜

讯飞绘镜是一个支持从创意到完整视频创作的智能平台,用户可以快速生成视频素材并创作独特的音乐视频和故事。平台提供多样化的主题和精选作品,帮助用户探索创意灵感。

Project Cover

讯飞文书

讯飞文书依托讯飞星火大模型,为文书写作者提供从素材筹备到稿件撰写及审稿的全程支持。通过录音智记和以稿写稿等功能,满足事务性工作的高频需求,帮助撰稿人节省精力,提高效率,优化工作与生活。

Project Cover

阿里绘蛙

绘蛙是阿里巴巴集团推出的革命性AI电商营销平台。利用尖端人工智能技术,为商家提供一键生成商品图和营销文案的服务,显著提升内容创作效率和营销效果。适用于淘宝、天猫等电商平台,让商品第一时间被种草。

Project Cover

AIWritePaper论文写作

AIWritePaper论文写作是一站式AI论文写作辅助工具,简化了选题、文献检索至论文撰写的整个过程。通过简单设定,平台可快速生成高质量论文大纲和全文,配合图表、参考文献等一应俱全,同时提供开题报告和答辩PPT等增值服务,保障数据安全,有效提升写作效率和论文质量。

投诉举报邮箱: service@vectorlightyear.com
@2024 懂AI·鲁ICP备2024100362号-6·鲁公网安备37021002001498号