Metadata-Version: 2.1
Name: fynd
Version: 1.0.0
Summary: A super simple string searching library for complex list/dict structures
Home-page: https://github.com/ahmednooor/fynd
Author: Ahmed Noor
Author-email: m.ahmednoor7@yahoo.com
License: UNKNOWN
Description: # fynd
        
        [![PyPI](https://img.shields.io/pypi/v/nine.svg)](https://pypi.org/project/fynd/)
        
        > `fynd` makes it super simple to search for strings in complex list/dict data structures.
        > It returns a list of paths from root of the data structure to the found strings.
        
        ## Installation
        ```sh
        pip install fynd
        ```
        
        ## Usage
        ```python
        from fynd import Fynd as fynd
        
        COLLECTION = {
            'blogposts': [
                {
                    'title': 'Lorem Ipsum',
                    'text': 'Dolor Sit Amet Blah Blah Blah'
                },
                {
                    'title': 'Brown Fox',
                    'text': 'The quick brown fox jumps over blah'
                }
            ]
        }
        
        # default usage:
        RESULT = fynd('blah').inside(COLLECTION)
        # ^ will return,
        # [
        #    ['blogposts', 0, 'text'], 
        #    ^ COLLECTION['blogposts'][0]['text'] == 'Dolor Sit ... Blah'
        #    ['blogposts', 1, 'text']
        #    ^ COLLECTION['blogposts'][1]['text'] == 'The quick ... blah'
        # ]
        
        # case sensitive usage:
        RESULT = fynd('blah').case_sensitive().inside(COLLECTION)
        # ^ will return,
        # [
        #    ['blogposts', 1, 'text']
        #    ^ COLLECTION['blogposts'][1]['text'] == 'The quick ... blah'
        # ]
        
        # not found case:
        RESULT = fynd('hulalala').inside(COLLECTION)
        # ^ will return,
        # [] an empty list
        ```
        
        ## Meta
        - License: MIT
        - Author: Ahmed Noor
        - Source: https://github.com/ahmednooor/fynd
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
