fastapi-sqlalchemy-ease 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

fastapi_sqlalchemy_ease/__init__.py

@@ -1,7 +1,7 @@
 from .core import SQLAlchemy
 from .exceptions import DatabaseError, DatabaseNotInitializedError
 
-__version__='0.1.3'
+__version__='0.1.5'
 
 # when someone call: from fastapi_sqlalchemy import SQLAlchemy
 # only these things are available

fastapi_sqlalchemy_ease/core.py

@@ -6,7 +6,8 @@ from sqlalchemy import (
     Numeric,
     ForeignKey,
     UniqueConstraint, CheckConstraint,
-    Index, Table
+    Index, Table,
+    func, and_, any_, not_, or_, select, update, delete, desc, asc
 )
 from sqlalchemy.orm import declarative_base, sessionmaker, Session, relationship
 from typing import Generator, Optional
@@ -32,6 +33,24 @@ class SQLAlchemy:
     LargeBinary = LargeBinary
     Numeric = Numeric
 
+    '''Logic and Boolean operators'''
+    and_ = and_
+    or_ = or_
+    not_ = not_
+
+    '''SQL Functions (count, now, max, min, etc.)'''
+    func = func
+
+    '''Query Execution Utilities'''
+    select = select
+    update = update
+    delete = delete
+
+    '''ordering'''
+    desc = desc
+    asc = asc
+
+
     '''Relationships and Constraints'''
     ForeignKey = ForeignKey
     UniqueConstraint = UniqueConstraint
@@ -43,18 +62,21 @@ class SQLAlchemy:
     def __new__(cls):
         if cls._instance is None:
             cls._instance = super().__new__(cls)
+            cls._instance._Model = declarative_base()
         return cls._instance
     
 
     def __init__(self):
-        # Everything starts as None Until db.init_app() is called
-        self.engine = None
-        self._SessionLocal = None
-        self._Model = None
-        self._initialized = False
+        if not hasattr(self, '_initialized_vars'):
+            # Everything starts as None Until db.init_app() is called
+            self.engine = None
+            self._SessionLocal = None
+            self.session = None 
+            self._initialized = False
+            self._initialized_vars = True
 
 
-    def init_app(self, DATABASE_URI: str, connect_args: Optional[dict]=None):
+    def init_app(self, DATABASE_URI: str, **kwargs):
         '''
         Docstring for init_app
         
@@ -64,12 +86,16 @@ class SQLAlchemy:
         connect_args: used only when initializing sqlite db
         '''
 
-        engine_kwargs={}
+        engine_kwargs={
+            "pool_pre_ping": True,
+        }
 
-        if connect_args:
-            engine_kwargs['connect_args'] = connect_args # sqlite need this
-        else:
-            engine_kwargs['pool_pre_ping'] = True # Keeps connection alive for PostgreSQL/MySQL
+        # Only add pooling if NOT using SQLite
+        if not DATABASE_URI.startswith("sqlite"):
+            engine_kwargs["pool_size"] = kwargs.get("pool_size", 10)
+            engine_kwargs["max_overflow"] = kwargs.get("max_overflow", 20)
+
+        engine_kwargs.update(kwargs)
 
         # Engine connection to database
         self.engine = create_engine(DATABASE_URI, **engine_kwargs)
@@ -77,8 +103,9 @@ class SQLAlchemy:
         # SessionLocal - Factory data creates new sessions
         self._SessionLocal = sessionmaker(autoflush=False ,bind=self.engine)
 
-        # Model - base class, all our database models will inherit from
-        self._Model = declarative_base()
+        from sqlalchemy.orm import scoped_session
+        self.session = scoped_session(self._SessionLocal)
+        self._Model.query = self.session.query_property()
 
         self._initialized = True
 
