Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…
Cannot retrieve contributors at this time
102 lines (72 sloc) 2.25 KB


provides a layer of integration between the flask web framework and the peewee orm.

batteries included:

  • admin interface
  • authentication
  • rest api


check out the documentation.

admin interface

influenced heavily by the django admin, provides easy create/edit/delete functionality for your project's models.

rest api

influenced by tastypie, provides a way to expose 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": "2011-09-16 18:34:49",
      "active": true,
      "id": 1
      "username": "coleifer",
      "admin": false,
      "email": "",
      "join_date": "2011-09-16 18:35:56",
      "active": true,
      "id": 2


I recommend installing in a virtualenv. to get started:

# create a new virtualenv
virtualenv --no-site-packages project
cd project/
source bin/activate

# install this project (will install dependencies as well)
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 script:

cd example/

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

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

Jump to Line
Something went wrong with that request. Please try again.