Skip to main content

CLI renderer for Jinja2

Project description

jinplate

Code style: black linting: pylint

A command line Jinja2 renderer inspired by gomplate

jinplate can read from local and remote variable files in a number of formats and use them to render a local Jinja2 template file.

jinplate uses URIs to identify how to fetch and parse Jinja2 variable files.

Installation

pip install jinplate

To install with support for the tests and filters included with ansible, use

pip install jinplate[ansible]

Usage

jinplate --help
Usage: jinplate [OPTIONS] TEMPLATE_FILE DATASOURCES...

  A command line renderer for jinja templates

  TEMPLATE_FILE is the path to a jinja template file to render

  DATASOURCES is a list of URIs to data sources supported by jinplate which
  contain the template variables

  --jinja-ext allows specifying a comma-separated list of import paths
  containing jinja extensions. Example: --jinja-ext jinja2.ext.i18n

Options:
  --jinja-ext TEXT
  --help            Show this message and exit.

Local Vars Example

test.j2

---

key: {{ test1.key }}
arr: {{ test2.arr }}

vars.json

{
  "test1": {
    "key": "val"
  },
  "test2": {
    "arr": [1, 2, 3]
  }
}
jinplate test.j2 "file:///$(pwd)/vars.json"

---

key: val
arr: [1, 2, 3]

Remote Vars example

python -m http.server
jinplate test.j2 "http://127.0.0.1:8000/vars.json"

---

key: val
arr: [1, 2, 3]

Supported Vars File Schemes

URI Scheme Plugin Example
file jinplate.plugins.scheme.file file:////path/to/vars.yaml
http jinplate.plugins.scheme.http http://127.0.0.1:8000/vars

Supported Vars File Types

File types are determined by extension, but can also be overridden by appending +<file_type> to the datasource URI scheme, as in http+json://

File type Matching extensions Plugin Example
json .json jinplate.plugins.filetype.json http+json://127.0.0.1:8000/vars
yaml .yaml, .yml jinplate.plugins.filetype.yaml http://127.0.0.1:8000/vars.yml
file:////path/to/vars.yaml
dotenv .env jinplate.plugins.filetype.dotenv file+env:////path/to/vars

Project details


Download files

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

Source Distribution

jinplate-0.0.5.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jinplate-0.0.5-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file jinplate-0.0.5.tar.gz.

File metadata

  • Download URL: jinplate-0.0.5.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for jinplate-0.0.5.tar.gz
Algorithm Hash digest
SHA256 c939fc9d1864807c84ca2ecf3f23545d3f0c7d3816d540a0f3527fed14dd83f4
MD5 e45dbe769a4ef8358ccb00eb0e330c75
BLAKE2b-256 8eaf664df402f5dd8a567d837150058e3c11feb4bd1210c46628d09a0c8a547f

See more details on using hashes here.

File details

Details for the file jinplate-0.0.5-py3-none-any.whl.

File metadata

  • Download URL: jinplate-0.0.5-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for jinplate-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 039918da46715b756482bc9a4ec150dd74992076c86d3acdcd0e1664662a83b2
MD5 c6f68dc1d43d742c6384f521f673e720
BLAKE2b-256 5b0f365b9321a4abb213bea6a857c2651b411bf7d83b76613aa97754513909b2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page