json-database 0.8.0a1__py3-none-any.whl

json_database-0.8.0a1.dist-info/METADATA

@@ -0,0 +1,205 @@
+Metadata-Version: 2.1
+Name: json-database
+Version: 0.8.0a1
+Summary: searchable json database with persistence
+Home-page: https://github.com/TigreGotico/json_database
+Author: jarbasAI
+Author-email: jarbasai@mailfence.com
+License: MIT
+Platform: UNKNOWN
+Description-Content-Type: text/markdown
+Requires-Dist: combo-lock<1.0.0,>=0.2.1
+
+# Json Database
+
+Python dict based database with persistence and search capabilities
+
+For those times when you need something simple and sql is overkill
+
+
+## Features
+
+- pure python
+- save and load from file
+- search recursively by key and key/value pairs
+- fuzzy search
+- supports arbitrary objects
+- supports comments in saved files
+
+## Install
+
+```bash
+pip install json_database
+```
+
+## Usage
+
+
+### JsonStorage
+
+Sometimes you need persistent dicts that you can save and load from file
+
+```python
+from json_database import JsonStorage
+from os.path import exists
+
+save_path = "my_dict.conf"
+
+my_config = JsonStorage(save_path)
+
+my_config["lang"] = "pt"
+my_config["secondary_lang"] = "en"
+my_config["email"] = "jarbasai@mailfence.com"
+
+# my_config is a python dict
+assert isinstance(my_config, dict)
+
+# save to file
+my_config.store()
+
+my_config["lang"] = "pt-pt"
+
+# revert to previous saved file
+my_config.reload()
+assert my_config["lang"] == "pt"
+
+# clear all fields
+my_config.clear()
+assert my_config == {}
+
+# load from a specific path
+my_config.load_local(save_path)
+assert my_config == JsonStorage(save_path)
+
+# delete stored file
+my_config.remove()
+assert not exists(save_path)
+
+# keep working with dict in memory
+print(my_config)
+```
+
+### JsonDatabase
+
+Ever wanted to search a dict?
+
+Let's create a dummy database with users
+
+```python
+from json_database import JsonDatabase
+
+db_path = "users.db"
+
+with JsonDatabase("users", db_path) as db:
+    # add some users to the database
+
+    for user in [
+        {"name": "bob", "age": 12},
+        {"name": "bobby"},
+        {"name": ["joe", "jony"]},
+        {"name": "john"},
+        {"name": "jones", "age": 35},
+        {"name": "joey", "birthday": "may 12"}]:
+        db.add_item(user)
+
+    # pretty print database contents
+    db.print()
+
+
+# auto saved when used with context manager
+# db.commit()
+
+
+```
+
+search entries by key
+
+```python
+from json_database import JsonDatabase
+
+db_path = "users.db"
+
+db = JsonDatabase("users", db_path) # load db created in previous example
+
+# search by exact key match
+users_with_defined_age = db.search_by_key("age")
+
+for user in users_with_defined_age:
+    print(user["name"], user["age"])
+
+# fuzzy search
+users = db.search_by_key("birth", fuzzy=True)
+for user, conf in users:
+    print("matched with confidence", conf)
+    print(user["name"], user["birthday"])
+```
+
+search by key value pair
+
+```python
+# search by key/value pair
+users_12years_old = db.search_by_value("age", 12)
+
+for user in users_12years_old:
+    assert user["age"] == 12
+
+# fuzzy search
+jon_users = db.search_by_value("name", "jon", fuzzy=True)
+for user, conf in jon_users:
+    print(user["name"])
+    print("matched with confidence", conf)
+    # NOTE that one of the users has a list instead of a string in the name, it also matches
+```
+
+updating an existing entry
+
+```python
+# get database item
+item = {"name": "bobby"}
+
+item_id = db.get_item_id(item)
+
+if item_id >= 0:
+    new_item = {"name": "don't call me bobby"}
+    db.update_item(item_id, new_item)
+else:
+    print("item not found in database")
+
+# clear changes since last commit
+db.reset()
+```
+
+You can save arbitrary objects to the database
+
+```python
+from json_database import JsonDatabase
+
+db = JsonDatabase("users", "~/databases/users.json")
+
+
+class User:
+    def __init__(self, email, key=None, data=None):
+        self.email = email
+        self.secret_key = key
+        self.data = data
+
+user1 = User("first@mail.net", data={"name": "jonas", "birthday": "12 May"})
+user2 = User("second@mail.net", "secret", data={"name": ["joe", "jony"], "age": 12})
+
+# objects will be "jsonified" here, they will no longer be User objects
+# if you need them to be a specific class use some ORM lib instead (SQLAlchemy is great)
+db.add_item(user1)
+db.add_item(user2)
+
+# search entries with non empty key
+print(db.search_by_key("secret_key"))
+
+# search in user provided data
+print(db.search_by_key("birth", fuzzy=True))
+
+# search entries with a certain value
+print(db.search_by_value("age", 12))
+print(db.search_by_value("name", "jon", fuzzy=True))
+
+```
+

json_database-0.8.0a1.dist-info/RECORD

@@ -0,0 +1,12 @@
+json_database/__init__.py,sha256=P0qG3TU5iX0FRhZibTG6mQn93DtqojwhOYdUCfjGWnM,12395
+json_database/crypto.py,sha256=YAQw0mGJKC5sXX1_8UHZ8Ll0Akr7YA2d4CCMsXjvu1g,2346
+json_database/exceptions.py,sha256=scp9y-ZNAzCLnCwYoioOxy0C-Mk95tOlIa5nfSqQO0A,458
+json_database/search.py,sha256=RM4f4Qj-B8gUXIHtdCyQ33XrK_IHYFtgW5XQZDrpVDU,6577
+json_database/utils.py,sha256=jEQftnXu5ZiC--goaQiwLQ3LdhYTFB89B3v2Pnt4sO8,10656
+json_database/version.py,sha256=LcHxD83rEw6t1fjIIETn2QTvmXEIijkX0zzOQfHIISo,114
+json_database/xdg_utils.py,sha256=UnhHXn4ZFUa7gGvc7IYlqH8XTVCJjs4fsPX9S2XoM40,5585
+json_database-0.8.0a1.dist-info/LICENSE,sha256=548oOCrCNqQty8Fsqqry522lXdxnBTqLyzqr38ct-cw,1040
+json_database-0.8.0a1.dist-info/METADATA,sha256=poxYqQH-D1XLHcvmI1f9iWRKmuGL27PHTfoEiyFOzVs,4396
+json_database-0.8.0a1.dist-info/WHEEL,sha256=tZoeGjtWxWRfdplE7E3d45VPlLNQnvbKiYnx7gwAy8A,92
+json_database-0.8.0a1.dist-info/top_level.txt,sha256=QfyxfZG3hW-n-2FJHzHchBz5GZ37cB92QDOuF1t51X0,14
+json_database-0.8.0a1.dist-info/RECORD,,

json_database-0.8.0a1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.45.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

json_database-0.8.0a1.dist-info/top_level.txt

@@ -0,0 +1 @@
+json_database