Improving documentation to publicize and share the project and codes

docs/how-to.rst

@@ -0,0 +1,12 @@
+:tocdepth: 3
+
+How-To's
+===============
+
+Page dedicated to creating and sharing how-to's. All of the examples can be found in the `examples` folder.
+
+Title 1
+-----------------
+
+Title 2
+*****

docs/index.rst

@@ -21,6 +21,15 @@ User's Guide
    getting-started
    usage
 
+How-To's and Tutorials
+------------
+
+.. toctree::
+   :maxdepth: 2
+
+   how-to
+   tutorials
+
 Extending TinyDB
 ----------------
 

docs/tutorials.rst

@@ -0,0 +1,12 @@
+:tocdepth: 3
+
+Tutorials
+===============
+
+Page dedicated to creating and sharing tutorials. All of the examples can be found in the `examples` folder.
+
+Title 1
+-----------------
+
+Title 2
+*****

examples/advanced-usage/data_upsert.py

@@ -0,0 +1,23 @@
+from tinydb import TinyDB, Query
+
+# Creating a database
+db = TinyDB('db.json')
+
+# Insert data from people with name and logged-in status
+people = [
+    {'name': 'John', 'logged-in': False},
+    {'name': 'Alice', 'logged-in': False},
+    {'name': 'Bob', 'logged-in': True},
+    {'name': 'Carol', 'logged-in': False},
+    {'name': 'Eve', 'logged-in': True},
+]
+db.insert_multiple(people)
+print(db.all())
+
+# Uperting data, all Johns will be changed to logged-in
+User = Query()
+db.upsert({'name': 'John', 'logged-in': True}, User.name == 'John')
+print(db.all())
+
+# Truncate the database, comment if you want to keep the data
+people_db.truncate()

examples/advanced-usage/db.json

@@ -0,0 +1 @@
+{"_default": {"1": {"name": "John", "logged-in": true}, "2": {"name": "Alice", "logged-in": false}, "3": {"name": "Bob", "logged-in": true}, "4": {"name": "Carol", "logged-in": false}, "5": {"name": "Eve", "logged-in": true}}}

examples/advanced-usage/queries.py

@@ -0,0 +1,52 @@
+from tinydb import TinyDB, Query, where
+
+'''
+    Advanced Queries
+'''
+
+# Create a TinyDB instance for more advanced insertions
+# This will create or open a database file named 'people.json'
+people_db = TinyDB('people.json')
+
+# Define the data to be inserted
+people = [
+    {'name': 'John', 'birthday': {'year': 1985, 'month': 3, 'day': 15}},
+    {'name': 'Alice', 'birthday': {'year': 1990, 'month': 5, 'day': 10}},
+    {'name': 'Bob', 'birthday': {'year': 1987, 'month': 9, 'day': 20}},
+    {'name': 'Carol', 'birthday': {'year': 1992, 'month': 12, 'day': 5}},
+    {'name': 'Eve', 'birthday': {'year': 1989, 'month': 7, 'day': 25}},
+]
+
+# Insert the data into the database
+people_db.insert_multiple(people)
+
+# Print the contents of the database
+print(people_db.all())
+
+# Query the database using the Query object
+User = Query()
+print(people_db.search(User.name == 'John'))
+print(people_db.search(User.birthday.year == 1990))
+
+# Query the database using the where function
+print(people_db.search(where('birthday').year == 1900))
+print(people_db.search(~ (User.name == 'John')))
+
+'''
+    Query Modifiers
+'''
+
+# Negate a query, returns all people that are not John
+negated_query = ~ (User.name == 'John')
+print(people_db.search(negated_query))
+
+# Logical AND, returns all people that are John and born before 1995
+and_query = (User.name == 'John') & (User.birthday.year <= 1995)
+print(people_db.search(and_query))
+
+# Logical OR, returns all people that are Alex or Bob
+or_query = (User.name == 'Alex') | (User.name == 'Bob')
+print(people_db.search(or_query))
+
+# Truncate the database, comment if you want to keep the data
+people_db.truncate()

examples/getting-started/basic_usage.py

@@ -0,0 +1,31 @@
+from tinydb import TinyDB, Query
+
+# Creating a database
+db = TinyDB('db.json')
+
+# Inserting data
+db.insert({'type': 'apple', 'count': 7})
+db.insert({'type': 'peach', 'count': 3})
+
+# Get and print all documents
+print(db.all())
+
+# Itering the database
+for item in db:
+    print(item)
+
+# Searching for specific documents with Query object
+Fruit = Query()
+db.search(Fruit.type == 'peach')
+db.search(Fruit.count > 5)
+
+# Updating documents
+db.update({'count': 10}, Fruit.type == 'apple')
+print(db.all())
+
+# Removing documents
+db.remove(Fruit.count < 5)
+print(db.all())
+
+# Deleting all documents, comment if you want to keep the data
+db.truncate()

examples/getting-started/db.json

@@ -0,0 +1 @@
+{"_default": {}}