Metadata-Version: 1.1
Name: DataModelDict
Version: 0.8
Summary: Provides the DataModelDict class for creating, accessing and manipulating json/xml data structures.
Home-page: git@github.com:lmhale99/DataModelDict.git
Author: Lucas Hale
Author-email: lucas.hale@nist.gov
License: UNKNOWN
Description: DataModelDict
        =============
        
        DataModelDict is a lightweight Python class for easy transformation and 
        manipulation of JSON and XML structured data models.  It is designed to 
        take the best aspects of JSON, XML, and Python dictionaries to allow the 
        user to interact with any of these formats in the same manner.
        
        Basic examples can be found in the Jupyter Notebook `DataModelDict Basics.ipynb`_.
        Full documentation of the class methods can be found in Documentation.md_.
        
        .. _DataModelDict Basics.ipynb: https://github.com/usnistgov/DataModelDict/blob/master/DataModelDict%20Basics.ipynb
        .. _Documentation.md: https://github.com/usnistgov/DataModelDict/blob/master/Documentation.md
        
        The key features of DataModelDict (so far) are:
        
        1. It is a child of OrderedDict meaning that it has all the features one 
           would expect of a Python dictionary.
        
        2. It has built-in conversion methods for reading and writing JSON and XML.  
           JSON conversions use the standard Python `json library`_ and XML conversions 
           use the `xmltodict package`_.  
        
        .. _json library: https://docs.python.org/2/library/json.html
        .. _xmltodict package: https://github.com/martinblech/xmltodict
        
        3. Numbers (int, float) and key terms (True, False, None) are recognized and converted during parsing. 
        
        4. Methods for recusively searching the data model for specific keys and key-value pairs allow for the values 
           and paths (as lists of indices) of elements to be easily found.
        
        5. Path lists can also be directly used to get and set values. 
        
        .. code:: python
            
            #These two return the exact same val.
            val = my_model['a']['b']['c']['d'] 
            
            path = ['a', 'b', 'c', 'd']
            val = my_model[path]
          
        6. Additional methods for simplified handling of cases where XML does not directly map to JSON and Python 
           dictionaries.
        
        DataModelDict works by parsing in a JSON or XML data model such that every 
        dictionary level is an instance of DataModelDict.  This allows for the conversion 
        and functional methods to be callable both on the full model and on subcomponents. 
        
Keywords: json xml dictionary
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Scientific/Engineering :: Physics
