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


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.

Source Distribution

pydocumentdb-1.9.0.zip (93.7 kB view details)

Uploaded Source

Built Distribution

pydocumentdb-1.9.0-py2-none-any.whl (48.8 kB view details)

Uploaded Python 2

File details

Details for the file pydocumentdb-1.9.0.zip.

File metadata

  • Download URL: pydocumentdb-1.9.0.zip
  • Upload date:
  • Size: 93.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for pydocumentdb-1.9.0.zip
Algorithm Hash digest
SHA256 63ea3a660f2f2a6da57ca873f9c156852e661d616a9cfb6d5d69f66fc0cbcf78
MD5 4a7e4ce8fb6dccc4c6e7a0196bb02366
BLAKE2b-256 04dc41771ea02468c57f368fcce164d6c4de962f1c1b55e420e597eba64b7a7e

See more details on using hashes here.

File details

Details for the file pydocumentdb-1.9.0-py2-none-any.whl.

File metadata

File hashes

Hashes for pydocumentdb-1.9.0-py2-none-any.whl
Algorithm Hash digest
SHA256 95ec0697c805533ca72decd69436f18f49018bcadb7bbcc2a95829628c33cd4c
MD5 782c750df90d6111ef252cf1546af3d5
BLAKE2b-256 c6df8a10450d2e0d0bf5bf55c3dadd1b60c610643c1572ce532df6824d91ce99

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page