dbini 0.1.2

Zero-config NoSQL backend database as a Python package

dbini

Zero-config NoSQL backend database as a Python package

---

📋 Table of Contents

• 🚀 Features
• 🛠️ Installation
• 💻 Usage
• 🗂 Project Structure
• 🏗️ Built With
• 🤝 Contributing
• 📄 License
• 📞 Contact
• 🙏 Acknowledgments

---

🚀 Features

• ✨ Zero-config backend database
• 🔥 Store JSON documents and files inside the project folder
• 🛡️ Secure atomic writes for data and files
• 🌐 REST API & WebSocket support for any language
• 📦 Self-contained Python package
• ⚡ Works in Python 3.9+
• 📊 CRUD operations for collections and documents
• 🖼️ File storage and retrieval
• ⚡ Real-time WebSocket updates for WAL events
• 🔍 Query with filters and limits

---

🛠️ Installation

Prerequisites

• Python 3.9+
• pip

Quick Start

# Install from PyPI
pip install dbini

# Or install from local repo
# Clone the repository
# git clone https://github.com/Binidu01/dbini.git

# Navigate to project directory
# cd dbini

# (Optional) Create virtual environment
# python -m venv venv
# source venv/bin/activate  # On Windows: venv\Scripts\activate

# Install the package locally
# pip install .

# Run a test script
python examples/test_dbini.py

---

💻 Usage

As Local Database

from dbini import DBini

db = DBini("myproject")
user_id = db.collection("users").add({"name": "Alice", "age": 22})
print("Created user:", user_id)

# Query documents
for doc in db.collection("users").find({"age": 22}):
    print(doc)

# Save image/file
file_id = db.save_file("avatar.png")
db.collection("users").update(user_id, {"avatar": file_id})

As API Server

from dbini.server import DBiniServer

server = DBiniServer("myproject")
server.serve(port=8080)

Endpoints Example:

• POST /v1/{collection}/documents → Create document
• POST /v1/files → Upload file
• All data stays inside the project folder.

---

🗂 Project Structure

Example project layout when using dbini:

myproject/
 ├─ data/
 │   └─ collections/
 │       └─ users/
 │           ├─ <uuid>.json
 ├─ files/
 │   └─ <uuid>.png
 └─ meta/
     └─ project.json

• collections/ → stores JSON documents per collection
• files/ → stores images or other files uploaded
• meta/project.json → optional project settings

---

🏗️ Built With

• Python - Core language
• FastAPI - REST API server
• Uvicorn - ASGI server

---

🤝 Contributing

Contributions are welcome!

1. Fork the Project
2. Create your Feature Branch git checkout -b feature/AmazingFeature
3. Commit your Changes git commit -m "Add AmazingFeature"
4. Push to the Branch git push origin feature/AmazingFeature
5. Open a Pull Request

---

📄 License

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

---

📞 Contact

Binidu01 - GitHub Profile

Project Link: https://github.com/Binidu01/dbini

PyPI Link: https://pypi.org/project/dbini

---

🙏 Acknowledgments

• Thanks to all contributors who helped this project grow
• Built with ❤️ and lots of ☕
• Inspired by Firebase and modern local-first backends

---

⬆ Back to Top

Made with ❤️ by Binidu01

⭐ Star this repo if you find it useful!