Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 86 lines (65 sloc) 2.31 kb

PyMongo |release| Documentation

Overview

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.

System Message: ERROR/3 (<string>, line 11)

Unknown directive type "todo".

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

:doc:`installation`

System Message: ERROR/3 (<string>, line 14); backlink

Unknown interpreted text role "doc".

Instructions on how to get the distribution.

:doc:`tutorial`

System Message: ERROR/3 (<string>, line 17); backlink

Unknown interpreted text role "doc".

Start here for a quick overview.

:doc:`examples/index`

System Message: ERROR/3 (<string>, line 20); backlink

Unknown interpreted text role "doc".

Examples of how to perform specific tasks.

:doc:`faq`

System Message: ERROR/3 (<string>, line 23); backlink

Unknown interpreted text role "doc".

Some questions that come up often.

:doc:`api/index`

System Message: ERROR/3 (<string>, line 26); backlink

Unknown interpreted text role "doc".

The complete API documentation, organized by module.

:doc:`tools`

System Message: ERROR/3 (<string>, line 30); backlink

Unknown interpreted text role "doc".

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

Getting Help

If you're having trouble or have questions about PyMongo, the best place to ask is the MongoDB user group. Once you get an answer, it'd be great if you could work it back into this documentation and contribute!

Issues

All issues should be reported (and can be tracked / voted for / commented on) at the main MongoDB JIRA bug tracker, in the "Python Driver" project.

Contributing

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.

System Message: ERROR/3 (<string>, line 45); backlink

Unknown interpreted text role "doc".

Changes

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

System Message: ERROR/3 (<string>, line 53); backlink

Unknown interpreted text role "doc".

About This Documentation

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

Indices and tables

System Message: ERROR/3 (<string>, line 74)

Unknown directive type "toctree".

.. toctree::
   :hidden:

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

Docutils System Messages

System Message: ERROR/3 (<string>, line 2); backlink

Undefined substitution referenced: "release".
Something went wrong with that request. Please try again.