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
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
Release files for pydocumentdb 2.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| pydocumentdb-2.0.1.zip | 147.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pydocumentdb-2.0.1-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 232.6 kB
Release files / pydocumentdb-2.0.1.zip
| Download URL | pydocumentdb-2.0.1.zip |
|---|---|
| Size | 147.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e68a74b461366645c1d124e813dd6111aaebb6e202bbfd72922f0ec8732876c9
|
|
BLAKE2b-256 checksum How to use checksums |
b9aa8a23a247053bcd628c05bb302307d078dc544fa2e633e780627979136f27
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / pydocumentdb-2.0.1-py2-none-any.whl
| Download URL | pydocumentdb-2.0.1-py2-none-any.whl |
|---|---|
| Size | 85.5 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
44d8b810652239d6e3e8b2aeb696df9eb20334bcfaede8395e0e7d426984e708
|
|
BLAKE2b-256 checksum How to use checksums |
0ddf7c9257f1e1245a02e7a9c48d9e23f4c7ac09675ff8d6880bdb23320cee21
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |