fastapi-sqlalchemy-ease 0.1.0__tar.gz

fastapi_sqlalchemy_ease-0.1.0/PKG-INFO

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: fastapi-sqlalchemy-ease
+Version: 0.1.0
+Summary: A reusable SQLAlchemy extension for FastAPI
+Requires-Python: >=3.8
+Requires-Dist: sqlalchemy>=2.0.0
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

fastapi_sqlalchemy_ease-0.1.0/README.md

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

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease/__init__.py

@@ -0,0 +1,12 @@
+from .core import SQLAlchemy
+from .exceptions import DatabaseError, DatabaseNotInitializedError
+
+__version__='0.1.0'
+
+# when someone call: from fastapi_sqlalchemy import SQLAlchemy
+# only these things are available
+__all__ = [
+    "SQLAlchemy",
+    "DatabaseError",
+    "DatabaseNotInitializedError",
+] 

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease/core.py

@@ -0,0 +1,143 @@
+from sqlalchemy import (
+    create_engine,
+    Column, Integer, String, Text, Float, Boolean, 
+    Date, DateTime, Time,
+    JSON, LargeBinary, 
+    Numeric,
+    ForeignKey,
+    UniqueConstraint, CheckConstraint,
+    Index, Table
+)
+from sqlalchemy.orm import declarative_base, sessionmaker, Session, relationship
+from typing import Generator, Optional
+from .exceptions import DatabaseNotInitializedError
+
+
+class SQLAlchemy:
+    # Singleton - ensures only one instance exists in the app
+    _instance = None
+
+    # All sqlalchemy types as class attributes
+    '''Data types'''
+    Column = Column
+    String = String
+    Integer = Integer
+    Float = Float
+    Boolean = Boolean
+    Text = Text
+    Date = Date
+    DateTime = DateTime
+    Time = Time
+    JSON = JSON
+    LargeBinary = LargeBinary
+    Numeric = Numeric
+
+    '''Relationships and Constraints'''
+    ForeignKey = ForeignKey
+    UniqueConstraint = UniqueConstraint
+    CheckConstraint = CheckConstraint
+    Index = Index
+    Table = Table
+    relationship = relationship
+
+    def __new__(cls):
+        if cls._instance is None:
+            cls._instance = super().__new__(cls)
+        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
+
+
+    def init_app(self, DATABASE_URI: str, connect_args: Optional[dict]=None):
+        '''
+        Docstring for init_app
+        
+        used to Initialized database.
+
+        DATABASE_URI: database url, type : string
+        connect_args: used only when initializing sqlite db
+        '''
+
+        engine_kwargs={}
+
+        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
+
+        # Engine connection to database
+        self.engine = create_engine(DATABASE_URI, **engine_kwargs)
+
+        # 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()
+
+        self._initialized = True
+
+
+    @property
+    def Model(self):
+        '''
+        Docstring for Model
+        
+        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
+    
+
+    def create_all(self):
+        '''
+        Docstring for create_all
+        
+        create all tables in the database
+        '''
+
+        if not self._initialized:
+            raise DatabaseNotInitializedError('Database not Intialized, call db.init_app() first.')
+        
+        self._Model.metadata.create_all(self.engine)
+
+
+    def drop_all(self):
+        '''
+        Docstring for drop_all
+        
+        delete all tables from the database.
+        '''
+        if not self._initialized:
+            raise DatabaseNotInitializedError('Database not Intialized, call db.init_app() first.')
+
+        self._Model.metadata.drop_all(self.engine)
+
+
+    def Session(self) -> Generator[Session, None, None]:
+        '''
+        Docstring for Session
+        
+        creates a new session per request.
+        must use with Depends in FastAPI().
+        Auto closes sessions after request is done.
+
+        '''
+
+        if not self._initialized:
+            raise DatabaseNotInitializedError('Database not Intialized, call db.init_app() first.')
+            
+        session = self._SessionLocal()
+        try:
+            yield session # Give session to the route
+        finally:
+            session.close() #always close after one requst

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease/exceptions.py

@@ -0,0 +1,7 @@
+class DatabaseError(Exception):
+    """Base error - all other errors inherit from this"""
+    pass
+
+class DatabaseNotInitializedError(DatabaseError):
+    """Raised when someone uses db before calling init_app()"""
+    pass

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

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: fastapi-sqlalchemy-ease
+Version: 0.1.0
+Summary: A reusable SQLAlchemy extension for FastAPI
+Requires-Python: >=3.8
+Requires-Dist: sqlalchemy>=2.0.0
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+pyproject.toml
+setup.py
+fastapi_sqlalchemy_ease/__init__.py
+fastapi_sqlalchemy_ease/core.py
+fastapi_sqlalchemy_ease/exceptions.py
+fastapi_sqlalchemy_ease.egg-info/PKG-INFO
+fastapi_sqlalchemy_ease.egg-info/SOURCES.txt
+fastapi_sqlalchemy_ease.egg-info/dependency_links.txt
+fastapi_sqlalchemy_ease.egg-info/requires.txt
+fastapi_sqlalchemy_ease.egg-info/top_level.txt

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease.egg-info/requires.txt

@@ -0,0 +1 @@
+sqlalchemy>=2.0.0

fastapi_sqlalchemy_ease-0.1.0/fastapi_sqlalchemy_ease.egg-info/top_level.txt

@@ -0,0 +1 @@
+fastapi_sqlalchemy_ease

fastapi_sqlalchemy_ease-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"

fastapi_sqlalchemy_ease-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fastapi_sqlalchemy_ease-0.1.0/setup.py

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