.. peewee-async documentation master file, created by
   sphinx-quickstart on Sat Oct 11 20:12:24 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

peewee-async
============

**peewee-async** is a library providing asynchronous interface powered by `asyncio`_ for `peewee`_ ORM.




* Works on Python 3.10+
* Has support for PostgreSQL via `aiopg` or `psycopg3`
* Has support for MySQL via `aiomysql`
* Has support for Sqlite via `aiosqlite`
* Asynchronous analogues of peewee sync methods with prefix **aio_**
* Drop-in replacement for sync code, sync will remain sync
* Basic operations are supported
* Transactions support is present

The source code is hosted on `GitHub`_.

.. _GitHub: https://github.com/05bit/peewee-async


Related projects
----------------

* `asyncio <https://docs.python.org/3/library/asyncio.html>`_ - is a library to write concurrent code using the async/await syntax.
* `peewee <https://github.com/coleifer/peewee/>`_ - the Peewee ORM.
* `miggy <https://github.com/kalombos/miggy/>`_ - is a migration engine for Peewee.

Contents
--------

.. toctree::
   :maxdepth: 2

   peewee_async/installing
   peewee_async/quickstart
   peewee_async/api
   peewee_async/connection
   peewee_async/transaction
   peewee_async/signals
   peewee_async/testing
   peewee_async/examples

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

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