Metadata-Version: 2.1
Name: tinydb-dict
Version: 0.1.2
Summary: Simple dict-like class for TinyDB
Home-page: https://github.com/AliGhahraei/tinydb-dict
License: MIT
Keywords: tinydb
Author: Ali Ghahraei
Author-email: aligf94@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Requires-Dist: tinydb (>=3.13,<4.0)
Project-URL: Repository, https://github.com/AliGhahraei/tinydb-dict
Description-Content-Type: text/markdown

# tinydb-dict
Simple dict-like class for TinyDB

## Usage
```python
from tinydb import TinyDB
from tinydb.storages import MemoryStorage
from tinydb_dict import TinyDBDict

# Pass any TinyDB argument to TinyDBDict
db_dict = TinyDBDict('db.json')
db_dict = TinyDBDict(storage=MemoryStorage)

# Then use it as a dictionary
db_dict['key'] = 1
db_dict['key']  # 1
db_dict['key'] = 2
db_dict['key']  # 2
db_dict['unknown_key']  # KeyError: 'unknown_key'

# You can also pass a TinyDB instance
db = TinyDB('db.json')
db_dict = TinyDBDict(tinydb=db)
```

