pydocumentdb 2.0.0

Azure DocumentDB Python SDK

This is the README of the Python driver for Microsoft Azure DocumentDB.

Welcome to DocumentDB.


0) Pre-requirements:

Python 2.7
https://www.python.org/download/releases/2.7

or

Python 3.4
https://www.python.org/download/releases/3.4.5/

If you use Microsoft Visual Studio as IDE (we use 2015), please install the
following extension for Python.
http://microsoft.github.io/PTVS/


1) Installation:

$ python setup.py install

or

$ pip install pydocumentdb


2) Testing:

Most of the test files under test sub-folder require you to enter your Azure DocumentDB master key and host endpoint:

masterKey = '[YOUR_KEY_HERE]'
host = '[YOUR_ENDPOINT_HERE]'

To run the tests:

$ python -m unittest discover -s .\test -p "*.py"

If you use Microsoft Visual Studio, open the project file python.pyproj,
and run all the tests in Test Explorer.

**Note:**
Most of the test cases create collections in your DocumentDB account. Collections are billing entities. By running these test cases, you may incur monetary costs on your account.


3) To generate documentations:

Install Sphinx: http://sphinx-doc.org/install.html

$ cd doc
$ sphinx-apidoc -e -o .\api ..\pydocumentdb
$ make.bat html