Skip to content

index.rst

Latest commit

 

History

History
110 lines (85 loc) · 2.86 KB

index.rst

File metadata and controls

110 lines (85 loc) · 2.86 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.

.. 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:`atlas`
Using PyMongo with MongoDB Atlas.
:doc:`examples/tls`
Using PyMongo with TLS / SSL.
:doc:`faq`
Some questions that come up often.
:doc:`migrate-to-pymongo3`
A PyMongo 2.x to 3.x migration guide.
:doc:`python3`
Frequently asked questions about python 3 support.
:doc:`compatibility-policy`
Explanation of deprecations, and how to keep pace with changes in PyMongo's API.
: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.
:doc:`developer/index`
Developer guide for contributors to PyMongo.

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.

Changes

See the :doc:`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

.. toctree::
   :hidden:

   atlas
   installation
   tutorial
   examples/index
   faq
   compatibility-policy
   api/index
   tools
   contributors
   changelog
   python3
   migrate-to-pymongo3
   developer/index