Metadata-Version: 2.1
Name: dictionary-search
Version: 1.0.0
Summary: Small dictionary search utils
Home-page: https://github.com/cr0hn/python-dictionary-search
Author: Daniel Garcia / Cesar Gallego
Maintainer: Daniel Garcia (cr0hn)
Maintainer-email: cr0hn@cr0hn.com
License: License :: OSI Approved :: MIT License
Description: # Dictionary Search tools
        
        ![License](https://img.shields.io/badge/License-Apache2-SUCCESS)
        ![Pypi](https://img.shields.io/pypi/v/dictionary-search)
        ![Python Versions](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-blue)
        
        In a nutshell ``Dictionary Search`` is a small library to search in a dictionaries recursively.
        
        # Install
        
        ```bash
        > pip install dictionary-search
        ```
        
        # Usage example
        
        ```python
        # File: example.py
        
        from dictionary_search import search_first, search_all
        
        d = {
            "a": {
                "b": {
                    "c": "C value 1"
                }
            },
            "e": "f",
            "h": [
                {
                    "i": "j"
                },
                {
                    "c": "C value 2"
                }
            ]
        }
        
        print("Search First: ", search_first(d, "c"))
        print("Search All: ", search_all(d, "c"))
        print()
        print("Search First (path as tuple): ", search_first(d, "c", path_as_string=False))
        print("Search All (path as tuple): ", search_all(d, "c", path_as_string=False))
        
        ```
        
        After running the code, you will see:
        
        ``````bash
        > python examples/example.py
        Search First:  ('a.b.c', 'C value 1')
        Search All:  [('a.b.c', 'C value 1'), ('h.c', 'C value 2')]
        
        Search First (path as tuple):  (('a', 'b', 'c'), 'C value 1')
        Search All (path as tuple):  [(('a', 'b', 'c'), 'C value 1'), (('h', 'c'), 'C value 2')]
        ```
        
        
        
        # Authors
        
        - [Cesar Gallego](https://github.com/CesarGallego)
        - [cr0hn](https://github.com/cr0hn)
        
        # License
        
        Dictionary Search is Open Source and available under the [MIT](https://github.com/cr0hn/python-dictionary-search/blob/main/LICENSE).
        
        # Contributions
        
        Contributions are very welcome. See [CONTRIBUTING.md](https://github.com/cr0hn/python-dictionary-search/blob/main/CONTRIBUTING.md>) or skim existing tickets to see where you could help out.
        
        
        
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Environment :: Console
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS
Classifier: Operating System :: OS Independent
Classifier: Operating System :: Microsoft :: Windows
Classifier: Intended Audience :: Other Audience
Classifier: Intended Audience :: System Administrators
Description-Content-Type: text/markdown
