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
import asyncio
import peewee
import peewee_async
# Nothing special, just define model and database:
database = peewee_async.PooledPostgresqlDatabase(
database='db_name',
user='user',
host='127.0.0.1',
port='5432',
password='password',
)
class TestModel(peewee_async.AioModel):
text = peewee.CharField()
class Meta:
database = database
# Look, sync code is working!
TestModel.create_table(True)
TestModel.create(text="Yo, I can do it sync!")
database.close()
# No need for sync anymore!
database.set_allow_sync(False)
async def handler():
await TestModel.aio_create(text="Not bad. Watch this, I'm async!")
all_objects = await TestModel.select().aio_execute()
for obj in all_objects:
print(obj.text)
loop = asyncio.get_event_loop()
loop.run_until_complete(handler())
loop.close()
# Clean up, can do it sync again:
with database.allow_sync():
TestModel.drop_table(True)
# Expected output:
# Yo, I can do it sync!
# Not bad. Watch this, I'm async!
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 rudy@05bit.com
Licensed under The MIT License (MIT), see LICENSE file for more details.
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file peewee_async-2.1.0.tar.gz.
File metadata
- Download URL: peewee_async-2.1.0.tar.gz
- Upload date:
- Size: 15.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2c1d58269cb17e4cd5de78561f6b01152ca3fb8987241a4408407b64d7757d9f
|
|
| MD5 |
dfe7912d9c838c226fb0835db7cda735
|
|
| BLAKE2b-256 |
0f196e681114e77d45c2afb86348f59fe9917a16c802d0a61b72682168172db2
|
File details
Details for the file peewee_async-2.1.0-py3-none-any.whl.
File metadata
- Download URL: peewee_async-2.1.0-py3-none-any.whl
- Upload date:
- Size: 18.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5424beef9065782b3208869daeb97f9192d0c43ce9b8be14dafcb5e49b39c991
|
|
| MD5 |
96877752eaa7928762627538c278bd06
|
|
| BLAKE2b-256 |
b8d0cd83c07e37ff59df50d94153a6d5c6e2577f35ae24a64e59e4690882bcc4
|
