Configurable and documentable Json transformation and mapping
Project description
Piri
Configurable Data Mapping for mortals
Documentation | Source Code | Task Tracker
Goal
The goal of this library is to make JSON to JSON transformation/mapping configurable. We achieve this by using a simple but feature-rich JSON configuration which then also acts as a contract.
Features
- Mapping with configuration File.
- Transforms JSON
- Combine multiple values to one.
- Default values
- If statements
- is, contains, not
- casting
- integer, decimal, iso date
Contributing
Please see contribute
Installation
Package is on pypi. Use pip or poetry to install
pip install piri
poetry add piri
Quickstart
import simplejson
from piri.process import process
my_config = {
'name': 'schema',
'array': False,
'objects': [
{
'name': 'invoices',
'array': True,
'path_to_iterable': ['root', 'invoices'],
'attributes': [
{
'name': 'amount',
'mappings': [
{
'path': ['invoices', 'amount'],
},
],
'casting': {
'to': 'decimal',
'original_format': 'integer_containing_decimals',
},
'default': 0,
},
{
'name': 'debtor',
'mappings': [
{
'path': ['root', 'customer', 'first_name'],
},
{
'path': ['root', 'customer', 'last_name'],
},
],
'separator': ' ',
},
],
'objects': [],
},
],
}
example_data = {
'root': {
'customer': {
'first_name': 'John',
'last_name': 'Smith',
},
'invoices': [
{
'amount': 10050,
},
{
'amount': 20050,
},
{
'amount': -15005,
},
],
},
}
mapped_data = process(example_data, my_config)
with open('resultfile.json', 'w') as output_file:
output_file.write(simplejson.dumps(mapped_data))
contents of resultfile.json
{
"invoices": [
{
"amount": 100.5,
"debtor": "John Smith"
},
{
"amount": 200.5,
"debtor": "John Smith"
},
{
"amount": -150.05,
"debtor": "John Smith"
}
]
}
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
piri-1.0.2.tar.gz
(14.1 kB
view hashes)
Built Distribution
piri-1.0.2-py3-none-any.whl
(16.1 kB
view hashes)