kodudo 0.2.0

Cook your data into documents using Jinja2 templates

Kodudo

Kodudo is a Bororo word for "to cook".

It is a minimal, functional Python tool that cooks your data into documents using Jinja2 templates. Designed to work seamlessly with aptoro, it separates data preparation from presentation, allowing you to transform validated data into HTML, Markdown, or any other text format.

Features

• Data Agnostic: Works natively with Aptoro exports, plain JSON lists, or generic wrappers.
• Jinja2 Powered: Leverage the full power of Jinja2 templates, inheritance, and macros.
• Configuration over Code: Define complex rendering pipelines in simple YAML files.
• Context Aware: Automatically injects metadata, configuration, and custom context into templates.
• Multi-Output: Render multiple output files from a single config with outputs.
• Per-Record Rendering: Generate one file per data record with foreach and path interpolation.
• Multi-Format: Output to HTML, Markdown, text, or any text-based format.

Installation

pip install kodudo

CLI Usage

Kodudo provides a command-line interface for "cooking" documents from configuration files.

# Cook a single configuration file
kodudo cook config.yaml

# Cook multiple files at once
kodudo cook config1.yaml config2.yaml

# Use shell expansion
kodudo cook configs/*.yaml

Quick Start

import kodudo

# Cook using a config file (same as CLI)
paths = kodudo.cook("config.yaml")

# Cook with runtime overrides (no temp files needed)
batch = kodudo.load_config("config.yaml")
for locale in ("pt", "en"):
    kodudo.cook_from_config(
        batch.config,
        context={"lang": locale},
        output=f"docs/{locale}/page.html",
    )

# Render directly to a string
html = kodudo.render(
    data=[{"name": "Alice"}, {"name": "Bob"}],
    template="templates/users.html.j2",
    context={"title": "User List"},
)

Documentation

For full details on configuration options, template variables, and data formats, see the Documentation.

Configuration

Define your rendering process in a YAML configuration file:

# Single output
input: data/records.json
template: templates/page.html.j2
output: output/page.html
context:
  title: "My Documents"

# Multi-output (e.g., locales)
input: data/records.json
template: templates/page.html.j2
outputs:
  - output: en/page.html
    context: { lang: en }
  - output: pt/page.html
    context: { lang: pt }

# Per-record rendering
input: data/articles.json
template: templates/article.html.j2
output: articles/{article.slug}.html
foreach: article

Supported Formats

Input Data (JSON):

• Aptoro Format: { "meta": {...}, "data": [...] }
• Plain List: [ {...}, {...} ]
• Generic Wrapper: { "results": [...] }

Output:

• HTML
• Markdown
• Text
• Any text-based format

License

GNU General Public License v3 (GPLv3)