skip to navigation
skip to content

peewee 2.10.1

a little orm

Latest Version: 3.1.5


Peewee is a simple and small ORM. It has few (but expressive) concepts, making it easy to learn and intuitive to use.

New to peewee? Here is a list of documents you might find most helpful when getting started:

For flask helpers, check out the flask_utils extension module. You can also use peewee with the popular extension flask-admin to provide a Django-like admin interface for managing peewee models.


Defining models is similar to Django or SQLAlchemy:

from peewee import *
from playhouse.sqlite_ext import SqliteExtDatabase
import datetime

db = SqliteExtDatabase('my_database.db')

class BaseModel(Model):
    class Meta:
        database = db

class User(BaseModel):
    username = CharField(unique=True)

class Tweet(BaseModel):
    user = ForeignKeyField(User, related_name='tweets')
    message = TextField()
    created_date = DateTimeField(
    is_published = BooleanField(default=True)

Connect to the database and create tables:

db.create_tables([User, Tweet])

Create a few rows:

charlie = User.create(username='charlie')
huey = User(username='huey')

# No need to set `is_published` or `created_date` since they
# will just use the default values we specified.
Tweet.create(user=charlie, message='My first tweet')

Queries are expressive and composable:

# A simple query selecting a user.
User.get(User.username == 'charles')

# Get tweets created by one of several users. The "<<" operator
# corresponds to the SQL "IN" operator.
usernames = ['charlie', 'huey', 'mickey']
users = << usernames)
tweets = << users)

# We could accomplish the same using a JOIN:
tweets = (Tweet
          .where(User.username << usernames))

# How many tweets were published today?
tweets_today = (Tweet
                    (Tweet.created_date >= &
                    (Tweet.is_published == True))

# Paginate the user table and show me page 3 (users 41-60)., 20)

# Order users by the number of tweets they've created:
tweet_ct = fn.Count(
users = (User
         .select(User, tweet_ct.alias('ct'))
         .join(Tweet, JOIN.LEFT_OUTER)

# Do an atomic update
Counter.update(count=Counter.count + 1).where(
    Counter.url == request.url)

Check out the example app for a working Twitter-clone website written with Flask.

Learning more

Check the documentation for more examples.

Specific question? Come hang out in the #peewee channel on, or post to the mailing list, . If you would like to report a bug, create a new issue on GitHub.

File Type Py Version Uploaded on Size
peewee-2.10.1.tar.gz (md5) Source 2017-05-09 503KB