Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rayokota/jsonata-python
JSONata for Python
https://github.com/rayokota/jsonata-python
json jsonata python3
Last synced: 5 days ago
JSON representation
JSONata for Python
- Host: GitHub
- URL: https://github.com/rayokota/jsonata-python
- Owner: rayokota
- License: apache-2.0
- Created: 2024-05-19T17:23:46.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-09-28T07:01:03.000Z (about 1 month ago)
- Last Synced: 2024-10-23T02:51:54.807Z (14 days ago)
- Topics: json, jsonata, python3
- Language: Python
- Homepage:
- Size: 289 KB
- Stars: 17
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# jsonata-python
[![Build Status][github-actions-shield]][github-actions-link]
[](https://www.pypi.org/project/jsonata-python)
[github-actions-shield]: https://github.com/rayokota/jsonata-python/actions/workflows/test.yml/badge.svg?branch=master
[github-actions-link]: https://github.com/rayokota/jsonata-python/actions
Pure Python implementation of JSONata.
This is a Python port of the [JSONata reference implementation](https://github.com/jsonata-js/jsonata),
and also borrows from the [Dashjoin Java port](https://github.com/dashjoin/jsonata-java).
This implementation supports 100% of the language features of JSONata, with no external dependencies.
The JSONata documentation can be found [here](https://jsonata.org).
## Installation
```
pip install jsonata-python
```
## Getting Started
A very simple start:
```
>>> import jsonata
>>> data = {"example": [{"value": 4}, {"value": 7}, {"value": 13}]}
>>> expr = jsonata.Jsonata("$sum(example.value)")
>>> result = expr.evaluate(data)
>>> result
24
```
## Command Line Interface
The CLI provides the same functionality as the [Dashjoin JSONata CLI](https://github.com/dashjoin/jsonata-cli).
```
% python3 -m jsonata.cli
usage: jsonata.cli [-h] [-v] [-e ] [-i ] [-ic ] [-f {auto,json,string}] [-o ] [-oc ] [-time] [-c] [-b ]
[-bf ] [-it]
[expr]
Pure Python JSONata CLI
positional arguments:
expr
options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-e , --expression
JSON expression to evaluate.
-i , --input
JSON input file (- for stdin)
-ic , --icharset
Input character set (default=utf-8)
-f {auto,json,string}, --format {auto,json,string}
Input format (default=auto)
-o , --output
JSON output file (- for stdin)
-oc , --ocharset
Output character set (default=utf-8)
-time Print performance timers to stderr
-c, --compact Compact JSON output (don't prettify)
-b , --bindings
JSONata variable bindings
-bf , --bindings-file
JSONata variable bindings file
-it, --interactive Interactive REPL
```
### Examples
```
% echo '{"a":"hello", "b":" world"}' | python3 -m jsonata.cli '(a & b)'
hello world
% echo '{"a":"hello", "b":" world"}' | python3 -m jsonata.cli -o helloworld.json $
# helloworld.json written
% ls | python3 -m jsonata.cli $
helloworld.json
% ps -o pid="",%cpu="",%mem="" | python3 -m jsonata.cli '$.$split(/\n/).$trim().[ $split(/\s+/)[$length()>0].$number() ]' -c
[[4105,0,0],[4646,0,0],[4666,0,0],[33696,0,0]...]
% curl -s https://raw.githubusercontent.com/jsonata-js/jsonata/master/test/test-suite/datasets/dataset1.json | python3 -m jsonata.cli '{"Name": FirstName & " " & Surname, "Cities": **.City, "Emails": Email[type="home"].address}'
{
"Name": "Fred Smith",
"Cities": [
"Winchester",
"London"
],
"Emails": [
"[email protected]",
"[email protected]"
]
}
```
## Running Tests
This project uses the repository of the reference implementation as a submodule. This allows referencing the current version of the unit tests. To clone this repository, run:
```
git clone --recurse-submodules https://github.com/rayokota/jsonata-python
```
To build and run the unit tests:
```
python3 -m pip install nox
nox --sessions tests
```
## Notes
JSONata date/time functions that use ISO 8601 formats are only supported with Python 3.11+.