jq 0.1.0

jq is a lightweight and flexible command-line JSON processor.

This project contains Python bindings for jq. Installation requires Git and any programs required to build jq, such as gcc.

During installation, jq 1.4 is cloned from GitHub and built.

Usage

A program can be compiled by passing it to jq.jq. To apply the program to an input, called the transform method. jq.py expects the value to be valid JSON, such as values returned from json.load.

from jq import jq

jq(".").transform("42") == "42"
jq(".").transform({"a": 1}) == {"a": 1}

If the value is unparsed JSON text, pass it in using the text argument:

jq(".").transform(text="42") == 42

The text_output argument can be used to serialise the output into JSON text:

jq(".").transform("42", text_output=True) == '"42"'

If there are multiple output elements, each element is represented by a separate line, irrespective of the value of multiple_output:

jq(".[]").transform("[1, 2, 3]", text_output=True) == "1\n2\n3"

If multiple_output is False (the default), then the first output is used:

jq(".[]+1").transform([1, 2, 3]) == 2

If multiple_output is True, all output elements are returned in an array:

jq(".[]+1").transform([1, 2, 3], multiple_output=True) == [2, 3, 4]