nbquarto 0.0.1

关键词

• Cell：Jupyter Notebook中的执行模块或Markdown容器。
• Directive：由管道分隔（|）的注释块，由Quarto和nbquarto识别。
• Processor：一个基于其指令调整单元格的类。

介绍nbquarto：您的Python-Powered Notebook增强器

使用nbquarto利用Python的力量，这是一个外部转换Jupyter Notebook单元格的动态界面，旨在为Quarto项目设计。此框架通过启用Jupyter Notebooks的快速创建和实现后处理器来简化您的文档流程。虽然以Quarto为中心，但nbquarto对于任何利用Jupyter Notebooks的Python项目来说都是一项宝贵的资产。

入门

查看此处的安装说明以开始！

选择nbquarto以获得更佳体验

从nbdev汲取灵感，nbquarto致力于一个更易于理解且不那么抽象的界面。它专注于修改Jupyter Notebooks，以便充分利用Quarto的丰富功能，最小化依赖项，并提高代码可读性。

无需学习曲线的nbquarto

为什么要在Python内容中学习新的语言（Lua）进行修改？nbquarto是Quarto扩展的Pythonic替代品。以可忽略的增加处理时间为代价，提供灵活性和简单性，nbquarto使您能够掌控叙事。

nbquarto是如何工作的？

nbquarto的核心是一个Processor。该组件用于修改单元格以微调代码格式或快速创建复杂的Quarto语法组合。每个cell对象包含两个关键元素：directives_（单元格指令列表）和source（可修改的单元格文本）。

看看如何在单元格文本源顶部添加注释是多么简单

>>> from nbquarto import Processor

>>> class BasicProcessor(Processor):
...    "A basic processor that adds a comment to the top of a cell's text source."
...
...    directives = "process"
...
...    def process(self, cell):
...        if any(directive in cell.directives_ for directive in self.directives):
...            cell.source = f"# This code has been processed!\n{cell.source}"

在笔记本单元格中

# Input
>>> #| process
... print("Hello, world!")

# Output
>>> # This code has been processed!
... print("Hello, world!")

简化配置

告别对nbquarto配置文件的困惑。这个实用功能组织处理器使用、笔记本路径和处理器常量，以提供无缝的用户体验。

documentation_source: tests
processors: [
    nbquarto.processors.example:BasicProcessor,
    nbquarto.processors.autodoc:AutoDocProcessor
]

processor_args:
  AutoDocProcessor: 
      repo_owner: muellerzr
      repo_name: nbquarto

高效的笔记本处理

执行nbquarto-process命令，让配置的Processor（s）在您的笔记本上施展魔法。所有处理过的笔记本都以qmd文件的形式保存在您指定的输出文件夹中

nbquarto-process \
--config_file tests/test_artifacts/single_processor.yaml \
--notebook_file tests/test_artifacts/test_example.ipynb \
--output_folder docs/

重新发明nbdev：体验nbquarto

使用nbquarto重新理解nbdev，它是原始项目的用户友好重制。享受明确界面的简洁性，享受最小化的抽象，享受清晰的错误消息，并欣赏对优秀的Python编码实践的遵循。