mxskylar / jiml

Jiml is a Python script that renders Jinja templates with data from YAML files.

Jiml is a Python script that renders Jinja templates with data from YAML files.

This allows users to maintain one YAML file of data that can be published into many other formats. For example, a CV can be maintained in a single YAML file but published as HTML and LaTeX.

Usage

Long Arg	Short Arg	Description
yaml	y	YAML config file.
template	t	Jinja2 template.
output	o	Output file to render.

On Unix-like systems with Python 3 installed in /user/bin/python3:

./render.py -y demo.yaml -t tech-resume.tex -o demo-resume.tex

If you want to generate a PDF from a LaTeX file:

xelatex demo-resume.tex

Supported Output

By default, YAML data is escaped depending on the output format. Jiml supports for the following formats for escaping:

• LaTeX
• HTML
• XML

You can render plaintext file formats not in the list above, but special characters will not be escaped.

Development

Python dependencies are in requirements.txt. Install them with pip or pip3:

pip3 install -r requirements.txt

Git hooks live in .githooks. For git clients older than version 2.9, set this as your hooksPath:

git config core.hooksPath ".githooks"

jiml's Issues

Override escaping

YAML keys prefixed with _ should not be escaped. That way, users can add render unescaped data when necessary. For example:

- _file: unescaped/path/to/file

Publish script as a binary

Publish script as a binary in popular package manager repositories:

• apt (Debian)
• app image (other Linux)
• brew (OSX)
• chocolatey (Windows)

Nice-to-haves

• Bundle version-controlled templates with binary on install
• Open source software license

Fix LaTeX escaping

A couple of LaTeX characters (e.g. \{) aren't escaped properly in rare cases, as caught by the newly added unit tests: https://github.com/rynbp/latex-templates/blob/latex_escape_bug/test.yaml#L22

Finish HTML resume template

Add all data to HTML resume template and style it with Bootstrap CSS.

Add CI

Run Python tests for pushes with GitHub actions.