flask-peewee ============

provides a layer of integration between the flask <https://flask.palletsprojects.com/>_ web framework and the peewee orm <https://docs.peewee-orm.com/>_.

batteries included:

• admin interface
• authentication
• rest api

• flask <https://github.com/pallets/flask>_
• peewee <https://github.com/coleifer/peewee>_
• wtforms <https://github.com/wtforms/wtforms>_
• wtf-peewee <https://github.com/coleifer/wtf-peewee>_
• python 3.8 or greater

check out the documentation <https://flask-peewee.readthedocs.io/>_.

admin interface

influenced heavily by the django <https://djangoproject.com>_ admin, provides easy create/edit/delete functionality for your project's models.

.. image:: https://media.charlesleifer.com/blog/photos/im-1783454777-579.png

or you can use one of the themes. Here is the crux theme:

.. image:: https://media.charlesleifer.com/blog/photos/fp-crux-full.png

rest api

provides a RESTful interface for your project's models.

::

curl localhost:5000/api/user/ { "meta": { "model": "user", "next": "", "page": 1, "previous": "" }, "objects": [ { "username": "admin", "admin": true, "email": "", "join_date": "2025-09-16 18:34:49", "active": true, "id": 1 }, { "username": "coleifer", "admin": false, "email": "coleifer@gmail.com", "join_date": "2025-09-16 18:35:56", "active": true, "id": 2 } ] }

installing

::

pip install flask-peewee

example app

the project ships with an example app, which is a silly twitter clone. to start the example app, `cd into the "example" directory and execute the run_example.py` script::

cd example/ python run_example.py

if you would like to test out the admin area, log in as "admin/admin" and navigate to:

http://127.0.0.1:5000/admin/

you can check out the REST api at the following url:

http://127.0.0.1:5000/api/message/