Skip to content

RedCraig/azure-documentdb-python

 
 

Repository files navigation

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

Welcome to DocumentDB.

  1. 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://microsoft.github.io/PTVS/

  2. Installation:

    $ python setup.py install

    or

    $ pip install pydocumentdb

  3. Testing:

Some of the test files such as crud_tests.py require you to enter your Azure DocumentDB master key and host endpoint in that file:

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

To run the tests:

$ python test/crud_tests.py

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

Note:
Test cases in crud_tests.py create collections in your DocumentDB account. Collections are billing entities. By running these test cases, you may incur monetary costs on your account.

  1. To generate documentations:

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

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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%