维护jupyter笔记本的工具
nbpages的Python项目详细描述
nbpages
nbpages是一个命令行工具,用于管理发布在 Github Pages。这个项目的灵感来自于 Python Data Science Handbook由 Jake Vanderplas。
安装
pip install nbpages
将以前安装的版本升级到最新版本
pip install nbpages --upgrade
设置笔记本存储库
在github页面上发布笔记本集合的第一步是
create a repository on Github.com。
github页面在存储库的“设置”选项卡下启用。向下滚动到github页面标题并选择
master branch
对于源。这也是为已发布的集合选择主题的好时机。
nbpages
需要可通过克隆远程存储库创建的存储库的本地副本。
然后从命令行导航到本地存储库的顶级目录并发出命令
nbpages --setup
目录名为^ {< CD3>}和^ {CD4>},如果它们不存在,则将创建它们。配置文件
config
将使用从.git
读取的数据在目录内创建。Jinja模板README.md.jinja
和
{“CD8}}”如果它们还不存在,则会创建。这些模板可以根据需要进行编辑
使用config
中定义的数据字段。
笔记本电脑组织
笔记本电脑在notebooks
目录中维护。他们被组织成一个章/节的继承人。
使用文件名前缀。文件名有一个nn.mm-
前缀,其中nn
表示章节号,如果是字母,则表示
阑尾数字mm
表示节编号。节00
保留用于保存章节标题和
任何介绍性材料。笔记本还必须具有通常的.ipynb
后缀。
正常使用
在设置之后,nbpages
的正常用法是执行命令行
nbpages
从笔记本存储库的顶层目录。通常,此命令介于完成编辑或 在github提交之前添加到笔记本。该命令将
- 在所有笔记本中添加或修改标题和导航栏,
- 编写目录文件
- 编写关键字索引
- 使用模板文件编写readme.md
实用程序
要帮助实现笔记本集合的一致样式,请使用命令
nbpages --lint
查找某些形式的笔记本“lint”。可以找到其他功能的当前列表
nbpages --help