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, trio, asgi, muffin
  • Requires: Python >=3.7
Classifiers
Report project as malware

Project description

muffin-peewee – 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

Optionally you are able to install it with postgresql drivers:

pip install muffin-peewee[postgres]

Usage

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')

Options

Format: Name – Description (default value)

CONNECTION – connection string to your database (sqlite:///db.sqlite)

CONNECTION_PARAMS – Additional params for connection ({})

MANAGE_CONNECTIONS – Install a middleware to manage db connections automatically (True)

MIGRATIONS_ENABLED – Enable migrations with peewee-migrate (True)

MIGRATIONS_PATH – Set path to the migrations folder (migrations)

Queries

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


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

Manage connections

# Set configuration option `MANAGE_CONNECTIONS` to False

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

Migrations

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 https://github.com/klen/muffin-peewee/issues

Contributing

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

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