jflatdb 1.0.1

A lightweight JSON-based flat file database system.

jflatdb

🚀 jflatdb is a lightweight, file-based JSON database system designed for developers who want the simplicity of NoSQL with query features inspired by SQL.
No servers, no external dependencies — just plug-and-play storage with indexing, queries, and persistence.

---

📑 Table of Contents

• Features
• Installation
• Quick Start
• Usage Examples
• Project Structure
• Contributing
• License

---

🚀 Features

• 📦 JSON-powered storage – human-readable, lightweight, and portable
• ⚡ Fast querying with indexes – supports filters, conditions, and sorting
• 📑 Built-in functions – string, date/time, and aggregation functions
• 🔒 Security & validation – encryption, constraints, and safe writes
• 🛠 Zero setup – no database server needed, runs in pure Python

---

📦 Installation

pip install jflatdb

or from source

git clone https://github.com/jflatdb/jflatdb.git
cd jflatdb
pip install .

Usage

from jflatdb.database import Database

db = Database("users.json", password="your-password")

# Create or insert data
db.insert({"name": "Akki", "email": "[e-mail]"})

# Find records
users = db.find({"name": "Akki"})

# Advanced queries with operators
# Greater than, less than, etc.
young_users = db.find({"age": {"$gt": 18, "$lt": 30}})
# IN operator
specific_ids = db.find({"id": {"$in": [1, 2, 3]}})
# LIKE for pattern matching
names_starting_with_a = db.find({"name": {"$like": "A%"}})
# BETWEEN
ages_in_range = db.find({"age": {"$between": [20, 30]}})

# Update records
db.update({"name": "Akki"}, {"email": "[e-mail]"})

# Delete records
db.delete({"name": "Akki"})

📁 Project Structure

jflatdb/
├── jflatdb/
│   ├── __init__.py
│   ├── database.py
│   ├── query_engine.py
│   └── indexing.py
|    ├── scheme.py
├── tests/
├── examples/
├── setup.py
├── README.md
└── LICENSE

🎉 Contributors Leaderboard

🤝 Contributing

We welcome contributions from the community!

To get started:

Fork the repo

Create a new branch: git checkout -b feature-name

Make your changes and commit: git commit -m 'Add feature'

Push to your branch: git push origin feature-name

Open a Pull Request

Please read our CONTRIBUTING.md for full guidelines.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

💬 Join the Community

• Submit an Issue

• Start a Discussion

• Suggest a Feature

---

🙌 Credits

Developed and maintained by Akki.

---

🙏 Support & Contributions

Your contributions make this project better — whether it's reporting a bug, suggesting a feature, improving the documentation, or writing code. We welcome developers of all levels to participate!

If you like this project, consider ⭐ starring it and sharing it with others.
Together, let’s build something awesome with jflatdb.

Happy coding! 🚀