README

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


    If you use Microsoft Visual Studio as IDE (we use 2013), please install the
    following extension for Python.
    http://pytools.codeplex.com/wikipage?title=PTVS%20Installation


1) Installation:

    $ python setup.py install

    or

    $ pip install pydocumentdb


2) To run tests:

    $ python test/crud_tests.py

    If you use Microsoft Visual Studio, open the project file python.pyproj,
    and press F5.


3) To generate documentations:

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

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