Skip to main content

Vars collector and template runner.

Project description

c2c.template

Supported template Jinja, Mako, Template.

Tools that collect some vars and get them to a template engine.

Supported template: Jinja and Mako.

Use c2c-template --help to get the command line help.

Vars file

The vars collector gets the vars from YAML files like this one:

extends: inherit.yaml

vars:
     string_var: a string
     int_var: 42
     interpreted_var: __import__('datetime').date.today()
     combined_var: 'Today: {interpreted_var:%Y-%m-%d}'
     facter_json: /usr/bin/facter --json
     facter_yaml: /usr/bin/facter --yaml
     pi: console.log(Math.PI.toPrecision(3))
     obj:
         v1: 1
         v2: '2'
         v3: [1, 2, 3]

 interpreted:
     python:
     - interpreted_var
     bash:
     - facter_json
     - facter_yaml
     json:
     - facter_json
     yaml:
     - facter_yaml
     node:
         vars: ["pi"]
         cmd: ["node", "-e"]

 update_path:
 - obj

The inherit.yaml is an other file with the same syntax that will provide initial vars.

The vars section is where we define the vars values, the YAML files support typing, than 42 will be an integer.

The interpreted configuration to interpret some vars, python, bash, environ, json, yaml are predefined interpreter, node is a custom interpreter.

The update_path is a list of ‘.’-separated paths that will be updated (for dicts) or appended (for lists), instead of overwritten. The sub path will be implicitly added.

We can reuse predefined variables and format them (see combined_var), See: str.format().

Example of usage

Interpret variable in a template

c2c-template --vars vars.yaml --engine jinja --files template.jinja

The result will be stored in a file named template.

Get the vars

It can be useful to get the variable outside.

`c2c-template --vars vars.yaml --get-vars INT_VAR=int_var string_var`

That will set the bash variable INT_VAR to 42, and STRING_VAR to ‘a string’.

Get a configuration file

c2c-template --vars vars.yaml --get-config config.yaml string-var int-var combined-var

Will create a file named config.yaml this:

string-var: a string
int-var: 42
combined-var: Today: 2014-12-12

Build a set of file based on a template

Create the following vars file (vars.yaml):

vars:
    var1: common
    iter:
    - name: one
      var2: first
    - name: two
      var2: second

And the following template (template.jinja):

var1: {{ var1 }}
var2: {{ var2 }}

And run the following command:

c2c-template --vars vars.yaml --files-builder template.jinja {name}.txt iter

This will create two files:

the one.txt file, with:

var1: common
var2: first

The two.txt file, with:

var1: common
var2: second

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

c2c.template-2.0.1.tar.gz (8.8 kB view details)

Uploaded Source

Built Distribution

c2c.template-2.0.1-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file c2c.template-2.0.1.tar.gz.

File metadata

File hashes

Hashes for c2c.template-2.0.1.tar.gz
Algorithm Hash digest
SHA256 b418424f3b6097ed7c1e929a7b8d7af45368630592112d276879ab6b8d1d672e
MD5 73bb63edc5b7e635a614abe5028d16a5
BLAKE2b-256 f673cd45b4e77d71acdcdef160d92b2069fb8c46e774bcb15677e7e7e6e1bb24

See more details on using hashes here.

Provenance

File details

Details for the file c2c.template-2.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for c2c.template-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c0a8eee70553c007f3a7b5040001556317ee75d1f480e9af1769cfe82dc0e353
MD5 341607de3ecdfa38e679cbbb70994def
BLAKE2b-256 f55dddfca8d93bec1a769b4f5d7b42a5d4911ca86cadec629b0c8c41f6d7a602

See more details on using hashes here.

Provenance

Supported by

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