Peewee integration for Muffin framework
Project description
muffin-peewee-aio – Peewee ORM integration to Muffin framework.
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[sqlite] $ pip install muffin-peewee-aio[postgresql] $ pip install muffin-peewee-aio[mysql]
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
@db.register
class Test(peewee.Model):
data = peewee.CharField()
@app.route('/')
async def view(request):
return [t.data async for t in db.manager.run(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 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-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.
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
File details
Details for the file muffin-peewee-aio-0.0.3.tar.gz.
File metadata
- Download URL: muffin-peewee-aio-0.0.3.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | cfc9855317ca295380a0d1d09658597b76a9d9e58afd399041e605225b946e6c |
|
| MD5 | ff89e0fd2768c8812c009be8faefa0bc |
|
| BLAKE2b-256 | a4aa09e0c7cbd1f6ad4d3a2eb4bed630b54c4b9b0157b1ae499c23fc3b877afc |
File details
Details for the file muffin_peewee_aio-0.0.3-py3-none-any.whl.
File metadata
- Download URL: muffin_peewee_aio-0.0.3-py3-none-any.whl
- Upload date:
- Size: 6.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9ecd747ea5db0b287708b46cce73562789d6889edcb46b302497c1c8712e062e |
|
| MD5 | d572630fb351ef4ace7718fabe11022c |
|
| BLAKE2b-256 | 3eb93f5b3538cd65d78c4647fafbfe5ad7466c8f171420d8a7dd562ce9f02f6f |
