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).
Full example about overall operation (in default mode)
Note: this is only the default behavior as you can tune this with your own plugins!
Let's imagine the following directory structure:
/foo/
/foo/README.md.template
/foo/bar/baz.py.template
/foo/bar/another.file
And execute jinja-tree /foo with the default configuration.
We get:
/foo/
/foo/README.md.template
/foo/README.md <= NEW FILE FROM README.md.template jinja2 processing
/foo/bar/baz.py.template
/foo/bar/baz.py <= NEW FILE FROM baz.py.template jinja2 processing
/foo/bar/another.file
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).
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-treefinds files to process (including target files)
See this specification documentation page for more details.
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.
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
{{ "date"|shell() }}=> will render something like: Sun Jan 28 15:11:44 CET 2024
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
jinja-tree has several options for Jinja "search paths". So you can use Jinja "includes" and "inheritance" features.
pip install jinja-tree
Tip
If you want to get a better readability of jinja-tree output (colors...), you can also use pip install rich to install
this optional dependency.
jinja-tree .
Note
The . in the previous command in the "root directory" (the directory jinja-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 PATH 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] │
│ --verbose --no-verbose increase verbosity of the DEBUG │
│ log level (note: this forces │
│ log-level = DEBUG) │
│ [default: no-verbose] │
│ --extra-search-path PATH Search path to jinja (can be used │
│ multiple times) │
│ --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 plugins (full python class │
│ path, can be used multiple times) │
│ --action-plugin TEXT action plugin (full python class │
│ path, can be used multiple times) │
│ --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-extensio… --no-disable-embedded-jinja-exten… disable embedded jinja extensions │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
cat /path/to/your/file/to/process | jinja-stdin >/path/to/your/processed/fileor (if you want to process only a string):
$ export FOO=bar
$ echo "Hello {{FOO}}" | jinja-stdin
Hello barBonus 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] │
│ --verbose --no-verbose increase verbosity of the DEBUG │
│ log level (note: this forces │
│ log-level = DEBUG) │
│ [default: no-verbose] │
│ --extra-search-path PATH Search path to jinja (can be used │
│ multiple times) │
│ --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 plugins (full python class │
│ path, can be used multiple times) │
│ --strict-undefined --no-strict-undefined if set, raise an error if a │
│ variable does not exist in context │
│ --disable-embedded-jinja-extensio… --no-disable-embedded-jinja-exten… disable embedded jinja extensions │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