.. peewee documentation master file, created by
   sphinx-quickstart on Thu Nov 25 21:20:29 2010.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

peewee
======

* a small, expressive orm
* written in python (2.6+ or 3.2+)

.. image:: postgresql.png
    :target: peewee/cookbook.html#using-with-postgresql
    :alt: postgresql

.. image:: mysql.png
    :target: peewee/cookbook.html#using-with-mysql
    :alt: mysql

.. image:: sqlite.png
    :target: peewee/cookbook.html#using-with-sqlite
    :alt: sqlite

Peewee's source code hosted on `GitHub <https://github.com/coleifer/peewee>`_.

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

* :ref:`Quickstart guide <quickstart>` -- this guide covers all the bare essentials. It will take you between 5 and 10 minutes to go through it.
* :ref:`Guide to the various query operators <query-operators>` describes how to construct queries and combine expressions.
* :ref:`Field types table <field_types_table>` lists the various field types peewee supports and the parameters they accept.

Contents:
---------

.. toctree::
   :maxdepth: 2
   :glob:

   peewee/installation
   peewee/quickstart
   peewee/example
   peewee/database
   peewee/models
   peewee/querying
   peewee/transactions
   peewee/api
   peewee/playhouse

Note
----

Hi, I'm Charlie the author of peewee. I hope that you enjoy using this library as much as I've enjoyed writing it. Peewee wouldn't be anywhere near as useful without people like you, so thank you. If you find any bugs, odd behavior, or have an idea for a new feature please don't hesitate to `open an issue <https://github.com/coleifer/peewee/issues?state=open>`_ on GitHub or `contact me <http://charlesleifer.com/contact/>`_.

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
