peewee-async

peewee-async

Asynchronous interface for peewee ORM powered by asyncio. Overview

• Requires Python 3.10+
• Has support for PostgreSQL via aiopg and 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
• Most basic operations are supported
• Transactions support is present

The complete documentation:
http://peewee-async-lib.readthedocs.io

Install

Install with pip for PostgreSQL aiopg backend:

pip install peewee-async[postgresql]

or for PostgreSQL psycopg3 backend:

pip install peewee-async[psycopg]

or for MySQL:

pip install peewee-async[mysql]

or for Sqlite:

pip install peewee-async[sqlite]

Quickstart

Create 'test' PostgreSQL database for running this snippet:

createdb -E utf-8 test

…

More examples

Check the ./examples directory for more.

Documentation

http://peewee-async-lib.readthedocs.io

http://peewee-async.readthedocs.io - DEPRECATED

Developing

Install dependencies using pip:

pip install -e .[dev]

Run databases:

docker-compose up -d

Run tests:

pytest tests -v -s

Discuss

You are welcome to add discussion topics or bug reports to tracker on GitHub: https://github.com/05bit/peewee-async/issues

License

Copyright (c) 2014, Alexey Kinev

Licensed under The MIT License (MIT), see LICENSE file for more details.