PyMongo is a Python distribution containing tools for working with MongoDB, and is the recommended way to work with MongoDB from Python. This documentation attempts to explain everything you need to know to use PyMongo.

.. todo:: a list of PyMongo's features

:doc:`installation`

Instructions on how to get the distribution.

:doc:`tutorial`

Start here for a quick overview.

:doc:`examples/index`

Examples of how to perform specific tasks.

:doc:`faq`

Some questions that come up often.

:doc:`api/index`

The complete API documentation, organized by module.

:doc:`tools`

A listing of Python tools and libraries that have been written for MongoDB.

PyMongo has a large :doc:`community <contributors>` and contributions are always encouraged. Contributions can be as simple as minor tweaks to this documentation. To contribute, fork the project on github and send a pull request.

See the :doc:`changelog` for a full list of changes to PyMongo.

This documentation is generated using the Sphinx documentation generator. The source files for the documentation are located in the doc/ directory of the PyMongo distribution. To generate the docs locally run the following command from the root directory of the PyMongo source:

$ python setup.py doc

• :ref:`genindex`
• :ref:`modindex`
• :ref:`search`

.. toctree::
   :hidden:

   installation
   tutorial
   examples/index
   faq
   api/index
   tools
   contributors
   changelog