Configurable and documentable Json transformation and mapping


Keywords
Json, mapping, data, transformation, to, dict, configurable, datamanipulation
License
MIT
Install
pip install piri==2.1.0

Documentation

Piri

Configurable Data Mapping for mortals


test codecov Python Version wemake-python-styleguide


Documentation (Stable | Latest) | Source Code | Task Tracker

What is Piri

Piri is a JSON to JSON mapper. That means that we read input JSON and create output JSON. How the output is created is based on instructions from a configuration file. The configuration file governs the the output structure and tells piri where in the input to find data and where to place it in the output. In addition to this Piri supports data transformation with data casting, if conditions, combination of data from multiple places and of course setting default values.

This enables you to change any input into the output you desire.

Typical usecases

  • You GET data from api, but need to transform it for your backend system
  • POSTing data to an api that needs data on a different format than what your system produces
  • All your backends speak different language? pipe it through Piri
  • Customer delivers weirdly formatted data? Use Piri to make it sexy
  • Have CSV but need nicely structured JSON? make CSV into a JSON list and transform it with Piri
  • Have XML but need to change it? make it into JSON, transform it with Piri and then dump it to XML again.
  • Customers legacy system needs CSV. Use Piri to transform your nicely structured JSON data into a JSON List that can be easily dumped to CSV

Official Open Piri Solutions

piri-cli, commandline interface for file to file mapping.

piri-web, One Click deploy Web REST API for Piri JSON mapping.

Enterprise solutions

Coming...

Goal

The goal of this library is to make JSON to JSON transformation/mapping easy, configurable and documentable. We achieve this by using a simple but feature-rich JSON configuration which then also acts as documentation and as a contract between parties.

Why

Piri was born because we really dislike mapping. Documenting whatever decisions made in your code so that some product owner understands it is also no me gusto. Transforming data from one format to another is something software engineers do allmost daily... It should be easy! And documenting it shouldn't be something you have to worry about.

After the Worst POC in History we never wanted to do mapping by scripts and code again. This lead to the idea that it should be possible to create a file which governs how the structure should look and how the data should be transformed. This would then be the single source of truth and with Piri we have achieved this.

We believe that this will make collaboration between teams faster and easier. Use Piri to agree with data formats between Front-end and Back-end. Between the 3rd party system and your back-end. You can even use Piri for testing existing integrations ;-)

Features

  • Mapping with configuration File.
  • JSON Schema validation of the config file.
  • Structurally Transform 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

Introduction

Have a look at our introduction course here

Quickstart

import simplejson

from piri.process import process

my_config = {
    'name': 'schema',
    'array': False,
    'objects': [
        {
            'name': 'invoices',
            'array': True,
            'iterables': [
                {
                    'alias': 'invoices',
                    'path': ['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"
        }
    ]
}