=====
Motor
.. image:: https://raw.github.com/mongodb/motor/master/doc/_static/motor.png
:Info: Motor is a full-featured, non-blocking MongoDB_ driver for Python
Tornado_ applications.
:Author: A. Jesse Jiryu Davis
.. image:: https://travis-ci.org/mongodb/motor.png
:target: https://travis-ci.org/mongodb/motor
About
Motor presents a Tornado_callback- or Future-based API for non-blocking access
to MongoDB. The source is on GitHub <https://github.com/mongodb/motor>_
and the docs are on ReadTheDocs_.
"Motor uses a clever greenlet-based approach to fully support both
synchronous and asynchronous interfaces from a single codebase. It's great
to see companies like MongoDB produce first-party asynchronous drivers for
their products."
--*Ben Darnell, Tornado maintainer*
Issues / Questions / Feedback
Any issues with, questions about, or feedback for Motor should be sent to the
mongodb-user list on Google Groups. For confirmed issues or feature requests,
open a case on jira <http://jira.mongodb.org>_ in the "MOTOR" project.
Installation
$ pip install motor
Dependencies
Motor works in all the environments officially supported by Tornado_. It
requires:
- Unix, including Mac OS X. Microsoft Windows is not officially supported.
- PyMongo_
- Tornado_
- Greenlet_
- CPython 2.6 or later, including CPython 3, or PyPy 2.0 or later.
Documentation
You will need sphinx_ installed to generate the documentation. Documentation
can be generated by running cd doc; make html. Generated documentation
can be found in doc/build/html/. You can read the current docs
at ReadTheDocs_.
Examples
See the examples on ReadTheDocs <https://motor.readthedocs.org/en/latest/examples/index.html>_
or Chirp, a dumb Twitter clone <https://github.com/ajdavis/chirp>_.
Testing
Run python setup.py test.
Tests are located in the test/ directory.
In Python 2.6, unittest2_ is automatically installed.
.. _PyMongo: http://pypi.python.org/pypi/pymongo/
.. _MongoDB: http://mongodb.org/
.. _Tornado: http://tornadoweb.org/
.. _Greenlet: http://pypi.python.org/pypi/greenlet/
.. _ReadTheDocs: http://motor.readthedocs.org/
.. _sphinx: http://sphinx.pocoo.org/
.. _unittest2: https://pypi.python.org/pypi/unittest2