kntr 0.4.1

Stitch

A knitr- RMarkdown-like library, in Python.

注意： 您可能想考虑使用Jan Schulz的knitpy。在这个阶段，它可能更加成熟。然而，我想看看是否有更简单的方法来做这件事。

这类库（knitr/RMarkdown，knitpy和stitch）的高层次目标是使编写可重复的报告变得更容易。

文档可在此处找到。

示例

请参阅项目的示例页面，以查看输入Markdown和拼接HTML的并排比较。

还有更多复杂示例的链接。

安装

stitch支持Python 3.5及以上。目前，您可以通过pip安装stitch：

pip install knotr

我知道，这很令人困惑。我已经在PyPI上提交了stitch的申请，但我认为支持队列的工作人员工作量过大。一旦处理完毕，我将在conda-forge上发布。如果您需要一个助记符，那就是“我想用knitr，但不是用R写的那个。”我还想迷惑R用户。而结（knots）有点像knits的一个有缺陷的版本。

stitch需要pandoc>=1.18。您可以使用系统包管理器安装它，或者pypandoc。

设计

目标是通过复用现有库使自身极为简单。我们任务的概要如下：

1. 命令行界面

2. 解析Markdown文件

3. 执行代码块，捕获输出

4. 将执行输出汇总到文档中

5. 渲染最终输出

幸运的是，所有构建模块都已具备。

我们复用了

• pandoc 通过 pypandoc 解析Markdown并渲染最终输出

• jupyter 用于语言内核、执行代码和收集输出

• 使用 pandocfilters 将执行输出汇总到文档中

因此，stitch 所需做的只是提供命令行界面，扫描文档中的代码块，管理一些内核，将代码交给内核，并将输出传递给适当的 pandocfilter。

与 knitpy 最大的区别是使用了 pandoc 的 JSON AST。这是您从 pandoc -t json input.md 获得的。

这使我们免于进行任何Markdown的定制解析。到目前为止的唯一缺点是，如果 stitch 产生了不良的文档，将出现难以理解的 Haskell 异常。

文档

Stitch 的文档构建过程有些奇特，因此标准工具如 readthedocs 的灵活性不足。要生成文档，请安装 stitch 和所有额外依赖项。克隆 https://github.com/pystitch/pystitch.github.io

检出 src 分支。

运行 make html。