Metadata-Version: 1.1
Name: nested-lookup
Version: 0.1.5
Summary: lookup a key in a deeply nested document of dicts and lists
Home-page: https://github.com/russellballestrini/nested-lookup
Author: Russell Ballestrini
Author-email: russell@ballestrini.net
License: Public Domain
Description-Content-Type: UNKNOWN
Description: nested_lookup
        #############
        
        .. image:: https://img.shields.io/badge/pypi-0.1.3-green.svg
          :target: https://pypi.python.org/pypi/nested-lookup
        
        A small Python library which enables key lookups on deeply nested documents.
        
        Documents may be built out of dictionaries (dicts) and/or lists.
        
        Make working with JSON, YAML, and XML document responses fun again!
        
        .. contents::
        
        
        install
        ========
        
        install from pypi using pip::
        
         pip install nested-lookup
        
        or easy_install::
        
         easy_install nested-lookup
        
        or install from source using::
        
         git clone https://github.com/russellballestrini/nested-lookup.git
         cd nested-lookup
         pip install .
        
        quick tutorial
        ==============
        
        .. code-block:: python
        
         >>> from nested_lookup import nested_lookup
        
         >>> document = [ { 'taco' : 42 } , { 'salsa' : [ { 'burrito' : { 'taco' : 69 } } ] } ]
        
         >>> print(nested_lookup('taco', document))
         [42, 69]
        
        longer tutorial
        ===============
        
        You may control the libraries behavior by passing some optional arguments.
        
        wild (defaults to `False`):
         if `wild` is `True`, treat the given `key` as a case insensitive
         substring when performing lookups.
        
        with_keys (defaults to `False`):
          if `with_keys` is `True`, return a dictionary of all matched keys
          and a list of values.
        
        For example, given the following document:
        
        .. code-block:: python
        
         from nested_lookup import nested_lookup
        
         my_document = {
            'name' : 'Russell Ballestrini',
            'email_address' : 'test1@example.com',
            'other' : {
                'secondary_email' : 'test2@example.com',
                'EMAIL_RECOVERY' : 'test3@example.com',
                'email_address' : 'test4@example.com',
             },
         },
        
        We could act `wild` and find all the email addresses like this:
        
        .. code-block:: python
        
         results = nested_lookup(
             key = 'mail',
             document = my_document,
             wild = True
         )
        
         print(results)
        
        .. code-block:: python
        
         ['test1@example.com', 'test4@example.com', 'test2@example.com', 'test3@example.com']
        
        Additionally, if you also needed the matched key names, you could do this:
        
        .. code-block:: python
        
         results = nested_lookup(
             key = 'mail',
             document = my_document,
             wild = True,
             with_keys = True,
         )
        
         print(results)
        
        .. code-block:: python
        
          {
           'email_address': ['test1@example.com', 'test4@example.com'],
           'secondary_email': ['test2@example.com'],
           'EMAIL_RECOVERY': ['test3@example.com']
          }
        
        
        misc
        ========
        
        :license:
          * Public Domain
        
        :authors:
          * Russell Ballestrini
          * Douglas Miranda
        
        :web:
          * http://russell.ballestrini.net
          * http://douglasmiranda.com
          * https://gist.github.com/douglasmiranda/5127251
        
Keywords: nested document dictionary dict list lookup schema json xml yaml
Platform: All
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
