Peewee integration to Muffin framework
Project description
Muffin Peewee – Peewee ORM integration to Muffin framework.
Requirements
python >= 3.3
Installation
Muffin Peewee should be installed using pip:
pip install muffin-peewee
Usage
Add muffin_peewee to PLUGINS in your Muffin Application configuration.
Or install it manually like this:
db = muffin_peewee.Plugin(**{'options': 'here'})
app = muffin.Application('test')
app.install(db)
Options
PEEWEE_CONNECTION – connection string to your database (sqlite:///db.sqlite)
PEEWEE_CONNECTION_PARAMS – Additional params for connection ({})
PEEWEE_CONNECTION_MANUAL – Doesn’t manage db connections automatically
PEEWEE_MIGRATIONS_ENABLED – enable migrations (True)
PEEWEE_MIGRATIONS_PATH – path to migration folder (migrations)
Queries
@app.ps.peewee.register
class Test(peewee.Model):
data = peewee.CharField()
@app.register
def view(request):
return [t.data for t in Test.select()]
Manage connections
# Set configuration option `PEEWEE_CONNECTION_MANUAL` to True
# Use context manager
@app.register
def view(request):
with (yield from app.ps.peewee.manage()):
# Work with db
# ...
Migrations
Create migrations:
$ muffin example:app create [NAME] [--auto]
Run migrations:
$ muffin example:app migrate [NAME] [--fake]
Rollback migrations:
$ muffin example:app rollback NAME
Load/Dump data to CSV
Dump table test to CSV file:
$ muffin example:app csv_dump test
Load data from CSV file to table test:
$ muffin example:app csv_load test
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.
If you wish to express your appreciation for the project, you are welcome to send a postcard to:
Kirill Klenov pos. Severny 8-3 MO, Istra, 143500 Russia
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 Distributions
Built Distribution
File details
Details for the file muffin_peewee-1.1.3-py3-none-any.whl.
File metadata
- Download URL: muffin_peewee-1.1.3-py3-none-any.whl
- Upload date:
- Size: 13.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 78517eb89e20335a127f602778906a5f4cdbb41c569c321032bcd9b15013acbc |
|
| MD5 | 41614a4594dbdb597a53e9111f0a19ec |
|
| BLAKE2b-256 | 0fdc5f82bd283111e5f1ba9737e8ba21d1f5eb507f134fd78c34cefa1c543621 |
