1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
|
.. 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
======
.. image:: peewee3-logo.png
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
* :ref:`tons of extensions <playhouse>`
.. image:: postgresql.png
:target: peewee/database.html#using-postgresql
:alt: postgresql
.. image:: mysql.png
:target: peewee/database.html#using-mysql
:alt: mysql
.. image:: sqlite.png
:target: peewee/database.html#using-sqlite
:alt: sqlite
.. image:: crdb.png
:target: peewee/database.html#using-crdb
:alt: cockroachdb
Peewee's source code hosted on `GitHub <https://github.com/coleifer/peewee>`_.
New to peewee? These may help:
* :ref:`Quickstart <quickstart>`
* :ref:`Example twitter app <example-app>`
* :ref:`Using peewee interactively <interactive>`
* :ref:`Models and fields <models>`
* :ref:`Querying <querying>`
* :ref:`Relationships and joins <relationships>`
Contents:
---------
.. toctree::
:maxdepth: 2
:glob:
peewee/installation
peewee/quickstart
peewee/example
peewee/interactive
peewee/contributing
peewee/database
peewee/models
peewee/querying
peewee/query_operators
peewee/relationships
peewee/api
peewee/sqlite_ext
peewee/playhouse
peewee/query_examples
peewee/query_builder
peewee/hacks
peewee/changes
Note
----
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`
|