{"author":"Charles Leifer","author_email":"coleifer@gmail.com","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: OS Independent","Programming Language :: Python","Programming Language :: Python :: 2","Programming Language :: Python :: 2.7","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.4","Programming Language :: Python :: 3.5","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Database","Topic :: Software Development :: Libraries :: Python Modules"],"description":".. image:: https://media.charlesleifer.com/blog/photos/peewee3-logo.png\n\npeewee\n======\n\nPeewee is a simple and small ORM. It has few (but expressive) concepts, making it easy to learn and intuitive to use.\n\n* a small, expressive ORM\n* python 2.7+ and 3.4+\n* supports sqlite, mysql, mariadb, postgresql\n* tons of `extensions `_\n\nNew to peewee? These may help:\n\n* `Quickstart `_\n* `Example twitter app `_\n* `Using peewee interactively `_\n* `Models and fields `_\n* `Querying `_\n* `Relationships and joins `_\n\nExamples\n--------\n\nDefining models is similar to Django or SQLAlchemy:\n\n.. code-block:: python\n\n from peewee import *\n import datetime\n\n\n db = SqliteDatabase('my_database.db')\n\n class BaseModel(Model):\n class Meta:\n database = db\n\n class User(BaseModel):\n username = CharField(unique=True)\n\n class Tweet(BaseModel):\n user = ForeignKeyField(User, backref='tweets')\n message = TextField()\n created_date = DateTimeField(default=datetime.datetime.now)\n is_published = BooleanField(default=True)\n\nConnect to the database and create tables:\n\n.. code-block:: python\n\n db.connect()\n db.create_tables([User, Tweet])\n\nCreate a few rows:\n\n.. code-block:: python\n\n charlie = User.create(username='charlie')\n huey = User(username='huey')\n huey.save()\n\n # No need to set `is_published` or `created_date` since they\n # will just use the default values we specified.\n Tweet.create(user=charlie, message='My first tweet')\n\nQueries are expressive and composable:\n\n.. code-block:: python\n\n # A simple query selecting a user.\n User.get(User.username == 'charlie')\n\n # Get tweets created by one of several users.\n usernames = ['charlie', 'huey', 'mickey']\n users = User.select().where(User.username.in_(usernames))\n tweets = Tweet.select().where(Tweet.user.in_(users))\n\n # We could accomplish the same using a JOIN:\n tweets = (Tweet\n .select()\n .join(User)\n .where(User.username.in_(usernames)))\n\n # How many tweets were published today?\n tweets_today = (Tweet\n .select()\n .where(\n (Tweet.created_date >= datetime.date.today()) &\n (Tweet.is_published == True))\n .count())\n\n # Paginate the user table and show me page 3 (users 41-60).\n User.select().order_by(User.username).paginate(3, 20)\n\n # Order users by the number of tweets they've created:\n tweet_ct = fn.Count(Tweet.id)\n users = (User\n .select(User, tweet_ct.alias('ct'))\n .join(Tweet, JOIN.LEFT_OUTER)\n .group_by(User)\n .order_by(tweet_ct.desc()))\n\n # Do an atomic update (for illustrative purposes only, imagine a simple\n # table for tracking a \"count\" associated with each URL). We don't want to\n # naively get the save in two separate steps since this is prone to race\n # conditions.\n Counter.update(count=Counter.count + 1).where(Counter.url == request.url)\n\nCheck out the `example twitter app `_.\n\nLearning more\n-------------\n\nCheck the `documentation `_ for more examples.\n\nSpecific 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.\n\nStill want more info?\n---------------------\n\n.. image:: https://media.charlesleifer.com/blog/photos/wat.jpg\n\nI'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:\n\n* `Building a note-taking app with Flask and Peewee `_ as well as `Part 2 `_ and `Part 3 `_.\n* `Analytics web service built with Flask and Peewee `_.\n* `Personalized news digest (with a boolean query parser!) `_.\n* `Structuring Flask apps with Peewee `_.\n* `Creating a lastpass clone with Flask and Peewee `_.\n* `Creating a bookmarking web-service that takes screenshots of your bookmarks `_.\n* `Building a pastebin, wiki and a bookmarking service using Flask and Peewee `_.\n* `Encrypted databases with Python and SQLCipher `_.\n* `Dear Diary: An Encrypted, Command-Line Diary with Peewee `_.\n* `Query Tree Structures in SQLite using Peewee and the Transitive Closure Extension `_.\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/coleifer/peewee/","keywords":null,"license":"MIT License","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"peewee","package_url":"https://pypi.org/project/peewee/","platform":"any","project_url":"https://pypi.org/project/peewee/","project_urls":{"Documentation":"http://docs.peewee-orm.com","Homepage":"https://github.com/coleifer/peewee/","Source":"https://github.com/coleifer/peewee"},"provides_extra":null,"release_url":"https://pypi.org/project/peewee/3.18.1/","requires_dist":null,"requires_python":null,"summary":"a little orm","version":"3.18.1","yanked":false,"yanked_reason":null}

Package search

peewee

project_urls

Dependencies

All package metadata

Releases