.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "AZURE-COSMOS" "1" "Nov 01, 2022" "3.1.1" "azure-cosmos"
.SH NAME
azure-cosmos \- azure-cosmos 3.1.1
.SH SYSTEM REQUIREMENTS:
.INDENT 0.0
.INDENT 3.5
The supported Python versions are 2.7, 3.3, 3.4 and 3.5. To download Python, please visit \fI\%https://www.python.org/download/releases\fP\&.
.sp
Python Tools for Visual Studio is required when using Microsoft Visual
Studio to develop Python applications. To download Python Tools for Visual Studio, please visit \fI\%http://microsoft.github.io/PTVS\fP\&.
.UNINDENT
.UNINDENT
.SH INSTALLATION:
.INDENT 0.0
.INDENT 3.5
Method 1:
.INDENT 0.0
.IP 1. 3
Download the Azure Cosmos Python SDK source from
\fI\%https://github.com/Azure/azure\-cosmos\-python\fP which is needed to manage the Azure Cosmos database service.
.IP 2. 3
Execute the following setup script in bash shell:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
$ python setup.py install
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.sp
Method 2:
.INDENT 0.0
.IP 1. 3
Install the Azure Cosmos Python SDK using pip.
For more information on pip, please visit \fI\%https://pypi.python.org/pypi/pip\fP
.IP 2. 3
Execute the following in bash shell:
.INDENT 3.0
.INDENT 3.5
.sp
.nf
.ft C
$ pip install azure\-cosmos
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.SH TO RUN TESTS:
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ python \-m unittest discover \-s .\etest \-p "*.py"
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
If you use Microsoft Visual Studio, open the project file python.pyproj,
and run all the tests in Test Explorer.
.UNINDENT
.UNINDENT
.SH TO GENERATE DOCUMENTATIONS:
.INDENT 0.0
.INDENT 3.5
Install Sphinx: \fI\%http://sphinx\-doc.org/install.html\fP
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ cd doc
$ sphinx\-apidoc \-f \-e \-o api ..\eazure
$ make.bat html
.ft P
.fi
.UNINDENT
.UNINDENT
.UNINDENT
.UNINDENT
.INDENT 0.0
.IP \(bu 2
\fI\%Index\fP
.IP \(bu 2
\fI\%Module Index\fP
.IP \(bu 2
\fI\%Search Page\fP
.UNINDENT
.SH COSMOS
.SS cosmos package
.SS Subpackages
.SS cosmos.execution_context package
.SS Submodules
.SS cosmos.execution_context.aggregators module
.SS cosmos.execution_context.base_execution_context module
.SS cosmos.execution_context.document_producer module
.SS cosmos.execution_context.endpoint_component module
.SS cosmos.execution_context.execution_dispatcher module
.SS cosmos.execution_context.multi_execution_aggregator module
.SS cosmos.execution_context.query_execution_info module
.SS Module contents
.SS cosmos.routing package
.SS Submodules
.SS cosmos.routing.collection_routing_map module
.SS cosmos.routing.routing_map_provider module
.SS cosmos.routing.routing_range module
.SS Module contents
.SS Submodules
.SS cosmos.auth module
.SS cosmos.base module
.SS cosmos.consistent_hash_ring module
.SS cosmos.constants module
.SS cosmos.cosmos_client module
.SS cosmos.default_retry_policy module
.SS cosmos.documents module
.SS cosmos.endpoint_discovery_retry_policy module
.SS cosmos.errors module
.SS cosmos.global_endpoint_manager module
.SS cosmos.hash_partition_resolver module
.SS cosmos.http_constants module
.SS cosmos.location_cache module
.SS cosmos.murmur_hash module
.SS cosmos.partition module
.SS cosmos.query_iterable module
.SS cosmos.range module
.SS cosmos.range_partition_resolver module
.SS cosmos.request_object module
.SS cosmos.resource_throttle_retry_policy module
.SS cosmos.retry_options module
.SS cosmos.retry_utility module
.SS cosmos.runtime_constants module
.SS cosmos.session module
.SS cosmos.session_retry_policy module
.SS cosmos.synchronized_request module
.SS cosmos.utils module
.SS cosmos.vector_session_token module
.SS Module contents
.SH AUTHOR
unknown
.SH COPYRIGHT
2022, Microsoft
.\" Generated by docutils manpage writer.
.