cflaremodel 0.1.0

No project description provided

flaremodel/README.md

🔥 FlareModel

FlareModel is a lightweight, async-first ORM for Python inspired by Laravel's Eloquent. Built for Cloudflare D1 and other serverless databases, it offers a fluent API, relationship management, and automatic schema introspection — all in a minimal package.

---

✨ Features

• ✅ Fluent, chainable query builder (where(), with_(), limit() etc.)
• ⚡ Async by default — built for modern Python 3.8+
• 🔁 Eager and lazy loading of relationships
• 📄 Schema introspection (fillable, casts, etc.)
• ☁️ D1-first, but pluggable with other SQL drivers

---

📦 Installation

pip install flaremodel

---

🚀 Quickstart

from flaremodel import Model
from flaremodel import D1Driver

# Example User model
class User(Model):
    table = "users"
    fillable = ["name", "email"]
    casts = {"created_at": "datetime"}

async def on_fetch(request, env):
    # Setup driver
    Model.set_driver(driver=D1Driver(env.DB))
    # Query
    users = await User.query().where("email", "like", "[e-mail]").get()

---

🧱 Defining Relationships

class Post(Model):
    table = "posts"

    async def user(self):
        return await self.belongs_to(User, "user_id")

class User(Model):
    table = "users"

    async def posts(self):
        return await self.has_many(Post, "user_id")

---

🧠 Schema Introspection

User.introspect({
    "name": {"type": "str"},
    "email": {"type": "str"},
    "created_at": {"type": "datetime"},
    "hidden": ["password"]
})

---

📜 License

GNU GPLv3 © 2025 — avltree9798