Peewee integration for Muffin framework
Project description
muffin-peewee – Peewee ORM integration to Muffin framework.
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
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:
PEEWEE_CONNECTION = 'DB_URL'
Muffin.Application configuration options are case insensitive
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.
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.
Source Distribution
Built Distribution
Hashes for muffin_peewee-1.7.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64d913a21a2b017117ee97645463a92e82e894f025cb42a9f7924dd1ab373075 |
|
MD5 | 7c14e8ca3a6994fd9a149282fd6ed09c |
|
BLAKE2b-256 | 0082c6bbaa045394292731933f54b854d2b085978f65c85a95d4682eae175f61 |