Metadata-Version: 1.0
Name: sqla-paranoid
Version: 0.1.1
Summary: Brings transparent soft delete to SQLAlchemy ORM
Home-page: UNKNOWN
Author: jean-philippe serafin
Author-email: serafinjp@gmail.com
License: MIT
Description: Paranoid
        ========
        
        Brings transparent soft delete to SQLAlchemy ORM.
        
        .. image:: https://travis-ci.org/jeanphix/sqla-paranoid.svg?branch=dev
           :target: https://travis-ci.org/jeanphix/sqla-paranoid
           :alt: Build Status
        
        
        Installation
        ------------
        
        .. code-block:: bash
        
            pip install sqla-paranoid
        
        
        Usage
        -----
        
        .. code-block:: python
        
            from paranoid.models import (
                Model,
                Query,
                Session,
            )
        
            class User(Model):
                __tablename__ = 'user'
                __softdelete__ = True
        
                id = Column(Integer, primary_key=True)
                name = Column(String)
        
        
            engine = create_engine('sqlite://')
            session = sessionmaker(engine, class_=Session, query_cls=Query)()
        
            session.query(User)
        
        
        Flask
        -----
        
        Paranoid comes with a ready to use ``Flask`` extension built
        on top of Flask-SQLAlchemy:
        
        
        .. code-block:: python
        
            from paranoid.flask import SQLAlchemy
        
        
            db = SQLAlchemy(app)
        
            Model = db.Model
        
        
            class User(Model):
                __softdelete__ = True
        
                id = Column(Integer, primary_key=True)
                name = Column(String)
        
            User.query
        
Platform: UNKNOWN
