Github url

peewee

by coleifer

coleifer /peewee

a small, expressive orm -- supports postgresql, mysql and sqlite

7.7K Stars 1.2K Forks Last release: 4 months ago (3.13.3) MIT License 4.3K Commits 164 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

.. image:: http://media.charlesleifer.com/blog/photos/peewee3-logo.png

peewee

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

  • a small, expressive ORM
  • python 2.7+ and 3.4+ (developed with 3.6)
  • supports sqlite, mysql, postgresql and cockroachdb
  • tons of
    extensions <http:></http:>
    _

.. image:: https://travis-ci.org/coleifer/peewee.svg?branch=master :target: https://travis-ci.org/coleifer/peewee

New to peewee? These may help:

  • Quickstart <http:></http:>
    _
  • Example twitter app <http:></http:>
    _
  • Using peewee interactively <http:></http:>
    _
  • Models and fields <http:></http:>
    _
  • Querying <http:></http:>
    _
  • Relationships and joins <http:></http:>
    _

Examples

Defining models is similar to Django or SQLAlchemy:

.. code-block:: python

from peewee import \* import datetime db = SqliteDatabase('my\_database.db') class BaseModel(Model): class Meta: database = db class User(BaseModel): username = CharField(unique=True) class Tweet(BaseModel): user = ForeignKeyField(User, backref='tweets') message = TextField() created\_date = DateTimeField(default=datetime.datetime.now) is\_published = BooleanField(default=True)

Connect to the database and create tables:

.. code-block:: python

db.connect() db.create\_tables([User, Tweet])

Create a few rows:

.. code-block:: python

charlie = User.create(username='charlie') huey = User(username='huey') huey.save() # 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:

.. code-block:: python

# A simple query selecting a user. User.get(User.username == 'charlie') # Get tweets created by one of several users. usernames = ['charlie', 'huey', 'mickey'] users = User.select().where(User.username.in\_(usernames)) tweets = Tweet.select().where(Tweet.user.in\_(users)) # We could accomplish the same using a JOIN: tweets = (Tweet .select() .join(User) .where(User.username.in\_(usernames))) # How many tweets were published today? tweets\_today = (Tweet .select() .where( (Tweet.created\_date \>= datetime.date.today()) & (Tweet.is\_published == True)) .count()) # Paginate the user table and show me page 3 (users 41-60). User.select().order\_by(User.username).paginate(3, 20) # Order users by the number of tweets they've created: tweet\_ct = fn.Count(Tweet.id) users = (User .select(User, tweet\_ct.alias('ct')) .join(Tweet, JOIN.LEFT\_OUTER) .group\_by(User) .order\_by(tweet\_ct.desc())) # Do an atomic update Counter.update(count=Counter.count + 1).where(Counter.url == request.url)

Check out the

example twitter app <http:></http:>

_.

Learning more

Check the

documentation <http:></http:>

_ for more examples.

Specific question? Come hang out in the #peewee channel on irc.freenode.net, or post to the mailing list, http://groups.google.com/group/peewee-orm . If you would like to report a bug,

create a new issue <https:></https:>

_ on GitHub.

Still want more info?

.. image:: http://media.charlesleifer.com/blog/photos/wat.jpg

I've written a number of blog posts about building applications and web-services with peewee (and usually Flask). If you'd like to see some real-life applications that use peewee, the following resources may be useful:

  • Building a note-taking app with Flask and Peewee <http:></http:>
    _ as well as
    Part 2 <http:></http:>
    _ and
    Part 3 <http:></http:>
    _.
  • Analytics web service built with Flask and Peewee <http:></http:>
    _.
  • Personalized news digest (with a boolean query parser!) <http:></http:>
    _.
  • Structuring Flask apps with Peewee <http:></http:>
    _.
  • Creating a lastpass clone with Flask and Peewee <http:></http:>
    _.
  • Creating a bookmarking web-service that takes screenshots of your bookmarks <http:></http:>
    _.
  • Building a pastebin, wiki and a bookmarking service using Flask and Peewee <http:></http:>
    _.
  • Encrypted databases with Python and SQLCipher <http:></http:>
    _.
  • Dear Diary: An Encrypted, Command-Line Diary with Peewee <http:></http:>
    _.
  • Query Tree Structures in SQLite using Peewee and the Transitive Closure Extension <http:></http:>
    _.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.