.. asyncqlio documentation master file, created by
   sphinx-quickstart on Wed Apr 26 07:56:32 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to asyncqlio's documentation!
=====================================

|b1| |b2| |b3| |b4|

.. |b1| image:: https://img.shields.io/circleci/project/github/SunDwarf/asyncqlio.svg
   :target: https://circleci.com/gh/SunDwarf/asyncqlio
.. |b2| image:: https://img.shields.io/pypi/v/asyncqlio.svg
.. |b3| image:: https://img.shields.io/github/tag/SunDwarf/asyncqlio.svg
.. |b4| image:: https://img.shields.io/coveralls/SunDwarf/asyncqlio.svg
   :target: https://codecov.io/gh/SunDwarf/asyncqlio


**asyncqlio** is a Python 3.5+ for SQL Relational Databases, that allows access from
async code.

You can install the latest version of asyncqlio from PyPI with pip:

.. code-block:: bash

   $ pip install asyncqlio

You can also install the development version of asyncqlio from Git:

.. code-block:: bash

   $ pip install git+https://github.com/SunDwarf/asyncqlio.git

**The development version is NOT guarenteed to be stable, or even working.**  
Of course, asyncqlio by itself is useless without a driver to connect to a
database. asyncqlio comes with modules that use other libraries as backend
drivers to connect to these servers:

   - PostgreSQL (asyncpg, aiopg)
   - MySQL (aiomysql)
   - SQLite3 (sqlite3)

Other databases may be supported in the future. 

Contents
========

.. toctree::
   :maxdepth: 2

   changelog

.. toctree::
   :maxdepth: 2
   :caption: High-level API

   hilvl/connecting
   hilvl/tables
   hilvl/sessions
   hilvl/querying


.. toctree::
   :maxdepth: 2
   :caption: Low-level API

   lowlvl/basics

Autogenerated Documentation
===========================

These docs are automatically generated from the source code using the autosummary module.

.. toctree::
   :maxdepth: 3
   :caption: Autogenerated Documentation

   autogen/asyncqlio

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. _ORM: Object Relational Mapper