Metadata-Version: 2.1
Name: pycheckey
Version: 0.1
Summary: Ensure nested dictionary structure.
Home-page: https://github.com/dstarner/pycheckey
Author: Daniel Starner
Author-email: starner.daniel5@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >3.5.2
Description-Content-Type: text/markdown

# PyChecKey

Ever have JSON or a large dictionary that you want to validate before you jump deeper into it? PyChecKey allows you to check a dictionary-like object against a defined structure.

This works with Python 3.5+.

## KeyEnsurer

A `KeyEnsurer` allows checking against a dictionary-like structure. 

```python
from pycheckey import KeyEnsurer


data = {
    "key1": 4,
    "key2": {
        "innerKey": "hi"
    }
}

ensurer = KeyEnsurer(data=data, required_keys=['key1', 'key2.innerKey', 'key3'])

ensurer.validate()  # Will return false because key3 does not exist!

ensurer.key_exists(data, 'key2.inner')  # Returns true because data[key2][inner] exists

```

