CLI to process jinja (jinja2) templates in a directory tree
Project description
jinja-tree
What is it?
jinja-tree
is a CLI utility to process jinja (jinja2) templates
recursively in a directory tree.
It is very configurable and very easy to extend with its included plugin system.
The default behavior is to recursively search for files with a given extension (.template
for example) and to process the context with Jinja (Jinja2) templates engine reading the context variables from:
- a configuration file
- environment variables
- dotenv files
Then, the processed content is written into another file with the same name/path but with the configured extension (.template
by default) removed. The original file can also be deleted (but this is not the default behavior).
[!TIP] If you want a full example about overall operation, you can find an example here.
What's it for?
Your imagination is your limit 😅 but it's very useful for maintaining DRY documentation (for example: your-cli --help
output automatically updated in a markdown file), configuration files with default values read in code, including common blocks in different files...
So it's a great tool for maintaining repositories in general.
[!TIP] Do you cant real-life examples? You can find some details about how we use it in this repository for:
[!NOTE] Another "action" plugin will be soon 🕒 provided to bootstrap directory trees from templates (like with the cookiecutter project).
Features
1️⃣ Easy to extend
jinja-tree
includes a plugin system. You can override the default behavior with your own plugins.
There are two extension points:
- context plugins: to provide context variables to Jinja templates
- file plugins: to change the way how
jinja-tree
finds files to process (including target files)
See this specification documentation page for more details.
2️⃣ Very configurable
jinja-tree
is very configurable. You can configure global options via CLI options or a configuration file.
Plugins are configurable via the configuration file.
See this specification documentation page for more details.
3️⃣ Embedded extensions
jinja-tree
includes some extensions to Jinja templates engine:
- to execute some commands (and get the corresponding output)
- to parse JSON strings into Python objects)
- ..
Usage examples
shell
extension
{{ "date"|shell() }}
=> will render something like: Sun Jan 28 15:11:44 CET 2024
from_json
extension
export MYENV='["foo", "bar", "baz"]'
(
cat <<EOF
{% for item in MYENV|from_json() -%}
- {{ item }}
{% endfor %}
EOF
) | jinja-stdin
=> will render something like:
- foo
- bar
- bar
See this directory for others
4️⃣ Full Jinja / Jinja2 support (including "includes" and "inheritance")
jinja-tree
has several options about Jinja "search paths". So you can use Jinja "includes" and "inheritance" features.
Installation
pip install jinja-tree
[!NOTE] A docker image will also be available soon 🕒
Usage
Main CLI
jinja-tree .
[!NOTE] The
.
in the previous command in the "root directory" (the directoryjinja-tree
will explore recursively to find files to process). You can replace it with any directory you want. By using.
, you will process all files in the current directory and its subdirectories.
Main CLI options
Usage: jinja-tree [OPTIONS] ROOT_DIR
Process a directory tree with the Jinja / Jinja2 templating system.
Arguments:
ROOT_DIR root directory [required]
Options:
--config-file TEXT config file path (default: first '.jinja-
tree.toml' file found up from current
working dir), can also be see with
JINJA_TREE_CONFIG_FILE env var [env var:
JINJA_TREE_CONFIG_FILE]
--log-level TEXT log level (DEBUG, INFO, WARNING or ERROR)
[default: INFO]
--extra-search-path PATH Search path to jinja
--add-cwd-to-search-path / --no-add-cwd-to-search-path
add current working directory (CWD) to jinja
search path
--add-root-dir-to-search-path / --no-add-root-dir-to-search-path
add root directory to jinja search path
--jinja-extension TEXT jinja extension to load
--context-plugin TEXT context plugin (full python class path)
--action-plugin TEXT action plugin (full python class path)
--strict-undefined / --no-strict-undefined
if set, raise an error if a variable does
not exist in context
--blank-run / --no-blank-run if set, execute a blank run (without
modifying or deleting anything) [default:
no-blank-run]
--disable-embedded-jinja-extensions / --no-disable-embedded-jinja-extensions
disable embedded jinja extensions
--help Show this message and exit.
Bonus CLI (if you want to process only one file but with the same behavior)
cat /path/to/your/file/to/process | jinja-stdin >/path/to/your/processed/file
or (if you want to process only a string):
$ export FOO=bar
$ echo "Hello {{FOO}}" | jinja-stdin
Hello bar
Bonus CLI options
Usage: jinja-stdin [OPTIONS]
Process the standard input with Jinja templating system and return the
result on the standard output.
Options:
--config-file TEXT config file path (default: first '.jinja-
tree.toml' file found up from current
working dir), can also be see with
JINJA_TREE_CONFIG_FILE env var [env var:
JINJA_TREE_CONFIG_FILE]
--log-level TEXT log level (DEBUG, INFO, WARNING or ERROR)
[default: INFO]
--extra-search-path PATH Search path to jinja
--add-cwd-to-search-path / --no-add-cwd-to-search-path
add current working directory (CWD) to jinja
search path
--jinja-extension TEXT jinja extension to load
--context-plugin TEXT context plugin (full python class path)
--strict-undefined / --no-strict-undefined
if set, raise an error if a variable does
not exist in context
--disable-embedded-jinja-extensions / --no-disable-embedded-jinja-extensions
disable embedded jinja extensions
--help Show this message and exit.
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
Built Distribution
Hashes for jinja_tree-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28f49cab566f8b756b369e3d820a4cf186893b9a01b20b6f1ea65e0558c4d52e |
|
MD5 | da2955c2e1765a1249f9fc87cc0c8be8 |
|
BLAKE2b-256 | 7ef26bd1263276947742496ea823267d80ca60880e12b06726e8ccc6483e90b7 |