=======
PyMongo
=======
:Info: See `the mongo site <http://www.mongodb.org>`_ for more information. See `github <http://github.com/mongodb/mongo-python-driver/tree>`_ for the latest source.
:Author: Mike Dirolf <mike@10gen.com>
:Date: $Date: 2009-01-22$
:Description: README file for the PyMongo distribution

About
=====
The ``pymongo`` module is a native Python driver for the Mongo database.

Installation
============
If you have `setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_ installed you should be able to do **easy_install pymongo** to install PyMongo. Otherwise you can download the project source and do **python setup.py install** to install.

Dependencies
============
- `ElementTree <http://effbot.org/zone/element-index.htm>`_
- (to generate documentation) `epydoc <http://epydoc.sourceforge.net/>`_

Examples
========
Here's a basic example (for more see the *examples/* directory):

>>> from pymongo.connection import Connection
>>> connection = Connection("localhost", 27017)
>>> db = connection.test
>>> db.name()
u'test'
>>> db.my_collection
Collection(Database(Connection('localhost', 27017), u'test'),
u'my_collection')
>>> db.my_collection.save({"x": 10})
ObjectId('\x03\x1c\x06\x8d|\x9d}O\x8b\xaf!\xa0')
>>> db.my_collection.save({"x": 8})
ObjectId('\x18\x1f\xa4lOV&\x0bH\xf9%A')
>>> db.my_collection.save({"x": 11})
ObjectId('R\xa3\x85p\xc3m=\xe5\x0e*\x1d\xa7')
>>> db.my_collection.find_one()
SON([(u'x', 10), (u'_id',
ObjectId('\x03\x1c\x06\x8d|\x9d}O\x8b\xaf!\xa0'))])
>>> for item in db.my_collection.find():
...     print item["x"]
...
10
8
11
>>> from pymongo.database import ASCENDING
>>> db.my_collection.create_index("x", ASCENDING)
>>> for item in db.my_collection.find().sort("x", ASCENDING):
...     print item["x"]
...
8
10
11
>>> [item["x"] for item in db.my_collection.find().limit(2).skip(1)]
[8, 11]

Documentation
=============
You will need `epydoc <http://epydoc.sourceforge.net/>`_ installed to generate the documentation. Documentation can be generated by running **epydoc --config=epydoc-config**. Generate documentation can be found in the *doc/* directory.

Testing
=======
The easiest way to run the tests is to install `nose <http://somethingaboutorange.com/mrl/projects/nose/>`_ (**easy_install nose**) and run **python setup.py test** in the root of the distribution. Tests are located in the *test/* directory.