zscaler-sdk-python 0.1.0__tar.gz → 0.1.1__tar.gz

zscaler-sdk-python-0.1.1/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Zscaler Python SDK Changelog
+
+## 0.1.1 (April, 19 2024)
+
+### Notes
+
+- Python Versions: **v3.8, v3.9, v3.10, v3.11**
+
+### Internal Changes
+* Refactored `setup.py` for better packaging and improved long description through README.md ([#57](https://github.com/zscaler/zscaler-sdk-python/pull/57))
+* Refactored Integration Tests by removing `async` decorators ([#63](https://github.com/zscaler/zscaler-sdk-python/pull/63))
+
+
+## 0.1.0 (April, 18 2024)
+
+### Notes
+
+- Python Versions: **v3.8, v3.9, v3.10, v3.11**
+
+🎉 **Initial Release** 🎉

{zscaler-sdk-python-0.1.0 → zscaler-sdk-python-0.1.1}/MANIFEST.in

@@ -1,4 +1,4 @@
-include CHANGELOG.md LICENSE.md README.md LONG_DESCRIPTION.md tox.ini requirements.txt
+include CHANGELOG.md LICENSE.md README.md tox.ini requirements.txt
 
 recursive-include tests *
 recursive-exclude * __pycache__

{zscaler-sdk-python-0.1.0/zscaler_sdk_python.egg-info → zscaler-sdk-python-0.1.1}/PKG-INFO

@@ -1,70 +1,145 @@
 Metadata-Version: 2.1
 Name: zscaler-sdk-python
-Version: 0.1.0
-Summary: Official Python SDK for the Zscaler Products
-Home-page: https://github.com/zscaler/zscaler-sdk-python
-Author: Zscaler Technology Alliances
+Version: 0.1.1
+Summary: Official Python SDK for the Zscaler Products (Beta)
+Home-page: https://zscaler-sdk-python.readthedocs.io
+Author: Zscaler, Inc.
 Author-email: devrel@zscaler.com
+Keywords: zscaler,sdk,zpa,zia,zdx,zcc,zcon
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8,<4.0
 Description-Content-Type: text/markdown
+Provides-Extra: dev
 License-File: LICENSE.md
 
-# Official Python SDK for the Zscaler Products
+# Official Python SDK for the Zscaler Products (Beta)
 
-[![CI/CD](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/ci.yml)
-[![Documentation Status](https://readthedocs.org/projects/zscaler-sdk-python/badge/?version=latest)](https://zscaler-sdk-python.readthedocs.io/en/latest/?badge=latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dw/zscaler-sdk-python)](https://pypistats.org/packages/zscaler-sdk-python)
 [![License](https://img.shields.io/github/license/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python)
+[![Documentation Status](https://readthedocs.org/projects/zscaler-sdk-python/badge/?version=latest)](https://zscaler-sdk-python.readthedocs.io/en/latest/?badge=latest)
 [![Latest version released on PyPi](https://img.shields.io/pypi/v/zscaler-sdk-python.svg)](https://pypi.org/project/zscaler-sdk-python)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler-sdk-python.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
-[![GitHub Release](https://img.shields.io/github/release/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python/releases/)
 [![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)
 
 ## Support Disclaimer
 
--> **Disclaimer:** Please refer to our [General Support Statement](docs/guides/support.md) before proceeding with the use of this provider. You can also refer to our [troubleshooting guide](docs/guides/troubleshooting.md) for guidance on typical problems.
+-> **Disclaimer:** Please refer to our [General Support Statement](docsrc/zs/guides/support.rst) before proceeding with the use of this provider. You can also refer to our [troubleshooting guide](docsrc/zs/guides/troubleshooting.rst) for guidance on typical problems.
 
 ## Zscaler Python SDK Overview
 
-This repository contains the Zscaler SDK for Python. This SDK can be used to interact with several Zscaler services such as:
+The Zscaler SDK for Python includes functionality to accelerate development with [Python](https://www.python.org/) several Zscaler services such as:
 
-* Zscaler Private Access (ZPA)
-* Zscaler Internet Access (ZIA)
+* [Zscaler Internet Access (ZIA)](https://help.zscaler.com/zia/getting-started-zia-api)
+* [Zscaler Private Access (ZPA)](https://help.zscaler.com/zpa/getting-started-zpa-api)
 * [Documentation](http://zscaler-sdk-python.readthedocs.io)
 
------
+Each package is supportedd by an individual and robust HTTP client designed to handle failures on different levels by performing intelligent retries.
 
-Each Zscaler product has separate developer documentation and authentication methods. This SDK aims to simplify
-software development using the Zscaler API for both customers and partners.
+**Beta:** This SDK is supported for production use cases, but we do expect future releases to have some interface changes; see [Interface stability](#interface-stability). 
+We are keen to hear feedback from you on these SDKs. Please [file issues](https://github.com/zscaler/zscaler-sdk-python/issues), and we will address them. 
+
+## Contents
 
-- [Release Status](#release-status)
-- [Need help?](#need-help)
 - [Getting Started](#getting-started)
+- [Usage](#usage)
+- [Authentication](#authentication)
 - [Pagination](#pagination)
 - [Logging](#logging)
 - [Rate Limiting](#rate-limiting)
 - [Environment variables](#environment-variables)
 - [Building the SDK](#building-the-sdk)
+- [Interface stability](#interface-stability)
+- [Need help?](#need-help)
 - [Contributing](#contributing)
 
 > Requires Python version 3.8.0 or higher.
 
-## Need help?
+## Getting started<a id="getting-started"></a>
 
-If you run into problems using the SDK, you can:
+To install the Zscaler Python SDK in your project:
+1. Please install Zscaler SDK for Python via `pip install zscaler-sdk-python` and instantiate the respective client based on your project usage:
+- `ZIAClientHelper`
+- `ZPAClientHelper`
 
-- Ask questions on the [Zenith Community][zenith]
-- Post [issues on GitHub][github-issues] (for code errors)
-- Support [customer support portal][zscaler-support]
+Zscaler SDK for Python is compatible with Python 3.7 _(until [June 2023](https://devguide.python.org/versions/))_, 3.8, 3.9, 3.10, and 3.11.
 
-## Getting started
+The upgrade to the latest version of this SDK can be done by executing the following command:
+```python
+%pip install --upgrade zscaler-sdk-python
+```
+followed by
+```python
+dbutils.library.restartPython()
+```
 
-To install the Zscaler Python SDK in your project:
+## Authentication<a id="authentication"></a>
 
-```sh
-pip install zscaler-sdk-python
-```
+Each Zscaler product has separate developer documentation and authentication methods. In this section you will find
+
+1. Credentials that are hard-coded into configuration arguments.
+
+   :warning: **Caution**: Zscaler does not recommend hard-coding credentials into arguments, as they can be exposed in plain text in version control systems. Use environment variables instead.
+
+### ZIA native authentication
+
+- For authentication via Zscaler Internet Access, you must provide `username`, `password`, `api_key` and `cloud`
+
+The ZIA Cloud is identified by several cloud name prefixes, which determines which API endpoint the requests should be sent to. The following cloud environments are supported:
+
+* `zscaler`
+* `zscalerone`
+* `zscalertwo`
+* `zscalerthree`
+* `zscloud`
+* `zscalerbeta`
+* `zscalergov`
+* `zscalerten`
+* `zspreview`
 
-## Usage
+### Environment variables
+
+You can provide credentials via the `ZIA_USERNAME`, `ZIA_PASSWORD`, `ZIA_API_KEY`, `ZIA_CLOUD` environment variables, representing your ZIA `username`, `password`, `api_key` and `cloud` respectively.
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `username`       | _(String)_ A string that contains the email ID of the API admin.| `ZIA_USERNAME` |    
+| `password`       | _(String)_ A string that contains the password for the API admin.| `ZIA_PASSWORD` |
+| `api_key`       | _(String)_ A string that contains the obfuscated API key (i.e., the return value of the obfuscateApiKey() method).| `ZIA_API_KEY` |   
+| `cloud`       | _(String)_ The host and basePath for the cloud services API is `$zsapi.<Zscaler Cloud Name>/api/v1`.| `ZIA_CLOUD` |
+
+### ZPA native authentication
+
+- For authentication via Zscaler Private Access, you must provide `client_id`, `client_secret`, `customer_id` and `cloud`
+
+The ZPA Cloud is identified by several cloud name prefixes, which determines which API endpoint the requests should be sent to. The following cloud environments are supported:
+
+* `PRODUCTION`
+* `ZPATWO`
+* `BETA`
+* `GOV`
+* `GOVUS`
+
+### Environment variables
+
+You can provide credentials via the `ZPA_CLIENT_ID`, `ZPA_CLIENT_SECRET`, `ZPA_CUSTOMER_ID`, `ZPA_CLOUD` environment variables, representing your ZPA `client_id`, `client_secret`, `customer_id` and `cloud` of your ZPA account, respectively.
+
+~> **NOTE** `ZPA_CLOUD` environment variable is required, and is used to identify the correct API gateway where the API requests should be forwarded to.
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `client_id`       | _(String)_ The ZPA API client ID generated from the ZPA console.| `ZPA_CLIENT_ID` |    
+| `client_secret`       | _(String)_ The ZPA API client secret generated from the ZPA console.| `ZPA_CLIENT_SECRET` |
+| `customer_id`       | _(String)_ The ZPA tenant ID found in the Administration > Company menu in the ZPA console.| `ZPA_CUSTOMER_ID` |   
+| `cloud`       | _(String)_ The Zscaler cloud for your tenancy.| `ZPA_CLOUD` |
+
+## Usage<a id="usage"></a>
 
 Before you can interact with any of the Zscaler APIs, you need to generate API keys or retrieve tenancy information for each product that you are interfacing with. Once you have the requirements and you have installed Zscaler SDK Python, you're ready to go.
 
@@ -92,7 +167,7 @@ for app_segment in zpa.app_segments.list_segments():
 
 ~> **NOTE** The `ZPA_CLOUD` environment variable is optional and only required if your project needs to interact with any other ZPA cloud other than production cloud. In this case, use the `ZPA_CLOUD` environment variable followed by the name of the corresponding environment: `ZPA_CLOUD=BETA`, `ZPA_CLOUD=ZPATWO`, `ZPA_CLOUD=GOV`, `ZPA_CLOUD=GOVUS`, `ZPA_CLOUD=PREVIEW`, `ZPA_CLOUD=DEV`.
 
-## Pagination
+## Pagination<a id="pagination"></a>
 
 This SDK provides methods that retrieve a list of resources from the API, which return paginated results due to the volume of data. Each method capable of returning paginated data is prefixed as `list_` and handles the pagination internally by providing an easy interface to iterate through pages. The user does not need to manually fetch each page; instead, they can process items as they iterate through them.
 
@@ -142,7 +217,7 @@ For more details on each pagination parameter see:
 [ZPA Pagination Parameters](zscaler/zpa/README.md)
 [ZIA Pagination Parameters](zscaler/zia/README.md)
 
-## Logging
+## Logging<a id="logging"></a>
 
 The Zscaler SDK Python, provides robust logging for debug purposes.
 Logs are disabled by default and should be enabled explicitly via custom environment variable:
@@ -161,7 +236,7 @@ You should now see logs in your console. Notice that API tokens are **NOT** logg
 
 What it being logged? `requests`, `responses`,  `http errors`, `caching responses`.
 
-### Environment variables
+## Environment variables<a id="environment-variables"></a>
 
 Each one of the configuration values above can be turned into an environment variable name with the `_` (underscore) character and UPPERCASE characters. The following are accepted:
 
@@ -171,7 +246,7 @@ Each one of the configuration values above can be turned into an environment var
 - `ZSCALER_SDK_LOG` - Turn on logging
 - `ZSCALER_SDK_VERBOSE` - Turn on logging in verbose mode
 
-## Rate Limiting
+## Rate Limiting<a id="rate-limiting"></a>
 
 Zscaler provides unique rate limiting numbers for each individual product. Regardless of the product, a 429 response will be returned if too many requests are made within a given time. 
 Please see:
@@ -190,17 +265,24 @@ Retry Conditions: The client for both ZPA and ZIA retries a request under the fo
 
 * Exceptions during request execution: Any requests.RequestException encountered during the request triggers a retry, except on the last attempt, where the exception is raised.
 
-## Building the SDK
+## Building the SDK<a id="building-the-sdk"></a>
 
 In most cases, you won't need to build the SDK from source. If you want to build it yourself, you'll need these prerequisites:
 
 - Clone the repo
 - Run `make build:dist` from the root of the project (assuming Python is installed)
-- Ensure tests run succesfully. 
+- Ensure tests run succesfully by executing `make test-simple`
 - Install `tox` if not installed already using: `pip install tox`. 
 - Run tests using `tox` in the root directory of the project.
 
-## Contributing
+## Interface stability<a id="interface-stability"></a>
+
+Zscaler is actively working on stabilizing the Zscaler SDK for Python's interfaces.  
+You are highly encouraged to pin the exact dependency version and read the [changelog](https://github.com/zscaler/zscaler-sdk-python/blob/master/CHANGELOG.md) 
+where Zscaler documents the changes. Zscaler may have minor [documented](https://github.com/zscaler/zscaler-sdk-python/blob/master/CHANGELOG.md)
+backward-incompatible changes, such as renaming some type names to bring more consistency.
+
+## Contributing<a id="contributing"></a>
 
 At this moment we are not accepting contributions, but we welcome suggestions on how to improve this SDK or feature requests, which can then be added in  future releases.
 
@@ -210,6 +292,14 @@ At this moment we are not accepting contributions, but we welcome suggestions on
 [rate-limiting-zpa]: https://help.zscaler.com/zpa/understanding-rate-limiting
 [rate-limiting-zia]: https://help.zscaler.com/zia/understanding-rate-limiting
 
+## Need help?<a id="need-help"></a>
+
+If you run into problems using the SDK, you can:
+
+- Ask questions on the [Zenith Community][zenith]
+- Post [issues on GitHub][github-issues] (for code errors)
+- Support [customer support portal][zscaler-support]
+
 Contributors
 ------------
 

zscaler-sdk-python-0.1.0/PKG-INFO → zscaler-sdk-python-0.1.1/README.md

@@ -1,70 +1,124 @@
-Metadata-Version: 2.1
-Name: zscaler-sdk-python
-Version: 0.1.0
-Summary: Official Python SDK for the Zscaler Products
-Home-page: https://github.com/zscaler/zscaler-sdk-python
-Author: Zscaler Technology Alliances
-Author-email: devrel@zscaler.com
-Requires-Python: >=3.8,<4.0
-Description-Content-Type: text/markdown
-License-File: LICENSE.md
-
-# Official Python SDK for the Zscaler Products
-
-[![CI/CD](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/ci.yml/badge.svg)](https://github.com/zscaler/zscaler-sdk-python/actions/workflows/ci.yml)
-[![Documentation Status](https://readthedocs.org/projects/zscaler-sdk-python/badge/?version=latest)](https://zscaler-sdk-python.readthedocs.io/en/latest/?badge=latest)
+# Official Python SDK for the Zscaler Products (Beta)
+
+[![PyPI - Downloads](https://img.shields.io/pypi/dw/zscaler-sdk-python)](https://pypistats.org/packages/zscaler-sdk-python)
 [![License](https://img.shields.io/github/license/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python)
+[![Documentation Status](https://readthedocs.org/projects/zscaler-sdk-python/badge/?version=latest)](https://zscaler-sdk-python.readthedocs.io/en/latest/?badge=latest)
 [![Latest version released on PyPi](https://img.shields.io/pypi/v/zscaler-sdk-python.svg)](https://pypi.org/project/zscaler-sdk-python)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/zscaler-sdk-python.svg)](https://pypi.python.org/pypi/zscaler-sdk-python/)
-[![GitHub Release](https://img.shields.io/github/release/zscaler/zscaler-sdk-python.svg)](https://github.com/zscaler/zscaler-sdk-python/releases/)
 [![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)
 
 ## Support Disclaimer
 
--> **Disclaimer:** Please refer to our [General Support Statement](docs/guides/support.md) before proceeding with the use of this provider. You can also refer to our [troubleshooting guide](docs/guides/troubleshooting.md) for guidance on typical problems.
+-> **Disclaimer:** Please refer to our [General Support Statement](docsrc/zs/guides/support.rst) before proceeding with the use of this provider. You can also refer to our [troubleshooting guide](docsrc/zs/guides/troubleshooting.rst) for guidance on typical problems.
 
 ## Zscaler Python SDK Overview
 
-This repository contains the Zscaler SDK for Python. This SDK can be used to interact with several Zscaler services such as:
+The Zscaler SDK for Python includes functionality to accelerate development with [Python](https://www.python.org/) several Zscaler services such as:
 
-* Zscaler Private Access (ZPA)
-* Zscaler Internet Access (ZIA)
+* [Zscaler Internet Access (ZIA)](https://help.zscaler.com/zia/getting-started-zia-api)
+* [Zscaler Private Access (ZPA)](https://help.zscaler.com/zpa/getting-started-zpa-api)
 * [Documentation](http://zscaler-sdk-python.readthedocs.io)
 
------
+Each package is supportedd by an individual and robust HTTP client designed to handle failures on different levels by performing intelligent retries.
 
-Each Zscaler product has separate developer documentation and authentication methods. This SDK aims to simplify
-software development using the Zscaler API for both customers and partners.
+**Beta:** This SDK is supported for production use cases, but we do expect future releases to have some interface changes; see [Interface stability](#interface-stability). 
+We are keen to hear feedback from you on these SDKs. Please [file issues](https://github.com/zscaler/zscaler-sdk-python/issues), and we will address them. 
+
+## Contents
 
-- [Release Status](#release-status)
-- [Need help?](#need-help)
 - [Getting Started](#getting-started)
+- [Usage](#usage)
+- [Authentication](#authentication)
 - [Pagination](#pagination)
 - [Logging](#logging)
 - [Rate Limiting](#rate-limiting)
 - [Environment variables](#environment-variables)
 - [Building the SDK](#building-the-sdk)
+- [Interface stability](#interface-stability)
+- [Need help?](#need-help)
 - [Contributing](#contributing)
 
 > Requires Python version 3.8.0 or higher.
 
-## Need help?
+## Getting started<a id="getting-started"></a>
 
-If you run into problems using the SDK, you can:
+To install the Zscaler Python SDK in your project:
+1. Please install Zscaler SDK for Python via `pip install zscaler-sdk-python` and instantiate the respective client based on your project usage:
+- `ZIAClientHelper`
+- `ZPAClientHelper`
 
-- Ask questions on the [Zenith Community][zenith]
-- Post [issues on GitHub][github-issues] (for code errors)
-- Support [customer support portal][zscaler-support]
+Zscaler SDK for Python is compatible with Python 3.7 _(until [June 2023](https://devguide.python.org/versions/))_, 3.8, 3.9, 3.10, and 3.11.
+
+The upgrade to the latest version of this SDK can be done by executing the following command:
+```python
+%pip install --upgrade zscaler-sdk-python
+```
+followed by
+```python
+dbutils.library.restartPython()
+```
 
-## Getting started
+## Authentication<a id="authentication"></a>
 
-To install the Zscaler Python SDK in your project:
+Each Zscaler product has separate developer documentation and authentication methods. In this section you will find
 
-```sh
-pip install zscaler-sdk-python
-```
+1. Credentials that are hard-coded into configuration arguments.
+
+   :warning: **Caution**: Zscaler does not recommend hard-coding credentials into arguments, as they can be exposed in plain text in version control systems. Use environment variables instead.
+
+### ZIA native authentication
 
-## Usage
+- For authentication via Zscaler Internet Access, you must provide `username`, `password`, `api_key` and `cloud`
+
+The ZIA Cloud is identified by several cloud name prefixes, which determines which API endpoint the requests should be sent to. The following cloud environments are supported:
+
+* `zscaler`
+* `zscalerone`
+* `zscalertwo`
+* `zscalerthree`
+* `zscloud`
+* `zscalerbeta`
+* `zscalergov`
+* `zscalerten`
+* `zspreview`
+
+### Environment variables
+
+You can provide credentials via the `ZIA_USERNAME`, `ZIA_PASSWORD`, `ZIA_API_KEY`, `ZIA_CLOUD` environment variables, representing your ZIA `username`, `password`, `api_key` and `cloud` respectively.
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `username`       | _(String)_ A string that contains the email ID of the API admin.| `ZIA_USERNAME` |    
+| `password`       | _(String)_ A string that contains the password for the API admin.| `ZIA_PASSWORD` |
+| `api_key`       | _(String)_ A string that contains the obfuscated API key (i.e., the return value of the obfuscateApiKey() method).| `ZIA_API_KEY` |   
+| `cloud`       | _(String)_ The host and basePath for the cloud services API is `$zsapi.<Zscaler Cloud Name>/api/v1`.| `ZIA_CLOUD` |
+
+### ZPA native authentication
+
+- For authentication via Zscaler Private Access, you must provide `client_id`, `client_secret`, `customer_id` and `cloud`
+
+The ZPA Cloud is identified by several cloud name prefixes, which determines which API endpoint the requests should be sent to. The following cloud environments are supported:
+
+* `PRODUCTION`
+* `ZPATWO`
+* `BETA`
+* `GOV`
+* `GOVUS`
+
+### Environment variables
+
+You can provide credentials via the `ZPA_CLIENT_ID`, `ZPA_CLIENT_SECRET`, `ZPA_CUSTOMER_ID`, `ZPA_CLOUD` environment variables, representing your ZPA `client_id`, `client_secret`, `customer_id` and `cloud` of your ZPA account, respectively.
+
+~> **NOTE** `ZPA_CLOUD` environment variable is required, and is used to identify the correct API gateway where the API requests should be forwarded to.
+
+| Argument     | Description | Environment variable |
+|--------------|-------------|-------------------|
+| `client_id`       | _(String)_ The ZPA API client ID generated from the ZPA console.| `ZPA_CLIENT_ID` |    
+| `client_secret`       | _(String)_ The ZPA API client secret generated from the ZPA console.| `ZPA_CLIENT_SECRET` |
+| `customer_id`       | _(String)_ The ZPA tenant ID found in the Administration > Company menu in the ZPA console.| `ZPA_CUSTOMER_ID` |   
+| `cloud`       | _(String)_ The Zscaler cloud for your tenancy.| `ZPA_CLOUD` |
+
+## Usage<a id="usage"></a>
 
 Before you can interact with any of the Zscaler APIs, you need to generate API keys or retrieve tenancy information for each product that you are interfacing with. Once you have the requirements and you have installed Zscaler SDK Python, you're ready to go.
 
@@ -92,7 +146,7 @@ for app_segment in zpa.app_segments.list_segments():
 
 ~> **NOTE** The `ZPA_CLOUD` environment variable is optional and only required if your project needs to interact with any other ZPA cloud other than production cloud. In this case, use the `ZPA_CLOUD` environment variable followed by the name of the corresponding environment: `ZPA_CLOUD=BETA`, `ZPA_CLOUD=ZPATWO`, `ZPA_CLOUD=GOV`, `ZPA_CLOUD=GOVUS`, `ZPA_CLOUD=PREVIEW`, `ZPA_CLOUD=DEV`.
 
-## Pagination
+## Pagination<a id="pagination"></a>
 
 This SDK provides methods that retrieve a list of resources from the API, which return paginated results due to the volume of data. Each method capable of returning paginated data is prefixed as `list_` and handles the pagination internally by providing an easy interface to iterate through pages. The user does not need to manually fetch each page; instead, they can process items as they iterate through them.
 
@@ -142,7 +196,7 @@ For more details on each pagination parameter see:
 [ZPA Pagination Parameters](zscaler/zpa/README.md)
 [ZIA Pagination Parameters](zscaler/zia/README.md)
 
-## Logging
+## Logging<a id="logging"></a>
 
 The Zscaler SDK Python, provides robust logging for debug purposes.
 Logs are disabled by default and should be enabled explicitly via custom environment variable:
@@ -161,7 +215,7 @@ You should now see logs in your console. Notice that API tokens are **NOT** logg
 
 What it being logged? `requests`, `responses`,  `http errors`, `caching responses`.
 
-### Environment variables
+## Environment variables<a id="environment-variables"></a>
 
 Each one of the configuration values above can be turned into an environment variable name with the `_` (underscore) character and UPPERCASE characters. The following are accepted:
 
@@ -171,7 +225,7 @@ Each one of the configuration values above can be turned into an environment var
 - `ZSCALER_SDK_LOG` - Turn on logging
 - `ZSCALER_SDK_VERBOSE` - Turn on logging in verbose mode
 
-## Rate Limiting
+## Rate Limiting<a id="rate-limiting"></a>
 
 Zscaler provides unique rate limiting numbers for each individual product. Regardless of the product, a 429 response will be returned if too many requests are made within a given time. 
 Please see:
@@ -190,17 +244,24 @@ Retry Conditions: The client for both ZPA and ZIA retries a request under the fo
 
 * Exceptions during request execution: Any requests.RequestException encountered during the request triggers a retry, except on the last attempt, where the exception is raised.
 
-## Building the SDK
+## Building the SDK<a id="building-the-sdk"></a>
 
 In most cases, you won't need to build the SDK from source. If you want to build it yourself, you'll need these prerequisites:
 
 - Clone the repo
 - Run `make build:dist` from the root of the project (assuming Python is installed)
-- Ensure tests run succesfully. 
+- Ensure tests run succesfully by executing `make test-simple`
 - Install `tox` if not installed already using: `pip install tox`. 
 - Run tests using `tox` in the root directory of the project.
 
-## Contributing
+## Interface stability<a id="interface-stability"></a>
+
+Zscaler is actively working on stabilizing the Zscaler SDK for Python's interfaces.  
+You are highly encouraged to pin the exact dependency version and read the [changelog](https://github.com/zscaler/zscaler-sdk-python/blob/master/CHANGELOG.md) 
+where Zscaler documents the changes. Zscaler may have minor [documented](https://github.com/zscaler/zscaler-sdk-python/blob/master/CHANGELOG.md)
+backward-incompatible changes, such as renaming some type names to bring more consistency.
+
+## Contributing<a id="contributing"></a>
 
 At this moment we are not accepting contributions, but we welcome suggestions on how to improve this SDK or feature requests, which can then be added in  future releases.
 
@@ -210,6 +271,14 @@ At this moment we are not accepting contributions, but we welcome suggestions on
 [rate-limiting-zpa]: https://help.zscaler.com/zpa/understanding-rate-limiting
 [rate-limiting-zia]: https://help.zscaler.com/zia/understanding-rate-limiting
 
+## Need help?<a id="need-help"></a>
+
+If you run into problems using the SDK, you can:
+
+- Ask questions on the [Zenith Community][zenith]
+- Post [issues on GitHub][github-issues] (for code errors)
+- Support [customer support portal][zscaler-support]
+
 Contributors
 ------------
 

zscaler-sdk-python-0.1.1/docsrc/Makefile

@@ -0,0 +1,24 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+github:
+	@make html
+	@cp -a _build/html/. ../docs
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+

{zscaler-sdk-python-0.1.0 → zscaler-sdk-python-0.1.1}/docsrc/conf.py

@@ -14,9 +14,8 @@
 #
 import os
 import sys
-import zscaler
 
-sys.path.insert(0, os.path.abspath("../"))
+sys.path.insert(0, os.path.abspath('..'))
 
 # Check if building documentation on RTD
 on_rtd = os.environ.get("READTHEDOCS", None) == "True"
@@ -29,9 +28,9 @@ author = "Zscaler Technology Alliances"
 html_title = ""
 
 # The short X.Y version
-version = '0.1.0'
+version = '0.1.1'
 # The full version, including alpha/beta/rc tags
-release = '0.1.0'
+release = '0.1.1'
 
 # -- General configuration ---------------------------------------------------
 
@@ -115,7 +114,7 @@ html_static_path = []
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "Zscalerdoc"
+htmlhelp_basename = "zscalerdoc"
 
 # -- Options for LaTeX output ------------------------------------------------
 
@@ -141,7 +140,7 @@ latex_documents = [
     (
         master_doc,
         "Zscaler.tex",
-        "Zscaler Documentation",
+        "Zscaler SDK Python Documentation",
         "Zscaler Technology Alliances",
         "manual",
     ),
@@ -195,7 +194,6 @@ epub_exclude_files = ["search.html"]
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "restfly": ("https://restfly.readthedocs.io/en/latest/", None),
-    "box": ("https://box.readthedocs.io/en/latest", None),
 }
 
 # -- Options for todo extension ----------------------------------------------

{zscaler-sdk-python-0.1.0 → zscaler-sdk-python-0.1.1}/docsrc/index.rst

@@ -2,7 +2,7 @@
    :description lang=en:
         Official Zscaler Python  SDK that provides a simple and uniform interface for each of the Zscaler product APIs.
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :hidden:
    :caption: Contents
 
@@ -10,7 +10,7 @@
    zs/zpa/index
    zs/guides/index
 
-Zscaler SDK Python - Library Reference
+Zscaler SDK Python (Beta) - Library Reference
 =====================================================================
 Zscaler SDK Python is an SDK that provides a uniform and easy-to-use interface for each of the Zscaler product APIs.
 
@@ -49,7 +49,7 @@ This repository contains the Zscaler SDK for Python. This SDK can be used to int
 - :doc:`Zscaler Private Access (ZPA) <zs/zpa/index>`
 - :doc:`Zscaler Internet Access (ZIA) <zs/zia/index>`
 
-* `Documentation <https://://zscaler-sdk-python.readthedocs.io>`_
+* `Documentation <https://zscaler-sdk-python.readthedocs.io>`_
 
 Installation
 ==============

{zscaler-sdk-python-0.1.0 → zscaler-sdk-python-0.1.1}/docsrc/zs/guides/support.rst

@@ -13,7 +13,6 @@ Support Ticket Severity
 -----------------------
 
 Support tickets related to the GO SDK can be opened with `Zscaler Support <https://help.zscaler.com/login-tickets>`_, however since the SDK is just a client of the underlying product API, we will **NOT** be able to treat SDK related support requests as a Severity-1 (Immediate time frame).
-
 When reporting bugs, please provide the Terraform script that demonstrates the bug and the command output. Stack traces will also be helpful.
 
 Notice that we will **NOT**, however, fix bugs upon customer demand, as we have to prioritize all pending bugs and features, as part of the product's backlog and release cycles.
@@ -24,4 +23,5 @@ Contact
 -------
 
 For questions or requests that cannot be submitted via GitHub Issues, please contact ``devrel@zscaler.com`` with "Zscaler-SDK-GO" in the subject line.
-We also provide a `private Slack channel <https://docs.google.com/forms/d/e/1FAIpQLSfkd3EMkLQdIWMNQ7QCr8TrH_xVSwSYcQshfBPDEZFOaF28qA/viewform?usp=sf_link>`_ where you can submit your questions to the SDK maintainers. Notice that this form will be reviewed and approved by Zscaler Technology Alliances team.
+We also provide a `private Slack channel <https://docs.google.com/forms/d/e/1FAIpQLSfkd3EMkLQdIWMNQ7QCr8TrH_xVSwSYcQshfBPDEZFOaF28qA/viewform?usp=sf_link>`_ 
+where you can submit your questions to the SDK maintainers. Notice that this form will be reviewed and approved by Zscaler Technology Alliances team.

{zscaler-sdk-python-0.1.0 → zscaler-sdk-python-0.1.1}/docsrc/zs/zia/index.rst

@@ -9,4 +9,7 @@ This package covers the ZIA interface.
     *
 
 .. automodule:: zscaler.zia
-    :members:
+    :members:
+    :undoc-members:
+    :show-inheritance:
+