{ "info": { "author": "Keigo Hattori", "author_email": "keigoht@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Software Development :: Libraries :: Python Modules", "Topic :: Software Development :: Testing", "Topic :: Utilities" ], "description": "The Flask-PW3\n##############\n\n.. _badges:\n\n.. .. image:: http://img.shields.io/travis/klen/falsk-pw.svg?style=flat-square\n .. :target: http://travis-ci.org/klen/falsk-pw\n .. :alt: Build Status\n\n.. .. image:: http://img.shields.io/pypi/v/flask-pw3.svg?style=flat-square\n .. :target: https://pypi.python.org/pypi/flask-pw3\n .. :alt: Version\n\n.. .. image:: http://img.shields.io/pypi/dm/flask-pw3.svg?style=flat-square\n .. :target: https://pypi.python.org/pypi/flask-pw3\n .. :alt: Downloads\n\n.. _description:\n\nForked from https://github.com/klen/flask-pw , can be used with peewee 3.x.\n\n\nThe Flask-PW3 -- Peewee_ ORM intergration for Flask_ framework.\n\nThe plugin configures DB connection and provides some tools such as migrations\nand signals. It also provides Peewee_ ORM support for Flask-Debugtoolbar_\n\n.. _contents:\n\n.. contents::\n\nRequirements\n=============\n\n- python 2.7+,3.4+\n- peewee 3+\n\n.. _installation:\n\nInstallation\n=============\n\n**Flask-PW3** should be installed using pip: ::\n\n pip install flask-pw3\n\n.. _usage:\n\nUsage\n=====\n\nSettings\n--------\n\nFlask-PW3 settings (default values): ::\n\n # Connection URI\n PEEWEE_DATABASE_URI = 'sqlite:///peewee.sqlite'\n\n # Connection params (for example for pgsql: { encoding: 'utf-8' })\n PEEWEE_CONNECTION_PARAMS = {}\n\n # Path to directory which contains migrations\n PEEWEE_MIGRATE_DIR = 'migrations'\n\n # Name of database table with migrations\n PEEWEE_MIGRATE_TABLE = 'migratehistory'\n\n # Path to module which contains you applications' Models\n # Needed by automatic migrations\n PEEWEE_MODELS_MODULE = ''\n\n # Models which should be ignored in migrations\n PEEWEE_MODELS_IGNORE = []\n\n # Base models class\n # Use `db.Model` as your models' base class for automatically DB binding \n PEEWEE_MODELS_CLASS = \n\n # Don't connect to db when request starts and close when it ends automatically\n PEEWEE_MANUAL = False\n\n\nExample\n-------\n\n::\n\n import peewee as pw\n from flask import Flask\n\n from flask_pw import Peewee\n\n\n app = Flask(__name__)\n\n app.config['PEEWEE_DATABASE_URI'] = 'sqlite:///:memory:'\n\n db = Peewee(app)\n\n\n class User(db.Model):\n\n name = pw.CharField(255)\n title = pw.CharField(127, null=True)\n active = pw.BooleanField(default=True)\n rating = pw.IntegerField(default=0)\n\n\n @User.post_save.connect\n def update(user, created=False):\n if created:\n # Do something\n\n\nMigrations\n----------\n\nIf you use `Flask-Script` just add 'db' command to your manager: ::\n\n manager = Manager(create_app)\n manager.add_command('db', db.manager)\n\nAnd use `db create`, `db migrate` and `db rollback` commands.\n\nIf you use `Flask >= 0.11` connect the plugin's command to your CLI: ::\n\n pw = Peewee(app)\n app.cli.add_command(pw.cli, 'db')\n\n\n::\n\n if __name__ == '__main__':\n with app.app_context():\n app.cli()\n\n\n\nFlask-Debugtoolbar\n------------------\n\nJust add `flask_pw.debugtoolbar.PeeweeDebugPanel` to Flask-Debugtoolbar_ panels in your\napplication's configuration: ::\n\n DEBUG_TB_PANELS = [\n 'flask_debugtoolbar.panels.versions.VersionDebugPanel',\n 'flask_debugtoolbar.panels.timer.TimerDebugPanel',\n 'flask_debugtoolbar.panels.headers.HeaderDebugPanel',\n 'flask_debugtoolbar.panels.request_vars.RequestVarsDebugPanel',\n 'flask_debugtoolbar.panels.template.TemplateDebugPanel',\n 'flask_debugtoolbar.panels.sqlalchemy.SQLAlchemyDebugPanel',\n 'flask_debugtoolbar.panels.logger.LoggingPanel',\n 'flask_debugtoolbar.panels.profiler.ProfilerDebugPanel',\n\n # Add the Peewee panel\n 'flask_pw.flask_debugtoolbar.PeeweeDebugPanel',\n ]\n\nEnjoy!\n\n\n.. _bugtracker:\n\nBug tracker\n===========\n\nIf you have any suggestions, bug reports or\nannoyances please report them to the issue tracker\nat https://github.com/keigohtr/flask-pw3/issues\n\n.. _contributing:\n\nContributing\n============\n\nDevelopment of The Flask-pw3 happens at: https://github.com/keigohtr/flask-pw3\n\n\nContributors\n=============\n\n* `Kirill Klenov `_\n\n.. _license:\n\nLicense\n========\n\nLicensed under a MIT license (See LICENSE)\n\nIf you wish to express your appreciation for the project, you are welcome to\nsend a postcard to: ::\n\n Kirill Klenov\n pos. Severny 8-3\n MO, Istra, 143500\n Russia\n\n.. _links:\n\n.. _klen: https://github.com/klen\n.. _Flask: http://flask.pocoo.org/\n.. _Peewee: http://docs.peewee-orm.com/en/latest/\n.. _Flask-Debugtoolbar: https://flask-debugtoolbar.readthedocs.org/en/latest/", "description_content_type": "text/x-rst", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jianc65/flask-pw3", "keywords": "flask,peewee,migrations,migrate,signals", "license": "", "maintainer": "", "maintainer_email": "", "name": "Flask-PW3.1", "package_url": "https://pypi.org/project/Flask-PW3.1/", "platform": "Any", "project_url": "https://pypi.org/project/Flask-PW3.1/", "project_urls": { "Homepage": "https://github.com/jianc65/flask-pw3" }, "release_url": "https://pypi.org/project/Flask-PW3.1/0.0.5/", "requires_dist": null, "requires_python": "", "summary": "Peewee ORM integration for Flask framework", "version": "0.0.5" }, "last_serial": 5602872, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "d1b585084299b5a8ccf6a97ffeefbd1c", "sha256": "f14d262fd57ce6c5f8d5d5d0d3891b94ee35547dad154ad4929a1fad97f1d23d" }, "downloads": -1, "filename": "Flask_PW3.1-0.0.1.tar.gz", "has_sig": false, "md5_digest": "d1b585084299b5a8ccf6a97ffeefbd1c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8521, "upload_time": "2019-07-29T23:59:14", "url": "https://files.pythonhosted.org/packages/40/58/529cae73b89dec05e536233d085086f84a1fa2c34602e19e5514c4961b3e/Flask_PW3.1-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "dfed5abf15b07f80485feeab4d6f6bc1", "sha256": "d5ae309bc5732a2f0f0cab5e576df2e3376243786bedb7d876f63cedbea93cb7" }, "downloads": -1, "filename": "Flask_PW3.1-0.0.2.tar.gz", "has_sig": false, "md5_digest": "dfed5abf15b07f80485feeab4d6f6bc1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8493, "upload_time": "2019-07-30T00:05:54", "url": "https://files.pythonhosted.org/packages/f3/25/d207b6b17e8f8155b5c3aacbd1b77e64edf346c191352f858560fc179206/Flask_PW3.1-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "f32a632053a6b900fa549ddce9a4e2b9", "sha256": "6e90ad0926135490af21941079f9ac3d1a53bae9a9e10c0aa54298a665a135e7" }, "downloads": -1, "filename": "Flask_PW3.1-0.0.3.tar.gz", "has_sig": false, "md5_digest": "f32a632053a6b900fa549ddce9a4e2b9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8528, "upload_time": "2019-07-30T01:26:45", "url": "https://files.pythonhosted.org/packages/8a/72/325c967ebbcc84b2d9285c46eae1384a09176809a8bb57b8fe9b58cf615f/Flask_PW3.1-0.0.3.tar.gz" } ], "0.0.4": [ { "comment_text": "", "digests": { "md5": "9c61b3777f216d002af84aebe729da4d", "sha256": "a10098b515d75f72747a219c2f0b036dcb6a93bed87cf39a8e2a9a449d16880a" }, "downloads": -1, "filename": "Flask_PW3.1-0.0.4.tar.gz", "has_sig": false, "md5_digest": "9c61b3777f216d002af84aebe729da4d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8534, "upload_time": "2019-07-30T01:53:02", "url": "https://files.pythonhosted.org/packages/cd/4f/5b35c25eb1b36156497d85dcd69405abab708ddfcc5fed0f84668a282575/Flask_PW3.1-0.0.4.tar.gz" } ], "0.0.5": [ { "comment_text": "", "digests": { "md5": "aa8f2d1ee777f413db3d436b3a986a57", "sha256": "fe697d2b64fb0d9d3d394032b98edea528916471813968bb4e8f70d31874bee4" }, "downloads": -1, "filename": "Flask_PW3.1-0.0.5.tar.gz", "has_sig": false, "md5_digest": "aa8f2d1ee777f413db3d436b3a986a57", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8517, "upload_time": "2019-07-30T01:59:27", "url": "https://files.pythonhosted.org/packages/91/04/734af5303c1eed04b53ce3caa7ea9f4e9636fbaf00da9ecf15da158a861f/Flask_PW3.1-0.0.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aa8f2d1ee777f413db3d436b3a986a57", "sha256": "fe697d2b64fb0d9d3d394032b98edea528916471813968bb4e8f70d31874bee4" }, "downloads": -1, "filename": "Flask_PW3.1-0.0.5.tar.gz", "has_sig": false, "md5_digest": "aa8f2d1ee777f413db3d436b3a986a57", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8517, "upload_time": "2019-07-30T01:59:27", "url": "https://files.pythonhosted.org/packages/91/04/734af5303c1eed04b53ce3caa7ea9f4e9636fbaf00da9ecf15da158a861f/Flask_PW3.1-0.0.5.tar.gz" } ] }