Peewee integration to Muffin framework
Project description
Muffin Peewee – Peewee ORM integration to Muffin framework.
Requirements
python >= 3.5.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
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 Distributions
Built Distribution
Hashes for muffin_peewee-1.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bbd726b10ede68cc15e6608e2e7025b5bcac1a41613233088865b53c9ce5c6b2 |
|
MD5 | 164691a840d57ad2b3f68c70c71191bd |
|
BLAKE2b-256 | 20980b1535ff3b44678eb0e4d232b261e1bc76c29f58051c5db3878be585044f |