fastapi-repository 0.0.1__tar.gz → 0.0.2__tar.gz

{fastapi_repository-0.0.1 → fastapi_repository-0.0.2}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: fastapi-repository
-Version: 0.0.1
+Version: 0.0.2
 Summary: A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record and Ransack.
-Author-email: Seiya Takeda <takedaseiya@gmail.com>
+Author-email: Peter Seiya Takahashi <seiya4@icloud.com>
 Project-URL: Homepage, https://github.com/seiyat/fastapi-repository
 Project-URL: Bug Tracker, https://github.com/seiyat/fastapi-repository/issues
 Classifier: Programming Language :: Python :: 3
@@ -15,7 +15,15 @@ Requires-Dist: fastapi>=0.70.0
 
 # FastAPI Repository
 
-A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record and Ransack.
+A base repository for FastAPI projects, inspired by Ruby on Rails' [Active Record](https://github.com/rails/rails/tree/main/activerecord) and [Ransack](https://github.com/activerecord-hackery/ransack). It provides a simple, intuitive interface for data access in asynchronous applications using SQLAlchemy.
+
+## Features
+
+- **Async-first:** Designed for modern asynchronous Python.
+- **Simple CRUD:** `find`, `create`, `update`, `destroy` methods out of the box.
+- **Powerful Filtering:** Use Ransack-style operators (`__icontains`, `__gt`, etc.) for complex queries.
+- **Eager & Lazy Loading:** Control relationship loading with `joinedload` and `lazyload`.
+- **Default Scoping:** Apply default conditions to all queries.
 
 ## Installation
 
@@ -23,7 +31,7 @@ A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record
 pip install fastapi-repository
 ```
 
-## Usage
+## Quick Start
 
 ```python
 from fastapi_repository import BaseRepository
