Skip to main content

Peewee integration for Muffin framework

Project description

muffin-peeweePeewee ORM integration to Muffin framework.

Tests Status PYPI Version Python Versions


  • python >= 3.7


Muffin Peewee should be installed using pip:

pip install muffin-peewee

Optionally you are able to install it with postgresql drivers:

pip install muffin-peewee[postgres]


from muffin import Application
from muffin_peewee import Plugin as Peewee

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

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


Name Default value Desctiption
CONNECTION sqlite+async:///db.sqlite Database URL
CONNECTION_PARAMS {} Additional params for DB connection
MANAGE_CONNECTIONS True Install a middleware to aquire db connections automatically
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:


Muffin.Application configuration options are case insensitive


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

async def view(request):
    return [ for t in]

Manage connections

# Set configuration option `MANAGE_CONNECTIONS` to False

# Use context manager
async def view(request):
    async with db:
        # Work with db
        # ...


Create migrations:

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

Run migrations:

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

Rollback migrations:

$ muffin example:app pw_rollback [NAME]

List migrations:

$ muffin example:app pw_list

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at


Development of Muffin Peewee happens at:


  • klen (Kirill Klenov)


Licensed under a MIT license.

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for muffin-peewee, version 1.11.0
Filename, size File type Python version Upload date Hashes
Filename, size muffin_peewee-1.11.0-py3-none-any.whl (6.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size muffin-peewee-1.11.0.tar.gz (6.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page