1
Fork 0
mirror of https://github.com/RGBCube/JsonWrapper synced 2025-07-27 11:47:45 +00:00

Update README.md

This commit is contained in:
RGBCube 2022-01-05 15:20:22 +03:00 committed by GitHub
parent e25f89a7e6
commit 29c72d7377
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,2 +1,26 @@
# ClutterDB # ClutterDB
extremely simple JSON database made for infrequent changes which behaves like a dict extremely simple JSON database made for infrequent changes which behaves like a dict
# Usage
```
from db import ClutterDB
# initialization
db = ClutterDB("path/to/json/file.json")
# defining a variable
# (this will overrride the previous a if it was defined before)
db.set("a", 12345)
# getting a variable
# (default kwarg will be returned if the key was not defined in the json)
data = db.get("a", default="a was not defined in the json")
# prints data
print(data)
# removes the a from the json
db.rem("a")
# nukes the json
db.nuke()
```