Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/05bit/peewee-async
Asynchronous interface for peewee ORM powered by asyncio
https://github.com/05bit/peewee-async
asyncio mysql orm peewee postgresql python
Last synced: about 1 month ago
JSON representation
Asynchronous interface for peewee ORM powered by asyncio
- Host: GitHub
- URL: https://github.com/05bit/peewee-async
- Owner: 05bit
- License: mit
- Created: 2014-09-27T22:15:28.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-15T08:59:56.000Z (3 months ago)
- Last Synced: 2024-09-16T02:58:52.532Z (3 months ago)
- Topics: asyncio, mysql, orm, peewee, postgresql, python
- Language: Python
- Homepage: http://peewee-async-lib.readthedocs.io
- Size: 491 KB
- Stars: 724
- Watchers: 25
- Forks: 98
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-asyncio - peewee-async - ORM implementation based on [peewee](https://github.com/coleifer/peewee) and aiopg. (Database Drivers)
- awesome-asyncio-cn - peewee-async - 基于 [peewee](https://github.com/coleifer/peewee) 和 aiopg 实现的 ORM。 (数据库驱动)
- awesome-asyncio - peewee-async - ORM implementation based on [peewee](https://github.com/coleifer/peewee) and aiopg. (Database Drivers)
- starred-awesome - peewee-async - Asynchronous interface for peewee ORM powered by asyncio (Python)
README
peewee-async
============
Asynchronous interface for **[peewee](https://github.com/coleifer/peewee)**
ORM powered by **[asyncio](https://docs.python.org/3/library/asyncio.html)**.
[](https://github.com/05bit/peewee-async/actions/workflows/tests.yml) [](https://pypi.python.org/pypi/peewee-async)
[](https://peewee-async-lib.readthedocs.io/en/latest/?badge=latest)
Overview
--------
* Requires Python 3.8+
* Has support for PostgreSQL via [aiopg](https://github.com/aio-libs/aiopg)
* Has support for MySQL via [aiomysql](https://github.com/aio-libs/aiomysql)
* 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 complete documentation:
http://peewee-async-lib.readthedocs.io
Install
-------
Install with `pip` for PostgreSQL:
```bash
pip install peewee-async[postgresql]
```
or for MySQL:
```bash
pip install peewee-async[mysql]
```
Quickstart
----------
Create 'test' PostgreSQL database for running this snippet:
createdb -E utf-8 test
```python
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:
```bash
pip install -e .[develop]
```
Or using [poetry](https://python-poetry.org/docs/):
```bash
poetry install -E develop
```
Run databases:
```bash
docker-compose up -d
```
Run tests:
```bash
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.