Metadata-Version: 2.1
Name: doc-dict
Version: 0.0.2
Summary: Dict with documentation _-_
Home-page: https://github.com/Kel0/doc_dict
Author: Example Author
Author-email: rickeyfsimple@example.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# doc_dict
## Installation
```
git clone git@github.com:Kel0/doc_dict.git
```
```
pip install doc-dict
```
## Usage
```
from doc_dict.factory import documented_dict


my_dict = {
    "first_name": "Mike",
    "first_name_doc": "It's name field",
    "last_name": "Anderson",
}

my_doc_dict = documented_dict(my_dict)

my_doc_dict["first_name"].value  # Get value of key
my_doc_dict["first_name"].doc  # Get doc of key


my_dict = {
    "first_name": "Mike",
    "last_name": "Anderson",
}
my_dict_doc = {
    "first_name": "It's name field",
}

my_doc_dict = documented_dict(my_dict, my_dict_doc)
my_doc_dict["first_name"].value  # Get value of key
my_doc_dict["first_name"].doc  # Get doc of key
```