@@ -34,3 +42,7 @@ class UserRepository(BaseRepository):
     def __init__(self, session: AsyncSession):
         super().__init__(session, model=User)
 ```
+
+## Documentation
+
+For a complete guide, including all available methods, advanced filtering, and default scoping, please see the [full documentation](https://github.com/PeterTakahashi/fastapi-repository/blob/main/docs/index.md).

fastapi_repository-0.0.2/README.md

@@ -0,0 +1,33 @@
+# FastAPI Repository
+
+A base repository for FastAPI projects, inspired by Ruby on Rails' [Active Record](https://github.com/rails/rails/tree/main/activerecord) and [Ransack](https://github.com/activerecord-hackery/ransack). It provides a simple, intuitive interface for data access in asynchronous applications using SQLAlchemy.
+
+## Features
+
+- **Async-first:** Designed for modern asynchronous Python.
+- **Simple CRUD:** `find`, `create`, `update`, `destroy` methods out of the box.
+- **Powerful Filtering:** Use Ransack-style operators (`__icontains`, `__gt`, etc.) for complex queries.
+- **Eager & Lazy Loading:** Control relationship loading with `joinedload` and `lazyload`.
+- **Default Scoping:** Apply default conditions to all queries.
+
+## Installation
+
+```bash
+pip install fastapi-repository
+```
+
+## Quick Start
+
+```python
+from fastapi_repository import BaseRepository
+from sqlalchemy.ext.asyncio import AsyncSession
+from .models import User
+
+class UserRepository(BaseRepository):
+    def __init__(self, session: AsyncSession):
+        super().__init__(session, model=User)
+```
+
+## Documentation
+
+For a complete guide, including all available methods, advanced filtering, and default scoping, please see the [full documentation](https://github.com/PeterTakahashi/fastapi-repository/blob/main/docs/index.md).

{fastapi_repository-0.0.1 → fastapi_repository-0.0.2}/fastapi_repository/base.py

@@ -7,20 +7,20 @@ from sqlalchemy import func, update, delete
 from typing import Optional, List, Union, Dict, Any
 
 OPERATORS = {
-    # 完全一致
+    # Exact match
     "exact": lambda col, val: col == val,
     "iexact": lambda col, val: col.ilike(val),
-    # 部分一致
+    # Partial match
     "contains": lambda col, val: col.contains(val),
     "icontains": lambda col, val: col.ilike(f"%{val}%"),
-    # in句
+    # IN clause
     "in": lambda col, val: col.in_(val) if isinstance(val, list) else col.in_([val]),
-    # 大小比較
+    # Comparison operators
     "gt": lambda col, val: col > val,
     "gte": lambda col, val: col >= val,
     "lt": lambda col, val: col < val,
     "lte": lambda col, val: col <= val,
-    # 前方・後方一致
+    # Starts/ends with
     "startswith": lambda col, val: col.startswith(val),
     "istartswith": lambda col, val: col.ilike(f"{val}%"),
     "endswith": lambda col, val: col.endswith(val),
@@ -210,7 +210,7 @@ class BaseRepository:
 
     def _apply_order_by(self, query, sorted_by: str, sorted_order: str):
         """
-        クエリに対して order_by を適用するヘルパー。
+        Helper to apply order_by to a query.
         """
         column = getattr(self.model, sorted_by, None)
         if not column:
@@ -231,14 +231,14 @@ class BaseRepository:
         """
         conditions = []
         for key, value in search_params.items():
-            # keyに "__" が含まれていれば、フィールド名と演算子を分割する
+            # If "__" is included in the key, split into field name and operator
             if "__" in key:
                 parts = key.split("__")
                 op = "exact"
-                if parts[-1] in OPERATORS:  # 末尾が演算子なら取り除く
+                if parts[-1] in OPERATORS:  # If the last part is an operator, remove it
                     op = parts.pop()
 
-                # 単純カラム: foo__icontains=bar
+                # Simple column: foo__icontains=bar
                 if len(parts) == 1:
                     column = getattr(self.model, parts[0], None)
                     if column is None:
@@ -248,7 +248,7 @@ class BaseRepository:
                     conditions.append(OPERATORS[op](column, value))
                     continue
 
-                # 1ホップのリレーション: rel__field__op=value
+                # One-hop relationship: rel__field__op=value
                 rel_attr = getattr(self.model, parts[0], None)
                 if rel_attr is None or not hasattr(rel_attr, "property"):
                     raise AttributeError(
@@ -263,7 +263,7 @@ class BaseRepository:
                 conditions.append(rel_attr.any(OPERATORS[op](target_column, value)))
                 continue
             else:
-                # "__"が含まれていない場合は eq (=) 比較とみなす
+                # If "__" is not included, treat as simple eq (=) comparison
                 column = getattr(self.model, key, None)
                 if column is None:
                     raise AttributeError(
@@ -271,8 +271,6 @@ class BaseRepository:
                     )
                 conditions.append(column == value)
 
-        return conditions
-
     async def create(self, **create_params):
         """
         Generic create method that instantiates the model,

{fastapi_repository-0.0.1 → fastapi_repository-0.0.2}/fastapi_repository.egg-info/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: fastapi-repository
-Version: 0.0.1
+Version: 0.0.2
 Summary: A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record and Ransack.
-Author-email: Seiya Takeda <takedaseiya@gmail.com>
+Author-email: Peter Seiya Takahashi <seiya4@icloud.com>
 Project-URL: Homepage, https://github.com/seiyat/fastapi-repository
 Project-URL: Bug Tracker, https://github.com/seiyat/fastapi-repository/issues
 Classifier: Programming Language :: Python :: 3
@@ -15,7 +15,15 @@ Requires-Dist: fastapi>=0.70.0
 
 # FastAPI Repository
 
-A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record and Ransack.
+A base repository for FastAPI projects, inspired by Ruby on Rails' [Active Record](https://github.com/rails/rails/tree/main/activerecord) and [Ransack](https://github.com/activerecord-hackery/ransack). It provides a simple, intuitive interface for data access in asynchronous applications using SQLAlchemy.
+
+## Features
+
+- **Async-first:** Designed for modern asynchronous Python.
+- **Simple CRUD:** `find`, `create`, `update`, `destroy` methods out of the box.
+- **Powerful Filtering:** Use Ransack-style operators (`__icontains`, `__gt`, etc.) for complex queries.
+- **Eager & Lazy Loading:** Control relationship loading with `joinedload` and `lazyload`.
+- **Default Scoping:** Apply default conditions to all queries.
 
 ## Installation
 
@@ -23,7 +31,7 @@ A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record
 pip install fastapi-repository
 ```
 
-## Usage
+## Quick Start
 
 ```python
 from fastapi_repository import BaseRepository
@@ -34,3 +42,7 @@ class UserRepository(BaseRepository):
     def __init__(self, session: AsyncSession):
         super().__init__(session, model=User)
 ```
+
+## Documentation
+
+For a complete guide, including all available methods, advanced filtering, and default scoping, please see the [full documentation](https://github.com/PeterTakahashi/fastapi-repository/blob/main/docs/index.md).

{fastapi_repository-0.0.1 → fastapi_repository-0.0.2}/pyproject.toml

@@ -4,9 +4,9 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "fastapi-repository"
-version = "0.0.1"
+version = "0.0.2"
 authors = [
-  { name="Seiya Takeda", email="takedaseiya@gmail.com" },
+  { name="Peter Seiya Takahashi", email="seiya4@icloud.com" },
 ]
 description = "A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record and Ransack."
 readme = "README.md"

fastapi_repository-0.0.1/README.md

@@ -1,21 +0,0 @@
-# FastAPI Repository
-
-A base repository for FastAPI projects, inspired by Ruby on Rails' Active Record and Ransack.
-
-## Installation
-
-```bash
-pip install fastapi-repository
-```
-
-## Usage
-
-```python
-from fastapi_repository import BaseRepository
-from sqlalchemy.ext.asyncio import AsyncSession
-from .models import User
-
-class UserRepository(BaseRepository):
-    def __init__(self, session: AsyncSession):
-        super().__init__(session, model=User)
-```