Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/monobot/asyncorm

Fully Async ORM inspired in django's
https://github.com/monobot/asyncorm

async async-await asynchronous metaprogramming orm postgres python python3 sanic

Last synced: 1 day ago
JSON representation

Fully Async ORM inspired in django's

Awesome Lists containing this project

README 

        
asyncOrm

========



.. image:: https://img.shields.io/pypi/v/asyncorm.svg

    :target: https://pypi.python.org/pypi/asyncorm

    :alt: Pypi package



.. image:: https://img.shields.io/pypi/pyversions/asyncorm.svg

    :target: https://pypi.python.org/pypi/asyncorm

    :alt: Python versions



.. image:: https://travis-ci.org/monobot/asyncorm.svg?branch=development

    :target: https://travis-ci.org/monobot/asyncorm

    :alt: build status



.. image:: https://api.codacy.com/project/badge/Grade/86ee891909654fc0a294849d0a436109

    :target: https://www.codacy.com/app/monobot/asyncorm?utm_source=github.com&utm_medium=referral&utm_content=monobot/asyncorm&utm_campaign=Badge_Grade

    :alt: Code quality



.. image:: https://api.codacy.com/project/badge/Coverage/86ee891909654fc0a294849d0a436109

    :target: https://www.codacy.com/app/monobot/asyncorm?utm_source=github.com&utm_medium=referral&utm_content=monobot/asyncorm&utm_campaign=Badge_Coverage

    :alt: Coverage



.. image:: https://pyup.io/repos/github/monobot/asyncorm/shield.svg

    :target: https://pyup.io/account/repos/github/monobot/asyncorm/

    :alt: Packages status



.. image:: https://readthedocs.org/projects/asyncorm/badge/?version=development

    :target: http://asyncorm.readthedocs.io/en/development/

    :alt: Documentation Status



.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/ambv/black

    :alt: Code style



A fully asynchronous python ORM



* Free software: Apache Software License 2.0

* Documentation: https://asyncorm.readthedocs.io.



Features

--------



WARNING: alpha version !!



WARNING: Work In Progress !!



**AsyncORM** is a fully async ORM_ inspired by the fantastic `django orm`_



.. _ORM: https://en.wikipedia.org/wiki/Object-relational_mapping

.. _django orm: https://docs.djangoproject.com/en/1.11/topics/db/



**AsyncORM** currently only supports postgres, but its developed to be "easy"

to plug a number of different database interfaces.



It is designed to be used with any async library, but with sanic_ in mind.



.. _sanic: https://github.com/channelcat/sanic



To do

-----



A number of things are needed to be able to release asyncOrm as a production

ready ORM:



- better the documentation!

- migration support (forward migration at least)

- other databases interfaces ( `mysql`_ / `mariaDb`_ first priority)

- `prefetch_related`_ functionality

- Missing Field types: OneToOneField



.. _mySql: https://www.mysql.com/

.. _mariaDb: https://mariadb.org/

.. _prefetch_related: https://docs.djangoproject.com/en/1.11/ref/models/querysets/#prefetch_related support



Dependencies

------------



AsyncOrm currently only depends on AsyncPg and netaddr.



asyncpg_, is a database interface library designed specifically for PostgreSQL

and Python/asyncio.



netaddr_, A network address manipulation library for Python



.. _asyncpg: https://github.com/MagicStack/asyncpg

.. _netaddr: https://github.com/drkjam/netaddr



Credits

---------



This package was created with Cookiecutter_ and the

`audreyr/cookiecutter-pypackage`_ project template.



.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage