muffin-sqlalchemy 0.0.4

No project description provided

Muffin-SqlAlchemy – A simple sqlalchemy helper plugin for muffin framework.

Requirements

• python >= 3.4
• muffin >= 0.5.5

Installation

Muffin-SqlAlchemy should be installed using pip:

pip install muffin-sqlalchemy

Usage

Add muffin-sqlalchemy to muffin plugin list:

import muffin


app = muffin.Application(
    'example',

    PLUGINS=(
        'muffin_sqlalchemy',
    )
)

And use sqlalchemy session in request object:

@app.register('/foo')
class Example(muffin.Handler):

    @asyncio.coroutine
    def post(self, request):
        foo = FooModel(name='foo')
        session = request.sqlalchemy_session
        session.add(foo)
        session.commit()
        return 'Ok'

Options

SQLALCHEMY_DATABASE_URI

URI of database (sqlite:///muffin.db)

Commands

The plugin adds some commands to your Muffin application.

Create Databse

Create all tables in database according to you engine:

$ muffin app_module create_databse

to work fine inherit from muffin_sqalchemy.SqlAlchemyDeclarativeBase to create yours sqlalchemy models

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/drgarcia1986/muffin-sqlalchemy/issues

Contributing

Development of Muffin-SqlAlchemy happens at: https://github.com/drgarcia1986/muffin-sqlalchemy

Contributors

• drgarcia1986 (Diego Garcia)

License

Licensed under a MIT license.