fastapi-sqlalchemy-ease 0.1.3__tar.gz → 0.1.4__tar.gz

fastapi_sqlalchemy_ease-0.1.4/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: fastapi-sqlalchemy-ease
+Version: 0.1.4
+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.4/README.md

@@ -0,0 +1,94 @@
+# 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.3 → fastapi_sqlalchemy_ease-0.1.4}/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.4'
 
 # when someone call: from fastapi_sqlalchemy import SQLAlchemy
 # only these things are available

fastapi_sqlalchemy_ease-0.1.4/fastapi_sqlalchemy_ease.egg-info/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: fastapi-sqlalchemy-ease
+Version: 0.1.4
+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.4/setup.py

@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+from pathlib import Path
+
+# Read the contents of your README file
+this_directory = Path(__file__).parent
+long_description = (this_directory / "README.md").read_text()
+
+setup(
+    name='fastapi-sqlalchemy-ease',
+    version='0.1.4',
+    description="A reusable SQLAlchemy extension for FastAPI",
+    packages=find_packages(),
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    python_requires='>=3.8',
+    install_requires=[
+        'sqlalchemy>=2.0.0'
+    ],
+) 

fastapi_sqlalchemy_ease-0.1.3/PKG-INFO

@@ -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/README.md

@@ -1,16 +0,0 @@
-# fastapi-sqlalchemy-ease
-A reusable SQLAlchemy extension for FastAPI.
-
-## Installation
-```bash
-pip install fastapi-sqlalchemy-ease
-```
-
-## Usage
-```python
-from fastapi_sqlalchemy_ease import SQLAlchemy
-
-db = SQLAlchemy()
-DATABASE_URI = "sqlite:///site.db"
-db.init_app(DATABASE_URI)
-```

fastapi_sqlalchemy_ease-0.1.3/fastapi_sqlalchemy_ease.egg-info/PKG-INFO

@@ -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/setup.py

@@ -1,12 +0,0 @@
-from setuptools import setup, find_packages
-
-setup(
-    name='fastapi-sqlalchemy-ease',
-    version='0.1.3',
-    description="A reusable SQLAlchemy extension for FastAPI",
-    packages=find_packages(),
-    python_requires='>=3.8',
-    install_requires=[
-        'sqlalchemy>=2.0.0'
-    ],
-)