Metadata-Version: 2.1
Name: todict
Version: 0.2.4
Summary: Export python objects as dictionnaries so they can then be easily serializable.
Home-page: https://github.com/0livd/python-todict
Author: 0livd
Author-email: UNKNOWN
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6

Python-todict
#############

Python-todict allows you to easily turn any python object into a dictionary.
It can then be easily serialized, to json for example.
The class of the object you want to convert needs to inherit from two mixin classes and hold an attribute listing the attributes to export.
List, dict, tuple and set attributes are supported and any attribute object that implements the mixins are recursively converted.

Usage
=====

    >>> from todict.mixins import ToDictMixin, FromDictMixin
    >>> class MyClass(ToDictMixin, FromDictMixin):
    ...     TO_SERIALIZE = ["my_attr"]
    ...     def __init__(self):
    ...         self.my_attr = "data"
    ...
    >>> MyClass().to_dict()
    {'my_attr': 'data'}
    >>> restored_obj = MyClass.from_dict({'my_attr': 'test'})
    >>> getattr(restored_obj, "my_attr")
    'test'

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

Python-todict can be installed with pip:

    $ pip install todict

Launch tests
============

    >>> pip install -r requirements-dev.txt
    >>> tox

* **Python**: 2.7, 3.6.


