PYTHON-1144 - Add Atlas / PyMongo 2.x usage guide

This commit is contained in:
Bernie Hackett 2016-09-29 11:54:48 -07:00
parent 500db80aa0
commit 989a40ade5
2 changed files with 42 additions and 0 deletions

35
doc/atlas.rst Normal file
View File

@ -0,0 +1,35 @@
Using PyMongo 2.x with MongoDB Atlas
====================================
`Atlas <https://www.mongodb.com/cloud>`_ is MongoDB, Inc's hosted MongoDB as a
service offering. The following steps are required to securely connect to Atlas
with PyMongo 2.x.
.. warning:: These directions **MUST** be followed carefully to ensure a secure
connection is used.
First, install `certifi <https://pypi.python.org/pypi/certifi>`_::
$ python -m pip install certifi
To connect to Atlas, pass the connection string provided by Atlas to
:class:`~pymongo.mongo_client.MongoClient`. You **MUST** provide all of these
options to make a secure connection::
>>> import certifi
>>> import ssl
>>> from pymongo import MongoClient
>>> client = MongoClient(<Atlas connection string>,
... ssl_cert_reqs=ssl.CERT_REQUIRED,
... ssl_ca_certs=certifi.where())
Connections to Atlas using
:class:`~pymongo.mongo_replica_set_client.MongoReplicaSetClient` require the
same options::
>>> import certifi
>>> import ssl
>>> from pymongo import MongoReplicaSetClient
>>> client = MongoReplicaSetClient(<Atlas connection string>,
... ssl_cert_reqs=ssl.CERT_REQUIRED,
... ssl_ca_certs=certifi.where())

View File

@ -19,6 +19,12 @@ everything you need to know to use **PyMongo**.
:doc:`examples/index`
Examples of how to perform specific tasks.
:doc:`atlas`
Using PyMongo 2.x with MongoDB Atlas.
:doc:`examples/tls`
Using PyMongo 2.x with TLS / SSL.
:doc:`faq`
Some questions that come up often.
@ -86,6 +92,7 @@ Indices and tables
.. toctree::
:hidden:
atlas
installation
tutorial
examples/index