@@ -91,9 +118,6 @@ class SQLAlchemy:
         Base class for creating database models
         User writes: class User(db.Model):
         '''
-
-        if not self._initialized:
-            raise DatabaseNotInitializedError('Database not Intialized, call db.init_app() first.')
         
         return self._Model
     
@@ -136,8 +160,8 @@ class SQLAlchemy:
         if not self._initialized:
             raise DatabaseNotInitializedError('Database not Intialized, call db.init_app() first.')
             
-        session = self._SessionLocal()
+        session = self.session()
         try:
             yield session # Give session to the route
         finally:
-            session.close() #always close after one requst
+            self.session.remove() #proper cleanup for scoped sessions

fastapi_sqlalchemy_ease-0.1.5.dist-info/METADATA

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: fastapi-sqlalchemy-ease
+Version: 0.1.5
+Summary: A reusable SQLAlchemy extension for FastAPI
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: sqlalchemy>=2.0.0
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# fastapi-sqlalchemy-ease  
+  
+fastapi-sqlalchemy-ease is a singleton-based SQLAlchemy extension for FastAPI. It provides a centralized interface for database initialization, model declaration, and session management, inspired by the simplicity of Flask-SQLAlchemy.  
+  
+## ◽ Key Features  
+  
+- Singleton Design: Ensures a single database instance across your entire FastAPI application.  
+  
+- Consolidated API: Access all SQLAlchemy types (Integer, String, ForeignKey, etc.) directly from the db object.  
+  
+- Auto-Cleanup: Includes a generator-based session handler designed for FastAPI's Depends to ensure sessions are always closed.  
+  
+- Built-in Lifecycle Management: Simple methods for create_all() and drop_all().  
+  
+  
+## ◽ Installation  
+  
+pip install fastapi-sqlalchemy-ease  
+  
+
+
+## ◽ Usage Guide  
+  
+### 1. Basic setup  
+Initialize your database instance in a centralized file (e.g. database.py).  
+  
+
+    from fastapi_sqlalchemy_ease import SQLAlchemy  
+
+    '''Create the singleton instance''' 
+    db = SQLAlchemy()  
+
+    '''Initialize with your URI'''  
+    DATABASE_URI = "sqlite:///./test.db"  
+
+    '''Use connect_args={"check_same_thread": False} for SQLite'''  
+    db.init_app(DATABASE_URI, connect_args={"check_same_thread": False})  
+  
+  
+  
+### 2. Defining Models  
+No need to import types from SQLAlchemy; use the db instance directly.  
+  
+    class User(db.Model):  
+        __tablename__ = "users"  
+
+        id = db.Column(db.Integer, primary_key=True)  
+        username = db.Column(db.String, unique=True, nullable=False)  
+        created_at = db.Column(db.DateTime)  
+  
+  
+  
+### 3. Creating Tables  
+You can trigger table creation easily.  
+  
+    db.create_all()  
+  
+  
+  
+### 3. Database Operations in Routes  
+Use db.Session with FastAPI's Depends to get a clean session for every request.  
+  
+    from fastapi import FastAPI, Depends  
+    from .. import db  
+
+    app = FastAPI()  
+    
+    @app.get("/users")  
+    def read_users(session: Session = Depends(db.Session)):  
+        users = session.query(User).all()  
+        return users  
+  
+  
+  
+## ◽ Available Attributes  
+Your db instance provides easy access to standard SQLAlchemy types and constraints:  
+  
+Category - Available Attributes  
+
+Data Types	-  String, Integer, Float, Boolean, Text, Date, DateTime, JSON, Numeric  
+Constraints	- ForeignKey, UniqueConstraint, CheckConstraint, Index  
+ORM	- relationship, Table, Column  
+  
+  
+  
+## ◽ Error Handling
+The library includes a DatabaseNotInitializedError. If you attempt to access db.Model, db.Session, or lifecycle methods before calling db.init_app(), a clear exception will be raised to help you debug quickly.  
+  
+
+  
+## 📄 License
+Distributed under the MIT License.  
+
+--

fastapi_sqlalchemy_ease-0.1.5.dist-info/RECORD

@@ -0,0 +1,8 @@
+fastapi_sqlalchemy_ease/__init__.py,sha256=bJALhusgwO6bgq3Y1y9FwT1TfSiRYO4zh10SlFK-D8s,303
+fastapi_sqlalchemy_ease/core.py,sha256=Uc6rbLLZ6gTCetkzX0a9VqVvafJQm5eyTOw_02dIM1g,4470
+fastapi_sqlalchemy_ease/exceptions.py,sha256=6YU6mJvOGXC9D0mPH99GjMWpj21NA5jD8II7DWEcHaA,222
+fastapi_sqlalchemy_ease-0.1.5.dist-info/licenses/LICENSE,sha256=jVnW2ZK4LFNHmDZE-xj0EyVpbHVMpwO7FcTk_We8qrA,1068
+fastapi_sqlalchemy_ease-0.1.5.dist-info/METADATA,sha256=2XnxNnRUxd7Ge_TKeDGCM7c_Yhs7l1N6SvJU4kFNceU,3144
+fastapi_sqlalchemy_ease-0.1.5.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+fastapi_sqlalchemy_ease-0.1.5.dist-info/top_level.txt,sha256=Y9kRilavMJot8bwOZymZ0cRjiBNIzsVqx9EwvXGiq-8,24
+fastapi_sqlalchemy_ease-0.1.5.dist-info/RECORD,,

fastapi_sqlalchemy_ease-0.1.3.dist-info/METADATA

@@ -1,11 +0,0 @@
-Metadata-Version: 2.4
-Name: fastapi-sqlalchemy-ease
-Version: 0.1.3
-Summary: A reusable SQLAlchemy extension for FastAPI
-Requires-Python: >=3.8
-License-File: LICENSE
-Requires-Dist: sqlalchemy>=2.0.0
-Dynamic: license-file
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary

fastapi_sqlalchemy_ease-0.1.3.dist-info/RECORD

@@ -1,8 +0,0 @@
-fastapi_sqlalchemy_ease/__init__.py,sha256=rUUx_WPD1D830v7DpNSh_3_CsbJNMeJHHSBMF7GJLvs,303
-fastapi_sqlalchemy_ease/core.py,sha256=nQSzioMp6TiD7yuKD7niImA2BSL2PQLCKnCzk0eFWrA,3920
-fastapi_sqlalchemy_ease/exceptions.py,sha256=6YU6mJvOGXC9D0mPH99GjMWpj21NA5jD8II7DWEcHaA,222
-fastapi_sqlalchemy_ease-0.1.3.dist-info/licenses/LICENSE,sha256=jVnW2ZK4LFNHmDZE-xj0EyVpbHVMpwO7FcTk_We8qrA,1068
-fastapi_sqlalchemy_ease-0.1.3.dist-info/METADATA,sha256=LE0IDLlbyKIsWgRhyw5Jpo8p4HoKOwlif_AVJ8_zPkw,285
-fastapi_sqlalchemy_ease-0.1.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-fastapi_sqlalchemy_ease-0.1.3.dist-info/top_level.txt,sha256=Y9kRilavMJot8bwOZymZ0cRjiBNIzsVqx9EwvXGiq-8,24
-fastapi_sqlalchemy_ease-0.1.3.dist-info/RECORD,,