Metadata-Version: 2.1
Name: understreck
Version: 0.2.0
Summary: A collection of nice utility functions for python
Home-page: https://github.com/cfp2000/understreck
Author: Carl-Fredrik Arvidson
Author-email: carl-fredrik@arvidson.io
License: GNU General Public License v3
Keywords: understreck
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 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

===========
Understreck
===========


.. image:: https://img.shields.io/pypi/v/understreck.svg
        :target: https://pypi.python.org/pypi/understreck

.. image:: https://img.shields.io/travis/cfp2000/understreck.svg
        :target: https://travis-ci.org/cfp2000/understreck

.. image:: https://readthedocs.org/projects/understreck/badge/?version=latest
        :target: https://understreck.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


.. image:: https://pyup.io/repos/github/cfp2000/understreck/shield.svg
     :target: https://pyup.io/repos/github/cfp2000/understreck/
     :alt: Updates



A collection of nice utility functions for python


* Free software: GNU General Public License v3
* Documentation: https://understreck.readthedocs.io.


Features
--------

* Perform a safe get on a nested dictionary with the nested_get function

Nested Get example::

    import understreck as _

    test_dictionary = {
        "the_top_level": {
            "second_level": {"third_level": "it works", "third_level_sibling": False}
        }
    }

    # Using dot delimited strings
    result = _.nested_get(test_dictionary, "the_top_level.second_level.third_level")  # result = "it works"
    result = _.nested_get(test_dictionary, "the_top_level.second_level.DOES_NOT_EXIST")  # result = None

    # Using a list or tuple
    result = _.nested_get(test_dictionary, ["the_top_level", "second_level", "third_level"])  # result = "it works"
    result = _.nested_get(test_dictionary, ["the_top_level", "second_level", "DOES_NOT_EXIST"])  # result = None

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.2.0 (2018-11-12)
------------------
* Add get as an alias for nested get

0.1.1 (2018-11-02)
------------------
* Update the readme

0.1.0 (2018-11-02)
------------------

* First release on PyPI.


