jupyter协议实现和客户端库
jupyter-client的Python项目详细描述
Jupyter客户端
jupyter_client
包含Jupyter protocol的引用实现。
它还提供了用于处理内核的客户端和内核管理api。
它还提供jupyter kernelspec
入口点
用于安装与Jupyter前端一起使用的kernelspec
开发设置
Jupyter Contributor Guides提供了大量关于为jupyter项目贡献代码或文档的信息。下面关于设置开发环境的有限说明是为了您的方便
编码
在搜索路径上需要python和pip
。将jupyter客户机git存储库克隆到您的计算机上,例如/my/project/jupyter_client
。
现在创建一个editable install
并通过执行以下命令下载代码和测试套件的依赖项:
cd /my/projects/jupyter_client/
pip install -e .[test]
py.test
最后一个命令运行测试套件来验证设置。在开发过程中,您可以将文件名传递给py.test
,它将只执行这些测试
文件
jupyter客户端的文档是使用sphinx从docs/
中的文件生成的。有关使用可选模块选项设置Sphinx的说明,请参见Documentation Guide您还需要make
命令。
对于处理jupyter客户端文档的最小sphinx安装,请执行:
pip install ipykernel sphinx sphinx_rtd_theme
以下命令以HTML格式生成文档并检查是否存在断开的链接:
cd /my/projects/jupyter_client/docs/
make html linkcheck
将浏览器指向以下URL以访问生成的文档:
文件:///my/projects/jupyter_client/docs/_build/html/index.html