JFTL — JSONFold Template Language

JFTL is a JSON-based language for transforming and generating JSON.

JFTL templates are themselves valid JSON. They combine JSON navigation, iteration, conditional logic, variables, transformations, and expression evaluation while keeping the template structure close to the JSON being produced.

Installation

Install the Python implementation from PyPI:

pip install jsonfold-template

Command Line

The Python implementation installs the jftl-pyrun command:

jftl-pyrun template.json

Use:

jftl-pyrun --help

for the complete set of command-line options.

Python API

The public Python API is available through jsonfold.template:

from jsonfold.template import create_engine

engine = create_engine()

Example

A simple JFTL transformation:

{
  "$": true,
  "data": "$_datasets.input",
  "out": {
    "name": "$.name",
    "price": "$py=_['price'] * 2"
  }
}

JFTL supports navigation, iteration, filtering, conditional output, datasets, variables, transformations, multiple expression engines, and other JSON transformation operations.

Documentation

Full language documentation, reference material, and cookbook examples are available on the JFTL documentation site.

Implementations

JFTL is a language rather than a single implementation.

This package contains the Python implementation. Other implementations may provide different execution engines, integrations, performance characteristics, or additional capabilities while implementing the JFTL language.

License

The Python implementation of JFTL is released under the MIT License.

See LICENSE for details.