PyMongo 4.4.0.dev0 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.

Installing / Upgrading

Instructions on how to get the distribution.

Tutorial

Start here for a quick overview.

Examples

Examples of how to perform specific tasks.

Using PyMongo with MongoDB Atlas

Using PyMongo with MongoDB Atlas.

TLS/SSL and PyMongo

Using PyMongo with TLS / SSL.

Client-Side Field Level Encryption

Using PyMongo with client side encryption.

Type Hints

Using PyMongo with type hints.

Frequently Asked Questions

Some questions that come up often.

PyMongo 4 Migration Guide

A PyMongo 3.x to 4.x migration guide.

Python 3 FAQ

Frequently asked questions about python 3 support.

Compatibility Policy

Explanation of deprecations, and how to keep pace with changes in PyMongo’s API.

API Documentation

The complete API documentation, organized by module.

Tools

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

Developer Guide

Developer guide for contributors to PyMongo.

Frequently Encountered Issues

Common issues encountered when using PyMongo.

Getting Help

If you’re having trouble or have questions about PyMongo, ask your question on our MongoDB Community Forum. You may also want to consider a commercial support subscription. 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.

Feature Requests / Feedback

Use our feedback engine to send us feature requests and general feedback about PyMongo.

Contributing

PyMongo has a large community 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.

Changes

See the Changelog for a full list of changes to PyMongo. For older versions of the documentation please see the archive list.

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