Installation

pip install template[all]

This will install Template along with the dependencies for all of the filters available with it. However, you can use narrower specifiers if you want to avoid a specific dependency (the filters listed below include the needed specifier). In previous releases of Template all of the dependencies were required. To not break existing templates, for the foreseeable future those dependencies will remain a requirement and new dependencies for specific filters will be optional. This will change in the 0.9 release where all filter specific dependencies will be optional. Please update your project before that happens.

Examples

$ template -h
usage: template [-h] [-o OUTPUT] [filename]

A CLI tool for generating files from Jinja2 templates and environment
variables.

positional arguments:
  filename              Input filename

  optional arguments:
    -h, --help            show this help message and exit
    -o OUTPUT, --output OUTPUT
                          Output to filename
$ export name='John'
$ echo 'Hello {{ name if name is defined else 'world' }}. | template
Hello John.
$ echo '{{ USER }}' > username.j2
$ template --output username.txt username.j2
$ cat username.txt
John

Jinja filters

The following Jinja filters were added:

• combine: Merges 2 dictionaries with the 2nd overriding the 1st. Returns the result.

• to_yaml: Convert to yaml (requires the yaml package specifier).

• from_yaml: Convert from yaml (requires the yaml package specifier).

• to_json: Convert to json.

• from_json: Convert from json.

• to_toml: Convert to toml (requires the toml package specifier).

• from_toml: Convert from toml (requires the toml package specifier).

• jmespath: Queries data using the JMESPath query language (requires the jmespath package specifier).

• run: Runs a command and returns the stdout, stderr and returncode using run. This filter is replaced with the run function and will be removed in the 0.10 release.

• ipaddress: Returns an IPAddress object from the netaddr library (requires the netaddr package specifier).

• ipnetwork: Returns an IPNetwork object from the netaddr library (requires the netaddr package specifier).

• iprange: Returns an IPRange object from the netaddr library. (requires the netaddr package specifier).

• ipglob: Returns an IPGlob object from the netaddr library (requires the netaddr package specifier).

• ipset: Returns an IPSet object from the netaddr library (requires the netaddr package specifier).

Example usage can be seen in tests and for specific filters in the docstrings in template/filters.py.

Jinja functions

• run: Runs a command and returns the stdout, stderr and returncode using run. This function replaces the run filter.

• readfile: Returns the contents of a file.

Example usage can be seen in tests and for specific filters in the docstrings in template/functions.py.

Testing

Tests require Pipenv and Bats. Run the tests with the following commands:

pipenv run lint  # Pre-commit hooks.
pipenv run doctest  # Doc tests.
pipenv run bats  # Bats tests.
pipenv run check  # Twine check.

Also, GitLab CI is setup for this project so every push to this repository is checked with all Python 2.7, Python 3.6 and later and all supported versions of PyPy.

Release

Release requires Pipenv and Python 3.6 or later. To bump the version run pipenv run bumpversion major|minor|patch to update the version and git commit and tag the changes, then run git push --follow-tags to push the git commit and tag. The GitLab CI will then build and upload a release to PyPI. To manually upload to PyPI run pipenv run build to build the Python package and pipenv run upload -s dist/* to upload a signed version.

License

This software is licensed under the AGPL 3+ license (see the LICENSE.txt file).

Author

Nimrod Adar, contact me or visit my website. Patches are welcome via git send-email. The repository is located at: https://git.shore.co.il/nimrod/.