Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/coleifer/peewee

a small, expressive orm -- supports postgresql, mysql, sqlite and cockroachdb
https://github.com/coleifer/peewee

dank gametight peewee python sqlite

Last synced: 3 days ago
JSON representation

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

Awesome Lists containing this project

README 

        
.. image:: https://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+

* supports sqlite, mysql, mariadb, postgresql

* tons of `extensions `_



New to peewee? These may help:



* `Quickstart `_

* `Example twitter app `_

* `Using peewee interactively `_

* `Models and fields `_

* `Querying `_

* `Relationships and joins `_



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 (for illustrative purposes only, imagine a simple

    # table for tracking a "count" associated with each URL). We don't want to

    # naively get the save in two separate steps since this is prone to race

    # conditions.

    Counter.update(count=Counter.count + 1).where(Counter.url == request.url)



Check out the `example twitter app `_.



Learning more

-------------



Check the `documentation `_ for more examples.



Specific question? Come hang out in the #peewee channel on irc.libera.chat, 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 `_ on GitHub.



Still want more info?

---------------------



.. image:: https://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 `_ as well as `Part 2 `_ and `Part 3 `_.

* `Analytics web service built with Flask and Peewee `_.

* `Personalized news digest (with a boolean query parser!) `_.

* `Structuring Flask apps with Peewee `_.

* `Creating a lastpass clone with Flask and Peewee `_.

* `Creating a bookmarking web-service that takes screenshots of your bookmarks `_.

* `Building a pastebin, wiki and a bookmarking service using Flask and Peewee `_.

* `Encrypted databases with Python and SQLCipher `_.

* `Dear Diary: An Encrypted, Command-Line Diary with Peewee `_.

* `Query Tree Structures in SQLite using Peewee and the Transitive Closure Extension `_.