Data Stewardship Wizard: Templating

Rendering of Data Stewardship Wizard document templates

The engine behind the document worker: it renders a document from a document template on disk and a document context, with no database, storage or queue behind it.

Installation

pip install dsw-templating
pip install 'dsw-templating[all]'  # every optional step dependency

A step whose extra is missing raises MissingExtraError ("install dsw-templating[pdf]") when it is used. The pandoc step needs the pandoc executable.

Usage

import json
import pathlib

from dsw.templating import RenderContext, RenderSettings, Template

template = Template.from_directory(pathlib.Path('my-template'), settings=RenderSettings())
context = json.loads(pathlib.Path('context.json').read_text())
document = template.render('d3e98eb6-344d-481f-8e37-6a67b6cd1ad2', context,
                           render_ctx=RenderContext.null(language='en'))
document.store('document')  # document.<extension>

Everything the rendering depends on is passed in explicitly:

Plugins implement the hooks of dsw.templating.plugins.specs (marked with dsw.templating.hookimpl); steps they provide are registered with register_plugin_steps(pm).

dsw.templating.pot extracts translatable messages of Jinja files into a POT file, and enrich_context_config(context, ContextDefaults()) adds to ctx.config what the document worker adds (service information and fallbacks for missing branding).

Documentation for template developers

• Document Context
• Jinja Filters
• Jinja Tests
• Translations
• Steps: archive, enrich-docx, excel, jinja, json, pandoc, rdflib-convert, weasyprint

License

This project is licensed under the Apache License v2.0 - see the LICENSE file for more details.