Note
We’ve just added some awesome new utilities to LiteJsonDb to make your coding even smoother. For a quick overview and examples, check out our wiki for all the details.
Hey there! Welcome to LiteJsonDb, your friendly, lightweight JSON-based database. Inspired by the simplicity and real-time capabilities of Firestore, LiteJsonDb makes managing your data a breeze. It's packed with features like encryption, backups, and solid error handling—all without the heavy lifting.
Let's face it: sometimes you don't need a complex database setup. Maybe you're building a small project, a quick prototype, or you just want a straightforward way to store and retrieve JSON data. LiteJsonDb is here for those moments. It's simple, efficient, and gets the job done without any fuss.
- Easy Data Management: Add, edit, retrieve, and delete data with just a few lines of code.
- Data Encryption: Keep your data secure with optional encryption.
- Backup and Restore: Automatic backups to keep your data safe.
- Subcollections: Organize your data in neat, nested structures.
- Friendly Error Handling: Helpful, colorful error messages to guide you.
Note
LiteJsonDb makes managing JSON data simple and enjoyable. Whether you're building a small app or just need a lightweight data storage solution, LiteJsonDb has you covered. Enjoy!
Getting started is super easy. Just install the package via pip and you're good to go:
pip install litejsondb
A new version is available type pip install --upgrade litejsondb to update
First things first, import the JsonDB class and initialize your database:
import LiteJsonDb # Initialize the database with encryption enabled db = LiteJsonDb.JsonDB(crypted=True)
Adding data is a breeze. Just use the set_data method. If the key already exists, you'll get a friendly reminder to use edit_data instead.
# Set data without extra-data
db.set_data("posts")
# Set data with extra-data
db.set_data("users/1", {"name": "Aliou", "age": 20})
db.set_data("users/2", {"name": "Coder", "age": 25})
Need to update data? No problem. Use the edit_data method. It merges the new data with the existing data, so nothing gets lost.
# Edit data
db.edit_data("users/1", {"name": "Alex"})
Retrieving data is as simple as it gets. Use the get_data method.
# Get data
print(db.get_data("users/1")) # Output: {'name': 'Alex', 'age': 20}
print(db.get_data("users/2")) # Output: {'name': 'Coder', 'age': 25}
Tip
You can directly access specific data by using paths in the get_data method. For example, to get only the user's name, you can do:
print(db.get_data("users/1/name"))
Here, you get the user's name without retrieving other parts of the data.
Need to delete something? The remove_data method has you covered.
# Remove data
db.remove_data("users/2")
Want to see everything? Use the get_db method. Set raw=True if you want the data in a readable format.
# Get the full database print(db.get_db(raw=True))
This new feature was integrated in response to the issue raised about improving data search capabilities. This function allows you to search for values within your database, either across the entire database or within a specific key. This enhancement makes finding your data much easier and more efficient.
The search_data function provides two main modes of search:
- Basic Search: Search for a value anywhere in the database.
- Key-specific Search: Search for a value within a specific key.
-
Use the
search_dataFunctionHere’s how you can use the
search_datafunction:-
Basic Search: To search for a value across the entire database, use the following code:
results = db.search_data("Aliou") print(results)
This will search for the value
"Aliou"throughout all the keys in your database. -
Key-specific Search: To search for a value within a specific key, use the following code:
results = db.search_data("Aliou", key="users") print(results)
This will search for the value
"Aliou"specifically within the"users"key.
-
In LiteJsonDb, subcollections are a way to organize your data hierarchically. Think of them as nested structures that allow you to group related data together under a parent key. This feature is especially useful when you want to manage complex data relationships without losing the simplicity of JSON.
Subcollections are essentially collections within collections. For example, if you have a main collection of users, you might want to organize their posts into separate subcollections. Here’s how you can work with them:
- Setting Subcollection Data: Create and populate a subcollection under a specified parent key.
- Editing Subcollection Data: Update existing items in a subcollection.
- Getting Subcollection Data: Retrieve the data stored within a subcollection.
- Removing Subcollection Data: Delete items or entire subcollections.
Using subcollections helps you maintain a clear structure in your data, making it easier to manage and query.
Organize your data with subcollections. Easy peasy.
# Set subcollection data
db.set_subcollection("groups", "1", {"name": "Admins"})
Editing items within a subcollection? No sweat.
# Edit subcollection data
db.edit_subcollection("groups", "1", {"description": "Admin group"})
Need to retrieve specific subcollections or items? We've got you.
# Get subcollection data
print(db.get_subcollection("groups"))
# Get custom item from the subcollection data
print(db.get_subcollection("groups", "1"))
Removing items from subcollections is just as simple.
# Remove subcollection data
db.remove_subcollection("groups", "1")
LiteJsonDb is all about being helpful. Here are some friendly, colorful error messages to guide you:
- Key Exists: If you try to set data with an existing key, it will suggest using
edit_data. - Key Not Found: If a key does not exist when you try to get or remove data, it will notify you with a tip on how to proceed.
- File Issues: If there are file permission problems, it will guide you on how to fix them.
Here's how your project might look if your initialized LiteJssonDb:
project/ │ ├── database/ │ ├── db.json │ ├── db_backup.json │ └── LiteJsonDb.log └── your_code.py
Example Let's put it all together with an example main.py file:
import LiteJsonDb
# Initialize the database with encryption enabled
db = LiteJsonDb.JsonDB(crypted=True)
# Add some initial data
# Set data without extra-data
db.set_data("posts")
# Set data with extra-data
db.set_data("users/1", {"name": "Aliou", "age": 20})
db.set_data("users/2", {"name": "Coder", "age": 25})
# Modify existing data
db.edit_data("users/1", {"name": "Alex"})
# Retrieve and print data
print(db.get_data("users/1"))
print(db.get_data("users/2"))
# Remove data
db.remove_data("users/2")
# Perform a basic search
results = db.search_data("Aliou")
print("Basic Search Results:", results)
# Perform a key-specific search
results = db.search_data("Aliou", key="users")
print("Key-specific Search Results:", results)
# Retrieve the full database
print(db.get_db(raw=True))
# Work with subcollections
db.set_subcollection("groups", "1", {"name": "Admins"})
db.edit_subcollection("groups", "1", {"description": "Admin group"})
print(db.get_subcollection("groups"))
db.remove_subcollection("groups", "1")
Click to expand
The set_data method is used to add or update data at a specific path. If the key already exists, you will need to use edit_data to modify it. This method is great for simple key-value pairs or straightforward data structures.
# Set data
db.set_data("users/1", {"name": "Aliou", "age": 20})
Subcollections, on the other hand, are used to create and manage nested structures within your database. They allow you to group related data under a parent key, providing a more organized way to handle complex relationships. Subcollections are essentially collections within collections.
# Set subcollection data
db.set_subcollection("groups", "1", {"name": "Admins"})
- Structure:
set_datais used for flat data structures, while subcollections allow for hierarchical organization. - Usage: Use
set_datafor simple key-value pairs andset_subcollectionwhen you need nested collections. - Organization: Subcollections help in maintaining a clear structure and grouping related data together, making it easier to manage and query complex relationships.
By understanding these differences, you can choose the appropriate method for your data management needs, ensuring a well-organized and efficient database.
We’re always striving to enhance Json2DB-Lite. Here’s what’s on our radar:
- Add support for data encryption to secure JSON content.
- Implement automatic backups to ensure data safety.
- Improve error handling with friendly, colorful messages.
- Added french language documentation
- Implement automated backups to send data to a Telegram bot.
- Fix any bugs that are discovered to ensure smooth operation.
- Reach 100 stars on GitHub and celebrate by adding more awesome features!
We welcome contributions, suggestions, and feedback to make LiteJsonDb even better! If you have ideas for improvements or want to fix a bug, feel free to:
- Submit a Pull Request (PR): Contribute new features or bug fixes by creating a pull request. Your changes will help improve LiteJsonDb for everyone!
- Report Issues: If you encounter any bugs or issues, please open an issue in the repository. Provide as much detail as possible so we can address it swiftly.
- Suggest Features: Have an idea for a new feature? Let us know! We’re always open to suggestions on how to enhance LiteJsonDb.
Your feedback and contributions are greatly appreciated and help us keep LiteJsonDb growing and improving.
Json2DB-Lite is a labor of love, and your support can make a big difference! If you’re enjoying the project and want to show your appreciation, here are a few ways you can help:
One of the best ways to support Json2DB-Lite is to fork the repository and give it a star on GitHub. It’s like a virtual high-five and helps us spread the word about the project. Plus, it shows us that you value the work we’re doing!
If you’re feeling extra generous and want to contribute financially, we’d be incredibly grateful. Donations help us cover costs and keep the project running smoothly. You can support us in the following ways:
- PayPal: Send a donation directly to my PayPal account. Every little bit helps and is greatly appreciated!
- Bitcoin: Prefer cryptocurrency? You can also donate using Bitcoin to the following address:
1Nn15EttfT2dVBisj8bXCnBiXjcqk1ehWR.
Your support, whether through a star, a fork, or a donation, helps keep Json2DB-Lite alive and thriving. Thank you for being awesome!
Cheers and happy coding! 🚀
