Metadata-Version: 1.1
Name: serializable
Version: 0.0.9
Summary: Base class with serialization helpers for user-defined Python objects
Home-page: https://github.com/hamemrlab/serializable
Author: Alex Rubinsteyn
Author-email: alex {dot} rubinsteyn {at} mssm {dot} edu
License: http://www.apache.org/licenses/LICENSE-2.0.html
Description: |Build Status|
        
        serializable
        ============
        
        Base class with serialization methods for user-defined Python objects
        
        Usage
        -----
        
        Classes which inherit from ``Serializable`` are enabled with default
        implementations of ``to_json``, ``from_json``, ``__reduce__`` (for
        pickling), and other serialization helpers. A derived class must either
        have a member data matching the name of each argument to ``__init__``
        or, alternatively, must provide a user-defined ``to_dict()`` method
        which returns a dictionary whose keys match the arguments to
        ``__init__``.
        
        Limitations
        -----------
        
        -  Serializable objects must inherit from ``Serializable``, be tuples or
           namedtuples, be serializble primitive types such as dict, list, int,
           float, or str.
        
        -  The serialized representation of objects relies on reserved keywords
           (such as ``"__name__"``, and ``"__class__"``), so dictionaries are
           expected to not contain any keys which begin with two underscores.
        
        .. |Build Status| image:: https://travis-ci.org/hammerlab/serializable.svg?branch=master
           :target: https://travis-ci.org/hammerlab/serializable
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
