motor

Go to file

A. Jesse Jiryu Davis ea1bb6e4a8 BUMP 0.2rc0		2014-04-04 21:09:02 -04:00
doc	Add link to list of Jira issues in 0.2.	2014-04-04 21:09:02 -04:00
motor	BUMP 0.2rc0	2014-04-04 21:09:02 -04:00
synchro	Fix synchrotests for max_write_batch_size.	2014-03-13 11:16:49 -04:00
test	Depend on PyMongo 2.7.	2014-04-04 17:29:48 -04:00
.gitignore	Ignoring sphinx build directory	2013-05-27 16:40:58 -05:00
.travis.yml	Travis doesn't support Python 3.4 yet, downgrade travis.yml to 3.3.	2014-04-04 18:12:58 -04:00
CONTRIBUTING.rst	'python setup.py test' is now how to run the tests, not 'setup.py nosetests'	2013-01-23 17:03:31 -05:00
distribute_setup.py	Use distribute_setup if needed	2013-02-26 08:50:21 -05:00
LICENSE	Initial import from my fork of PyMongo	2013-01-15 14:07:09 -05:00
MANIFEST.in	Include PEM files when building Motor for testing (this method seems to actually work).	2013-12-23 12:10:39 -06:00
README.rst	We support Python 3.4 now, too.	2014-04-04 14:06:36 -04:00
setup.cfg	Fix some path issues with “python3 setup.py test”.	2013-12-19 14:48:01 -05:00
setup.py	BUMP 0.2rc0	2014-04-04 21:09:02 -04:00
tox.ini	Depend on PyMongo 2.7.	2014-04-04 17:29:48 -04:00

README.rst

=====
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.

Additional dependencies are:

- (to generate documentation) sphinx_
- (to run tests) nose_

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
=======

The easiest way to run the tests is to install nose_ and run ``nosetests``
or ``python setup.py test`` in the root of the distribution. Tests are
located in the ``test/`` directory.

.. _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/

.. _nose: http://somethingaboutorange.com/mrl/projects/nose/