用于版本控制的干净jupyter笔记本
nb-clean的Python项目详细描述
NB清洁
nb-clean
清除jupyter笔记本上的单元执行计数、元数据和
输出,准备提交到版本控制。它提供了一个git
筛选以在笔记本暂存之前自动清理它们,还可以
用作git之外的独立工具或与其他版本控制系统一起使用。它
可确定笔记本是否干净,可作为值机柜台
你的持续集成管道。
安装
pip install nb-clean
或者,在python项目中,使用Poetry或Pipenv作为依赖项
管理,添加nb-clean
作为开发依赖项
poetry add --dev nb-clean
或pipenv install --dev nb-clean
。nb-clean
需要Python3.6或更高版本。
用法
清洁
在现有Git存储库中安装过滤器以自动清除 笔记本在暂存之前,请从工作树中运行以下命令:
nb-clean configure-git
nb-clean
将在运行它的git存储库中配置一个过滤器,并且
不会改变您的全局或系统git配置。要卸下过滤器,
运行:
nb-clean unconfigure-git
除了使用git存储库中的过滤器之外,还可以清除 Jupyter笔记本电脑,手动:
nb-clean clean -i original.ipynb -o cleaned.ipynb
或者通过在stdin上传递笔记本内容:
nb-clean clean < original.ipynb > cleaned.ipynb
检查
您可以使用以下工具检查笔记本是否干净:
nb-clean check -i notebook.ipynb
或者通过在stdin上传递笔记本内容:
nb-clean check < notebook.ipynb
^ {CD1>}将在状态机0退出,如果笔记本是干净的,则状态
如果不是,则代码1。nb-clean
还将打印单元格执行的详细信息
计数、元数据和它找到的输出。
版权所有
版权所有©2017-2019 Scott Stevenson。
nb-clean
按ISC licence的条件分布。