Skip to main content

Peewee support for async frameworks (Asyncio, Trio)

Project description

Peewee-AIO

Async support for Peewee ORM

Features

  • Make Peewee ORM to work async
  • Supports PostgresQL, MySQL, SQLite

Requirements

  • python >= 3.7

Installation

peewee-orm should be installed using pip:

$ pip install peewee-orm

You can install optional database drivers with:

$ pip install peewee-aio[sqlite]
$ pip install peewee-aio[postgresql]
$ pip install peewee-aio[mysql]

Quickstart

    import peewee
    from peewee_aio import Manager

    manager = Manager('sqlite:///:memory:')

    class TestModel(peewee.Model):
        text = peewee.CharField()

    async def handler():

        # Initialize the database
        async with manager:

            # Create the table in database
            await manager.create_tables(TestModel, safe=True)

            # Create a record
            test = await manager.create(TestModel, text="I'm working!")
            assert test
            assert test.id

            # Iterate through records
            async for test in manager.run(TestModel.select()):
                assert test
                assert test.id

            # Drop the table in database
            await manager.drop_tables(TestModel, safe=True)

    # Run the handler with your async library
    import asyncio

    asyncio.run(handler())

Usage

TODO

Bug tracker

If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/peewee-aio/issues

Contributing

Development of the project happens at: https://github.com/klen/peewee-aio

License

Licensed under a MIT License

Project details


Release history Release notifications | RSS feed

This version

0.0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

peewee-aio-0.0.3.tar.gz (6.7 kB view details)

Uploaded Source

Built Distribution

peewee_aio-0.0.3-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file peewee-aio-0.0.3.tar.gz.

File metadata

  • Download URL: peewee-aio-0.0.3.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.4

File hashes

Hashes for peewee-aio-0.0.3.tar.gz
Algorithm Hash digest
SHA256 8aaf5f510f84be3fe60c27c6d6ea61e525429a8354b8c2bd1926dde2f774a2f3
MD5 039003ede12c61e109ab4b6522af223a
BLAKE2b-256 229e00930acf32163e3c7ae5f82f7a9107c03284e904308bf34344c002567991

See more details on using hashes here.

File details

Details for the file peewee_aio-0.0.3-py3-none-any.whl.

File metadata

  • Download URL: peewee_aio-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.4

File hashes

Hashes for peewee_aio-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4c4fb425ae444c226f9f62c28f03ad14f4419e16c60546a52ef1d9bfb6770ae5
MD5 47d517560ae721614d5471c33b704764
BLAKE2b-256 ac2bbbbbf5329ba8b8d8399769080fe46a546442675c40bed46b924d5dbee6fe

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page