Peewee integration for Muffin framework

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for klen from gravatar.com klen

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Kirill Klenov
  • Tags peewee, sql, asyncio, muffin
  • Requires: Python >=3.7
Classifiers
Report project as malware

Project description

muffin-peewee-aio – Peewee ORM integration to Muffin framework.

Tests Status PYPI Version Python Versions

Requirements

  • python >= 3.7

Installation

Muffin Peewee should be installed using pip:

$ pip install muffin-peewee-aio

You can install optional database drivers with:

$ pip install muffin-peewee-aio[aiosqlite]
$ pip install muffin-peewee-aio[aiopg]
$ pip install muffin-peewee-aio[asyncpg]
$ pip install muffin-peewee-aio[aiomysql]

Usage

from muffin import Application
from muffin_peewee import Plugin as Peewee

# Create Muffin Application
app = Application('example')

# Initialize the plugin
# As alternative: db = Peewee(app, **options)
db = Peewee()
db.setup(app, PEEWEE_CONNECTION='postgresql://postgres:postgres@localhost:5432/database')

Options

Name

Default value

Desctiption

CONNECTION

sqlite:///db.sqlite

Database URL

CONNECTION_PARAMS

{}

Additional params for DB connection

AUTO_CONNECTION

True

Automatically get a connection from db for a request

AUTO_TRANSACTION

True

Automatically wrap a request into a transaction

MIGRATIONS_ENABLED

True

Enable migrations with

MIGRATIONS_PATH

"migrations"

Set path to the migrations folder

You are able to provide the options when you are initiliazing the plugin:

db.setup(app, connection='DB_URL')

Or setup it inside Muffin.Application config using the PEEWEE_ prefix:

PEEWEE_CONNECTION = 'DB_URL'

Muffin.Application configuration options are case insensitive

Queries

class Test(db.Model):
    data = peewee.CharField()


@app.route('/')
async def view(request):
    return [t.data async for t in Test.select()]

Manage connections

# Set configuration option `MANAGE_CONNECTIONS` to False

# Use context manager
@app.route('/')
async def view(request):
    # Aquire a connection
    async with db.manager.connection():
        # Work with db
        # ...

Migrations

Create migrations:

$ muffin example:app peewee_create [NAME] [--auto]

Run migrations:

$ muffin example:app peewee_migrate [NAME] [--fake]

Rollback migrations:

$ muffin example:app peewee_rollback [NAME]

List migrations:

$ muffin example:app peewee_list

Clear migrations from DB:

$ muffin example:app peewee_clear

Merge migrations:

$ muffin example:app peewee_merge

Bug tracker

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

Contributing

Development of Muffin Peewee happens at: https://github.com/klen/muffin-peewee-aio

Contributors

  • klen (Kirill Klenov)

License

Licensed under a MIT license.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page