PyMongo - the Python driver for MongoDB
Python C Shell
Permalink
Failed to load latest commit information.
.evergreen PYTHON-1392 PYTHON-1535 - Fix EVG path issues Jul 13, 2018
bson PYTHON-1603 Truncate large datetimes properly (#362) Jul 9, 2018
doc Add GEOSPHERE to geospatial docs (#364) Aug 10, 2018
gridfs PYTHON-1458 - Make MD5 digest optional in GridFS Mar 31, 2018
pymongo PYTHON-1617 Fix database name check in index cache (#363) Jul 25, 2018
test PYTHON-1625 - Fix perf tests Aug 13, 2018
tools PYTHON-1556 Fix compatibility issues with Python >= 3.6 (#352) May 15, 2018
.coveragerc PYTHON-1234 Evergreen - add CPython coverage reporting. May 11, 2017
.gitignore PYTHON-680 Remove all references to nose Apr 28, 2014
.travis.yml Remove Travis workarounds (#366) Aug 9, 2018
CONTRIBUTING.rst PYTHON-1536 - PyMongo no longer supports PyPy3 < 3.5 Jul 3, 2018
LICENSE Ensure files end in a newline Sep 1, 2017
MANIFEST.in PYTHON-1151 - Add third party notices file Oct 17, 2016
README.rst PYTHON-1536 - PyMongo no longer supports PyPy3 < 3.5 Jul 3, 2018
RELEASE.rst PYTHON-1467 - PyMongo no longer supports Python 2.6 Jul 2, 2018
THIRD-PARTY-NOTICES Ensure files end in a newline Sep 1, 2017
appveyor.yml PYTHON-1548 - Add a simple Appveyor config Jun 26, 2018
cdecimal_test.py PYTHON-1213 - Make decimal128 work with cdecimal Apr 5, 2017
ez_setup.py Update ez_setup.py to latest Mar 6, 2017
green_framework_test.py Update copyright dates Dec 2, 2017
setup.py PYTHON-1541 - Use setuptools python_requires Jul 3, 2018
tox.ini PYTHON-1467 - PyMongo no longer supports Python 2.6 Jul 2, 2018

README.rst

PyMongo

Info:See the mongo site for more information. See GitHub for the latest source.
Author: Mike Dirolf
Maintainer:Bernie Hackett <bernie@mongodb.com>

About

The PyMongo distribution contains tools for interacting with MongoDB database from Python. The bson package is an implementation of the BSON format for Python. The pymongo package is a native Python driver for MongoDB. The gridfs package is a gridfs implementation on top of pymongo.

PyMongo supports MongoDB 2.6, 3.0, 3.2, 3.4, 3.6 and 4.0.

Support / Feedback

For issues with, questions about, or feedback for PyMongo, please look into our support channels. Please do not email any of the PyMongo developers directly with issues or questions - you're more likely to get an answer on the mongodb-user list on Google Groups.

Bugs / Feature Requests

Think you’ve found a bug? Want to see a new feature in PyMongo? Please open a case in our issue management tool, JIRA:

Bug reports in JIRA for all driver projects (i.e. PYTHON, CSHARP, JAVA) and the Core Server (i.e. SERVER) project are public.

How To Ask For Help

Please include all of the following information when opening an issue:

  • Detailed steps to reproduce the problem, including full traceback, if possible.

  • The exact python version used, with patch level:

    $ python -c "import sys; print(sys.version)"
    
  • The exact version of PyMongo used, with patch level:

    $ python -c "import pymongo; print(pymongo.version); print(pymongo.has_c())"
    
  • The operating system and version (e.g. Windows 7, OSX 10.8, ...)

  • Web framework or asynchronous network library used, if any, with version (e.g. Django 1.7, mod_wsgi 4.3.0, gevent 1.0.1, Tornado 4.0.2, ...)

Security Vulnerabilities

If you’ve identified a security vulnerability in a driver or any other MongoDB project, please report it according to the instructions here.

Installation

PyMongo can be installed with pip:

$ python -m pip install pymongo

Or easy_install from setuptools:

$ python -m easy_install pymongo

You can also download the project source and do:

$ python setup.py install

Do not install the "bson" package from pypi. PyMongo comes with its own bson package; doing "easy_install bson" installs a third-party package that is incompatible with PyMongo.

Dependencies

PyMongo supports CPython 2.7, 3.4+, PyPy, and PyPy3.5+.

Optional dependencies:

GSSAPI authentication requires pykerberos on Unix or WinKerberos on Windows. The correct dependency can be installed automatically along with PyMongo:

$ python -m pip install pymongo[gssapi]

Support for mongodb+srv:// URIs requires dnspython:

$ python -m pip install pymongo[srv]

TLS / SSL support may require ipaddress and certifi or wincertstore depending on the Python version in use. The necessary dependencies can be installed along with PyMongo:

$ python -m pip install pymongo[tls]

Wire protocol compression with snappy requires python-snappy:

$ python -m pip install pymongo[snappy]

You can install all dependencies automatically with the following command:

$ python -m pip install pymongo[snappy,gssapi,srv,tls]

Other optional packages:

  • backports.pbkdf2, improves authentication performance with SCRAM-SHA-1 and SCRAM-SHA-256. It especially improves performance on Python versions older than 2.7.8.
  • monotonic adds support for a monotonic clock, which improves reliability in environments where clock adjustments are frequent. Not needed in Python 3.

Additional dependencies are:

  • (to generate documentation) sphinx

Examples

Here's a basic example (for more see the examples section of the docs):

>>> import pymongo
>>> client = pymongo.MongoClient("localhost", 27017)
>>> db = client.test
>>> db.name
u'test'
>>> db.my_collection
Collection(Database(MongoClient('localhost', 27017), u'test'), u'my_collection')
>>> db.my_collection.insert_one({"x": 10}).inserted_id
ObjectId('4aba15ebe23f6b53b0000000')
>>> db.my_collection.insert_one({"x": 8}).inserted_id
ObjectId('4aba160ee23f6b543e000000')
>>> db.my_collection.insert_one({"x": 11}).inserted_id
ObjectId('4aba160ee23f6b543e000002')
>>> db.my_collection.find_one()
{u'x': 10, u'_id': ObjectId('4aba15ebe23f6b53b0000000')}
>>> for item in db.my_collection.find():
...     print(item["x"])
...
10
8
11
>>> db.my_collection.create_index("x")
u'x_1'
>>> for item in db.my_collection.find().sort("x", pymongo.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 sphinx installed to generate the documentation. Documentation can be generated by running python setup.py doc. Generated documentation can be found in the doc/build/html/ directory.

Testing

The easiest way to run the tests is to run python setup.py test in the root of the distribution.

To verify that PyMongo works with Gevent's monkey-patching:

$ python green_framework_test.py gevent

Or with Eventlet's:

$ python green_framework_test.py eventlet