:tocdepth: 1

MongoMotor: Asynchronous Object-Document Mapper
===============================================

|mongomotor-logo|

.. |mongomotor-logo| image:: ./_static/mongomotor.jpg
    :alt: Asynchronous object-document mapper for Python and MongoDB


MongoMotor is a async ORM for mongodb based on
`MongoEngine <http://mongoengine.org/>`_ using the pymongo async driver.


Installation
============

To install MongoMotor, use pip:

.. code-block:: sh

    $ pip install mongomotor


And that's it!


Usage
=====

In the MongoMotor introduction tutorial we will create a simple music catalog.


.. toctree::
   :maxdepth: 1

   tutorial_asyncio


Guides
======

.. toctree::
   :maxdepth: 1

   guide/defining-documents
   guide/querying
   guide/gridfs


API Documentation
=================

.. toctree::
   :maxdepth: 1

   apidoc/modules


CHANGELOG
=========

.. toctree::
   :maxdepth: 1

   CHANGELOG

Licence
=======

MongoMotor is free software, licensed under the GPL version 3 or latter.


Contributing
============

MongoMotor's code is hosted on
`github <https://github.com/jucacrispim/mongomotor>`_. Feel free to create
a fork of the project, open issues, do merge requests...


Well, that's it!
Thank you!