Skip to main content

jinja2 template renderer

Project description

jiren

jiren is an application that generates text from a template. The format of the template is based on jinja2.

PyPI PyPI - Python Version Build Status codecov

Read this in Japanese: 日本語

Installation

pip install jiren

Usage

Generate text

Generate text from a template using the jiren command. This command can read a template from stdin or files.

An example of reading a template from stdin:

Command:

echo "hello, {{ name }}" | jiren --var.name=world

Outputs:

hello, world

An example of reading a template from a file:

Command:

cat <<EOF >template.j2
hello, {{ name }}
EOF

jiren template.j2 --var.name=world

Outputs:

hello, world

In this example, the template contains a variable called name. You can set values for variables in a template using program arguments passed to the jiren command. Note that the program arguments must be prefixed with --var..

If you want to know more about template format, please refer to jinja2 document ( http://jinja.pocoo.org/ ).

Variables in a template

You can use the help to check the variables defined in a template.

Command:

echo "{{ greeting }}, {{ name }}" | jiren --help

Outputs:

... (omitted)

variables:
  --var.name VAR.NAME
  --var.greeting VAR.GREETING

Default values

You can set default values for variables for which no values was specified. This is based on the jinja2 specification.

Command:

echo "{{ greeting }}, {{ name | default('world') }}" | jiren --var.greeting=hello

Outputs:

hello, world

Strict option

When using the --strict option, you must specify values for all variables.

Command:

echo "{{ greeting }}, {{ name }}" | jiren --strict --var.greeting=hello

Outputs:

... (omitted)

jiren: error: the following arguments are required: --var.name

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for jiren, version 0.2.2
Filename, size File type Python version Upload date Hashes
Filename, size jiren-0.2.2-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size jiren-0.2.2.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page