Metadata-Version: 2.0
Name: python-data-reducer
Version: 0.0.6
Summary: This package help you to easily reduce the data input.
Home-page: https://github.com/shinrel22/data_reducer
Author: Tri Nguyen
Author-email: tringuyen5835@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.7
Description-Content-Type: text/markdown

===========
DataReducer
===========

:Info: DataReducer is an python tool for easily handling data.

:Repository: https://github.com/shinrel22/data_reducer

:Author: Tri Nguyen (https://github.com/shinrel22)

:Maintainer: Tri Nguyen (https://github.com/shinrel22)


Installation
============

``pipenv install python-data-reducer``

Examples
========
Some simple examples of what DataReducer can do:

.. code :: python

    from data_reducer import DataReducer

    >>> origin_data = {
        'id': '1',
        'avatar': {
            'creator': {
                'birthday': {'day': 22, 'month': 1, 'year': 1993},
                'email': 'example@gmail.com',
                'id': '1',
                'name': 'example'
            },
            'deleted': False,
            'id': '1',
            'path': 'abc',
            'types': ['a', 'b', 'c'],
            'url': 'url'
        },
        'translations': [
            {'content': '1', 'id': '1', 'locale': 'vi', 'name': 'A'},
            {'content': '2', 'id': '2', 'locale': 'en', 'name': 'B'}
        ]
    }

    >>> only_fields = [
        'id',
        'translations.id',
        'translations.locale',
        'translations.name',
        'translations.types',
        'avatar.url',
        'avatar.id',
        'avatar.creator.id',
        'avatar.creator.birthday.year',
    ]

    >>> DataReducer(data=origin_data, include_fields=only_fields).run()

    {
        'id': '1',
        'translations': [
            {'id': '1', 'locale': 'vi', 'name': 'A'},
            {'id': '2', 'locale': 'en', 'name': 'B'}
        ],
        'avatar': {
            'url': 'url',
            'id': '1',
            'creator': {
                'id': '1',
                'birthday': {'year': 1993}
            }
        }
    }


