Skip to main content

Peewee ORM integration for Flask framework

Project description

The Flask-PW – Peewee ORM intergration for Flask framework.

The plugin configures DB connection and provides some tools such as migrations and signals. It also provides Peewee ORM support for Flask-Debugtoolbar

Requirements

  • python 2.7+,3.4+

Installation

Flask-PW should be installed using pip:

pip install flask-pw

Usage

Settings

Flask-PW settings (default values):

# Connection URI
PEEWEE_DATABASE_URI = 'sqlite:///peewee.sqlite'

# Connection params (for example for pgsql: { encoding: 'utf-8' })
PEEWEE_CONNECTION_PARAMS = {}

# Path to directory which contains migrations
PEEWEE_MIGRATIONS = 'migrations'

# Path to module which contains you applications' Models
# Needed by automatic migrations
PEEWEE_MODELS_MODULE = ''

# Models which should be ignored in migrations
PEEWEE_MODELS_IGNORE = []

# Base models class
# Use `db.Model` as your models' base class for automatically DB binding
PEEWEE_MODELS_CLASS = <flask_pw.Model>

# Don't connect to db when request starts and close when it ends automatically
PEEWEE_MANUAL = False

Example

import peewee as pw
from flask import Flask

from flask_pw import Peewee


app = Flask(__name__)

app.config['PEEWEE_DATABASE_URI'] = 'sqlite:///:memory:'

db = Peewee(app)


class User(db.Model):

    name = pw.CharField(255)
    title = pw.CharField(127, null=True)
    active = pw.BooleanField(default=True)
    rating = pw.IntegerField(default=0)


@User.post_save.connect
def update(user, created=False):
    if created:
        # Do something

Migrations

If you use Flask-Script just add ‘db’ command to your manager:

manager = Manager(create_app)
manager.add_command('db', db.manager)

And use db create, db migrate and db rollback commands.

Flask-Debugtoolbar

Just add flask_pw.debugtoolbar.PeeweeDebugPanel to Flask-Debugtoolbar panels in your application’s configuration:

DEBUG_TB_PANELS = [
    'flask_debugtoolbar.panels.versions.VersionDebugPanel',
    'flask_debugtoolbar.panels.timer.TimerDebugPanel',
    'flask_debugtoolbar.panels.headers.HeaderDebugPanel',
    'flask_debugtoolbar.panels.request_vars.RequestVarsDebugPanel',
    'flask_debugtoolbar.panels.template.TemplateDebugPanel',
    'flask_debugtoolbar.panels.sqlalchemy.SQLAlchemyDebugPanel',
    'flask_debugtoolbar.panels.logger.LoggingPanel',
    'flask_debugtoolbar.panels.profiler.ProfilerDebugPanel',

    # Add the Peewee panel
    'flask_pw.flask_debugtoolbar.PeeweeDebugPanel',
]

Enjoy!

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/flask-pw/issues

Contributing

Development of The Flask-pw happens at: https://github.com/klen/flask-pw

Contributors

License

Licensed under a MIT license (See 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-PW-0.1.4.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

Flask_PW-0.1.4-py2.py3-none-any.whl (9.6 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-PW-0.1.4.tar.gz.

File metadata

  • Download URL: Flask-PW-0.1.4.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for Flask-PW-0.1.4.tar.gz
Algorithm Hash digest
SHA256 23aedc73e0f1f095b22bb5ac6a168443bb5b7b662e25569393458d95e7f52ea4
MD5 a5d813e4b94c1c3bb92e098a68d95a98
BLAKE2b-256 a95ed0a79fe17d371534babb80fdab5bdccca31d7373980eb4c606390410506b

See more details on using hashes here.

File details

Details for the file Flask_PW-0.1.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_PW-0.1.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 67a07f72e82b15a5df2007720a943e4ba875e38114c600d6610a80763205972c
MD5 c83e2833057b62fb223fe9708e11b155
BLAKE2b-256 40f32342a2ac75edf6aa83ed405d43af01a42bb3260ef99a5f0a88369310f0d6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page