kodudo 0.1.1

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-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)
kodudo.cook("config.yaml")

# Or programmatically
data = [
    {"name": "Alice", "role": "Admin"},
    {"name": "Bob", "role": "User"}
]

# Render directly to a string
html = kodudo.render(
    data=data,
    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:

# config.yaml
input: data/records.json       # Path to data (JSON with aptoro metadata or plain list)
template: templates/page.html.j2 # Path to Jinja2 template
output: output/page.html       # Where to write the result

# Optional settings
format: html                   # html, markdown, or text (inferred if missing)
context_file: context.yaml     # Load extra variables from a file
context:                       # Inline extra variables
  title: "My Documents"
  author: "Tiago"

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)