async-easy-model 0.1.12__py3-none-any.whl → 0.2.2__py3-none-any.whl

async_easy_model-0.2.2.dist-info/METADATA

@@ -0,0 +1,332 @@
+Metadata-Version: 2.2
+Name: async-easy-model
+Version: 0.2.2
+Summary: A simplified SQLModel-based ORM for async database operations
+Home-page: https://github.com/puntorigen/easy-model
+Author: Pablo Schaffner
+Author-email: pablo@puntorigen.com
+Keywords: orm,sqlmodel,database,async,postgresql,sqlite
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlmodel>=0.0.8
+Requires-Dist: sqlalchemy>=2.0.0
+Requires-Dist: asyncpg>=0.25.0
+Requires-Dist: aiosqlite>=0.19.0
+Requires-Dist: greenlet>=3.1.1
+Requires-Dist: inflection>=0.5.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# async-easy-model
+
+A simplified SQLModel-based ORM for async database operations in Python. async-easy-model provides a clean, intuitive interface for common database operations while leveraging the power of SQLModel and SQLAlchemy.
+
+<p align="center">
+  <img src="https://img.shields.io/pypi/v/async-easy-model" alt="PyPI Version">
+  <img src="https://img.shields.io/pypi/pyversions/async-easy-model" alt="Python Versions">
+  <img src="https://img.shields.io/github/license/puntorigen/easy_model" alt="License">
+</p>
+
+## Features
+
+- 🚀 Easy-to-use async database operations with standardized methods
+- 🔄 Intuitive APIs with sensible defaults for rapid development
+- 📊 Dictionary-based CRUD operations (select, insert, update, delete)
+- 🔗 Enhanced relationship handling with eager loading and nested operations
+- 🔍 Powerful query methods with flexible ordering support
+- ⚙️ Automatic relationship detection and bidirectional setup
+- 📱 Support for both PostgreSQL and SQLite databases
+- 🛠️ Built on top of SQLModel and SQLAlchemy for robust performance
+- 📝 Type hints for better IDE support
+- 🕒 Automatic `id`, `created_at` and `updated_at` fields provided by default
+- 🔄 Automatic schema migrations for evolving database models
+
+## Installation
+
+```bash
+pip install async-easy-model
+```
+
+## Basic Usage
+
+```python
+from async_easy_model import EasyModel, init_db, db_config, Field
+from typing import Optional
+from datetime import datetime
+
+# Configure your database
+db_config.configure_sqlite("database.db")
+
+# Define your model
+class User(EasyModel, table=True):
+    #no need to specify id, created_at or updated_at since EasyModel provides them by default
+    username: str = Field(unique=True)
+    email: str
+
+# Initialize your database
+async def setup():
+    await init_db()
+
+# Use it in your async code
+async def main():
+    await setup()
+    # Create a new user
+    user = await User.insert({
+        "username": "john_doe",
+        "email": "john@example.com"
+    })
+    
+    # Get user ID
+    print(f"New user id: {user.id}")
+```
+
+## CRUD Operations
+
+First, let's define some models that we'll use throughout the examples:
+
+```python
+from async_easy_model import EasyModel, Field
+from typing import Optional, List
+from datetime import datetime
+
+class User(EasyModel, table=True):
+    username: str = Field(unique=True)
+    email: str
+    is_active: bool = Field(default=True)
+    
+class Post(EasyModel, table=True):
+    title: str
+    content: str
+    user_id: Optional[int] = Field(default=None, foreign_key="user.id")
+    
+class Comment(EasyModel, table=True):
+    text: str
+    post_id: Optional[int] = Field(default=None, foreign_key="post.id")
+    user_id: Optional[int] = Field(default=None, foreign_key="user.id")
+    
+class Department(EasyModel, table=True):
+    name: str = Field(unique=True)
+    
+class Product(EasyModel, table=True):
+    name: str
+    price: float
+    sales: int = Field(default=0)
+    
+class Book(EasyModel, table=True):
+    title: str
+    author_id: Optional[int] = Field(default=None, foreign_key="author.id")
+    
+class Author(EasyModel, table=True):
+    name: str
+```
+
+### Create (Insert)
+
+```python
+# Insert a single record
+user = await User.insert({
+    "username": "john_doe",
+    "email": "john@example.com"
+})
+
+# Insert multiple records
+users = await User.insert([
+    {"username": "user1", "email": "user1@example.com"},
+    {"username": "user2", "email": "user2@example.com"}
+])
+
+# Insert with relationships using nested dictionaries
+post = await Post.insert({
+    "title": "My First Post",
+    "content": "Hello world!",
+    "user": {"username": "john_doe"}  # Will automatically link to existing user
+})
+```
+
+### Read (Retrieve)
+
+```python
+# Select by ID
+user = await User.select({"id": 1})
+
+# Select with criteria
+users = await User.select({"is_active": True}, all=True)
+
+# Select first matching record
+first_user = await User.select({"is_active": True}, first=True)
+
+# Select all records
+all_users = await User.select({}, all=True)
+
+# Select with wildcard pattern matching
+gmail_users = await User.select({"email": "*@gmail.com"}, all=True)
+
+# Select with ordering
+recent_users = await User.select({}, order_by="-created_at", all=True)
+
+# Select with limit
+latest_posts = await Post.select({}, order_by="-created_at", limit=5)
+# Note: limit > 1 automatically sets all=True
+
+# Select with multiple ordering fields
+sorted_users = await User.select({}, order_by=["last_name", "first_name"], all=True)
+
+# Select with relationship ordering
+posts_by_author = await Post.select({}, order_by="user.username", all=True)
+```
+
+### Update
+
+```python
+# Update by ID
+user = await User.update({"is_active": False}, 1)
+
+# Update by criteria
+count = await User.update(
+    {"is_active": False},
+    {"last_login": None}  # Set all users without login to inactive
+)
+
+# Update with relationships
+await User.update(
+    {"department": {"name": "Sales"}},  # Update department relationship
+    {"username": "john_doe"}
+)
+```
+
+### Delete
+
+```python
+# Delete by ID
+success = await User.delete(1)
+
+# Delete by criteria
+deleted_count = await User.delete({"is_active": False})
+
+# Delete with compound criteria
+await Post.delete({"user": {"username": "john_doe"}, "is_published": False})
+```
+
+## Convenient Query Methods
+
+async-easy-model provides simplified methods for common query patterns:
+
+```python
+# Get all records with relationships loaded (default)
+users = await User.all()
+
+# Get all records ordered by a field (ascending)
+users = await User.all(order_by="username")
+
+# Get all records ordered by a field (descending)
+newest_users = await User.all(order_by="-created_at")
+
+# Get all records ordered by multiple fields
+sorted_users = await User.all(order_by=["last_name", "first_name"])
+
+# Get all records ordered by relationship fields
+books = await Book.all(order_by="author.name")
+
+# Get the first record 
+user = await User.first()
+
+# Get the most recently created user
+newest_user = await User.first(order_by="-created_at")
+
+# Get a limited number of records
+recent_users = await User.limit(10)
+
+# Get a limited number of records with ordering
+top_products = await Product.limit(5, order_by="-sales")
+```
+
+## Enhanced Relationship Handling
+
+Using the models defined earlier, here's how to work with relationships:
+
+```python
+# Load all relationships automatically
+post = await Post.select({"id": 1}, include_relationships=True)
+print(post.user.username)  # Access related objects directly
+
+# Load specific relationships
+post = await Post.get_with_related(1, ["user", "comments"])
+
+# Load relationships after fetching
+post = await Post.select({"id": 1})
+await post.load_related(["user", "comments"])
+
+# Insert with related objects in a single transaction
+new_post = await Post.insert_with_related({
+    "title": "My Post",
+    "content": "Content here",
+    "user": {"username": "john_doe"}
+})
+
+# Convert to dictionary with nested relationships
+post_dict = post.to_dict(include_relationships=True, max_depth=2)
+```
+
+## Automatic Relationship Detection
+
+The package can automatically detect and set up bidirectional relationships between models:
+
+```python
+class User(EasyModel, table=True):
+    username: str
+
+class Post(EasyModel, table=True):
+    title: str
+    user_id: int = Field(foreign_key="user.id")
+
+# After init_db():
+# - post.user relationship is automatically available
+# - user.posts relationship is automatically available
+```
+
+## Database Configuration
+
+```python
+# SQLite Configuration
+db_config.configure_sqlite("database.db")
+db_config.configure_sqlite(":memory:")  # In-memory database
+
+# PostgreSQL Configuration
+db_config.configure_postgres(
+    user="your_user",
+    password="your_password",
+    host="localhost",
+    port="5432",
+    database="your_database"
+)
+
+# Custom Connection URL
+db_config.set_connection_url("postgresql+asyncpg://user:password@localhost:5432/database")
+```
+
+## Documentation
+
+For more detailed documentation, please visit the [GitHub repository](https://github.com/puntorigen/easy_model) or refer to the [DOCS.md](https://github.com/puntorigen/easy_model/blob/main/DOCS.md) file.
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.

async_easy_model-0.2.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+async_easy_model/__init__.py,sha256=A0U-LtrK9tjK-b94oDNJyc3XFmmnjQAHXP7Bs-FHx18,1642
+async_easy_model/auto_relationships.py,sha256=VetxcrOdKGGSImTiysRFR8PSOSlo50RqnVG95CLe8Jg,22433
+async_easy_model/migrations.py,sha256=rYDGCGlruSugAmPfdIF2-uhyG6UvC_2qbF3BXJ084qI,17803
+async_easy_model/model.py,sha256=TUTTLP47YWCdlsrsyf-7HmMAhPdlvTNZG416pA7UfCo,52958
+async_easy_model/relationships.py,sha256=vR5BsJpGaDcecCcNlg9-ouZfxFXFQv5kOyiXhKp_T7A,3286
+async_easy_model-0.2.2.dist-info/LICENSE,sha256=uwDkl6oHbRltW7vYKNc4doJyhtwhyrSNFFlPpKATwLE,1072
+async_easy_model-0.2.2.dist-info/METADATA,sha256=QcX4beoXLL0fbPJ8ZVMAL4Q5QlXGgJfb4jjSjPx3Yqw,9474
+async_easy_model-0.2.2.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
+async_easy_model-0.2.2.dist-info/top_level.txt,sha256=e5_47sGmJnyxz2msfwU6C316EqmrSd9RGIYwZyWx68E,17
+async_easy_model-0.2.2.dist-info/RECORD,,