summaryrefslogtreecommitdiff
path: root/README.md
blob: 5802171c225da35cad5c426fc5390c84ddd218d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# jq.py: a lightweight and flexible JSON processor

Warning: the API is not stable.

This project contains Python bindings for [jq](http://stedolan.github.io/jq/).

## Examples

```python
from jq import jq

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

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

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

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

```python
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`:

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

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

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

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

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