Find a file
2015-11-07 08:12:50 -05:00
.gitignore modified: .gitignore 2015-11-07 08:12:50 -05:00
__init__.py first commit, working with tests. 2015-11-06 23:30:53 -05:00
nested_lookup.py first commit, working with tests. 2015-11-06 23:30:53 -05:00
README.rst Update README.rst 2015-11-07 08:09:05 -05:00
setup.py first commit, working with tests. 2015-11-06 23:30:53 -05:00
test_nested_loopkup.py first commit, working with tests. 2015-11-06 23:30:53 -05:00

nested_lookup
#############

.. image:: https://img.shields.io/badge/pypi-0.0.1-green.svg
  :target: https://pypi.python.org/pypi/nested-lookup
  
.. image:: https://img.shields.io/badge/coverage-100%-green.svg
  :target: https://github.com/russellballestrini/nested-lookup/blob/master/test_nested_loopkup.py

A small Python library which enables key lookups on deeply nested documents.

Documents may be built out of dictionaries (dicts) and/or lists.

The `nested-lookup` function makes working with JSON, YAML, and XML fun again!

.. contents::



quick start
===========

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 .

tutorial
--------

.. code-block:: python

 >>> from nested_lookup import nested_lookup
 >>> document = [ { 'nachos' : 15 } , { 'salsa' : [ { 'taco': 42 }, { 'burrito' : { 'taco' : 69 } } ] } ]
 >>> print(nested_lookup('taco', document))
 [42, 69]

misc
----

:author: Russell Ballestrini

:web: http://russell.ballestrini.net

:license: Public Domain