Skip to main content

Azure DocumentDB Python SDK

Project description

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

Welcome to DocumentDB.


0) Pre-requirements:

Python 2.7, Python 3.3, Python 3.4, or Python 3.5
https://www.python.org/download/releases

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 -f -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-2.1.0.zip (154.1 kB view details)

Uploaded Source

Built Distribution

pydocumentdb-2.1.0-py2-none-any.whl (87.8 kB view details)

Uploaded Python 2

File details

Details for the file pydocumentdb-2.1.0.zip.

File metadata

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

File hashes

Hashes for pydocumentdb-2.1.0.zip
Algorithm Hash digest
SHA256 385788542e8a04684268bb9179da3066516f278e13ac1d12da91644dfa962947
MD5 02041695b421581ccfc1004fcd6bcad2
BLAKE2b-256 693c739a9d4acae3e17116e9ab880b059d422ee0c97a5d231d3cd9fd19124d80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for pydocumentdb-2.1.0-py2-none-any.whl
Algorithm Hash digest
SHA256 3806942ca775ae9ad86e53ac2a608ac48c5cf31e05cab817284560d1d761d307
MD5 86dd653c6fee69da470759ac9091b9de
BLAKE2b-256 7ac5d76044b9c4b52cb5c6e069a88b6c80b8ed9bf6bd79deec41ca8beed8a94a

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