Skip to main content

Azure DocumentDB Python SDK

Project description

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pydocumentdb, version 2.0.1
Filename, size File type Python version Upload date Hashes
Filename, size pydocumentdb-2.0.1-py2-none-any.whl (85.5 kB) File type Wheel Python version 2.7 Upload date Hashes View
Filename, size pydocumentdb-2.0.1.zip (147.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page