跳转到主要内容

用于处理jupyter笔记本缓存的定义接口。

项目描述

jupyter-cache

Github-CI Coverage Status Documentation Status Code style: black PyPI

用于处理jupyter笔记本缓存的定义接口。

为什么使用jupyter-cache?

如果您有一系列需要确保其执行输出保持最新,而不必每次都重新执行它们的笔记本(特别是对于长时间运行的代码或基于文本的格式,这些格式不存储输出),请使用jupyter-cache。

笔记本必须具有确定的执行输出

  • 您使用相同的运行环境来运行它们(例如,相同的已安装包)
  • 它们不运行非确定性的代码(例如,随机数)
  • 它们不依赖于随时间变化的外部资源(例如,文件或网络连接)

例如,它被jupyter-book使用,以允许快速重建文档。

安装

pip install jupyter-cache

用于开发

git clone https://github.com/executablebooks/jupyter-cache
cd jupyter-cache
git checkout develop
pip install -e .[cli,code_style,testing]

请参阅文档以了解用法。

开发

一些期望的需求(尚未全部实现)

  • 持久性
  • 将“内容编辑”与“代码单元格编辑”分开。单元格重新排列和代码单元格更改应需要重新执行。内容更改不应如此。
  • 允许并行访问笔记本(用于执行)
  • 存储执行统计/报告
  • 存储外部资产:正在执行的笔记本通常需要外部资产:导入脚本/数据等。这些由用户准备。
  • 存储执行工件:在执行过程中创建
  • 透明且稳健的缓存失效:想象一下用户更新外部依赖或Python模块,或检出不同的git分支。

贡献

jupyter-cache遵循可执行书籍贡献指南。我们非常欢迎您的帮助!

代码风格

使用flake8测试代码风格,配置在.flake8中,代码使用black格式化。

使用jupyter-cache[code_style]安装将使pre-commit包可用,该包将在提交前确保满足此风格,通过重新格式化代码并测试lint错误。可以通过以下方式设置

>> cd jupyter-cache
>> pre-commit install

可选地,您可以分别运行blackflake8

>> black .
>> flake8 .

VS Code等编辑器也有自动代码重格式化工具,可以遵守此标准。

项目详情


下载文件

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

源分布

jupyter_cache-1.0.0.tar.gz(32.0 kB 查看哈希值

上传时间

构建分布

jupyter_cache-1.0.0-py3-none-any.whl(33.9 kB 查看哈希值

上传时间 Python 3

由以下赞助

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面