https://github.com/lecrisut/fmf-jinja
Jinja template engine using FMF metadata
https://github.com/lecrisut/fmf-jinja
Last synced: 5 months ago
JSON representation
Jinja template engine using FMF metadata
- Host: GitHub
- URL: https://github.com/lecrisut/fmf-jinja
- Owner: LecrisUT
- License: gpl-3.0
- Created: 2023-08-10T13:18:09.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-21T18:59:33.000Z (over 1 year ago)
- Last Synced: 2025-09-23T12:51:14.694Z (10 months ago)
- Language: Python
- Size: 125 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# FMF-Jinja
[![CI Status][ci-badge]][ci-link]
[![Codecov Status][codecov-badge]][codecov-link]
[![Documentation Status][rtd-badge]][rtd-link]
[Jinja templating engine][jinja] using [fmf metadata][fmf].
## Concept
The scope of this project is to take a templated folder and generate *multiple* output
folders with relation to one another. Consider the following fmf file example in
[`example/minimal`]:
```yaml
var1: 42
var2: Default value
/rootA:
/rootB:
var2: Overwritten
```
This is interpreted by fmf as:
```console
$ fmf show --path example/minimal
/rootA
var1: 42
var2: Default value
/rootB
var1: 42
var2: Overwritten
```
These variables (`var1`, `var2`) are then used as variables inside a jinja template
creating templated folders under `rootA` and `rootB` with their respective values. Try
it out by running
```console
$ fmf-jinja -r example/minimal generate -o /path/to/some/output/folder
```
To appreciate the full capabilities see the [fmf features] and [jinja template guide].
Also check the [online documentation] for more examples and detailed usage guide.
[ci-badge]: https://github.com/LecrisUT/fmf-jinja/actions/workflows/ci.yaml/badge.svg?branch=main&event=push
[ci-link]: https://github.com/LecrisUT/fmf-jinja/actions?query=branch%3Amain+event%3Apush
[codecov-badge]: https://codecov.io/gh/LecrisUT/fmf-jinja/graph/badge.svg?token=WCTLWU6M2O
[codecov-link]: https://codecov.io/gh/LecrisUT/fmf-jinja
[fmf]: https://fmf.readthedocs.io
[fmf features]: https://fmf.readthedocs.io/en/stable/features.html
[jinja]: https://jinja.palletsprojects.com
[jinja template guide]: https://jinja.palletsprojects.com/en/stable/templates/
[online documentation]: https://fmf-jinja.readthedocs.io/
[rtd-badge]: https://readthedocs.org/projects/fmf-jinja/badge/?version=latest
[rtd-link]: https://fmf-jinja.readthedocs.io/en/latest/?badge=latest
[`example/minimal`]: example/minimal