跳转到主要内容

将IPython笔记本转换为YAML格式及其相反操作

项目描述

Build Status codecov

这个简单的项目允许用户将IPython笔记本转换为易于编辑的YAML文件。它与notedownipymd包非常相似,但支持所有IPython输出。

使用此包的优势在于,您可以获得与IPython笔记本的完全兼容性,并且能够使用任何文本编辑器编辑文件。

格式是YAML,因此它不如Markdown那样美观,但这是一个合理的折衷方案。

带有对应YAML文件(包括输出和不含输出)的示例IPython笔记本位于examples目录中。

安装

按照以下步骤安装此包

$ pip install ipyaml

使用方法

运行ipyaml命令以在两种格式之间转换

$ ipyaml notebook.ipynb notebook.ipyml  # or notebook.ipyaml

$ ipyaml notebook.ipyml notebook.ipynb

如果您不想在YAML文件中存储单元格输出,也可以按照以下方式运行ipyaml脚本

$ ipyaml --no-output notebook.ipynb notebook.ipyml

该功能不会写入任何输出。默认情况下,所有输出也会写入到输出文件。查看没有输出的输出,可以看出如果不需要输出,手动删除输出非常容易。使用 --no-output 不会删除文件末尾的 IPython kernelspec 和 nbformat 元数据,但如果不想保留这些信息,也可以安全地删除。

如果您希望 Jupyter 自动加载和保存 .ipyml 文件,请将以下内容添加到您的 jupyter_notebook_config.py 文件中。

c.NotebookApp.contents_manager_class = 'ipyaml.api.YAMLContentsManager'

可以通过以下命令找到 jupyter_notebook_config.py 文件:

$ jupyter --config-dir

如果您看不到 jupyter_notebook_config.py 文件,可以进行如下操作:

$ jupyter notebook --generate-config

项目详情


下载文件

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

源代码分发

ipyaml-0.3.tar.gz (15.7 kB 查看散列值)

上传时间 源代码

构建分发

ipyaml-0.3-py3-none-any.whl (10.5 kB 查看散列值)

上传时间 Python 3

支持者

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