Metadata-Version: 2.1
Name: zsdk
Version: 1.1.3.1
Summary: Unofficial Python SDK for Zscaler public API endpoints.
Author: Ryan Ulrick
Author-email: rulrick@zscaler.com
Requires-Python: >=3.9
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: urllib3 (>=2.0.4,<3.0.0)
Description-Content-Type: text/markdown

# Zscaler SDK (zsdk)

The Zscaler SDK (zsdk) is a Python library designed to provide an easy and programmatic way to interact with publicly available Zscaler API endpoints. With zsdk, developers can manage and automate tasks across Zscaler's suite of security services, including Zscaler Internet Access (ZIA), Zscaler Private Access (ZPA), and Zscaler Digital Experience (ZDX).

## Features

- Comprehensive coverage of Zscaler's public API.
- Easy-to-use Pythonic interfaces.
- Examples and guides to get started quickly.
- Easy to use Docker files to build container with zsdk pre-installed.

## Installation

You can install zsdk via pip:

```bash
pip install zsdk
```

## Getting Started

Here's a quick example to get you started with ZIA:

```python
from zsdk.zia import ZIA
zscaler = ZIA(username='YOUR_USERNAME', password='YOUR_PASSWORD', api_key='YOUR_API_KEY', cloud_name="zscaler.net")
print(zscaler.locations.list())
```

See the [examples](https://github.com/SYNically-ACKward/zsdk/tree/main/examples) directory for more comprehensive examples and the [documentation](https://help.zscaler.com/zia/getting-started-zia-api) for detailed API reference.

## Using Docker

See the [Docker instruction and discussion](docs/docker.md) documentation.  We provide instructions on how to load 
zsdk into a container using either this repos' version or the PyPi hosted version of zsdk.  We also provide 
instructions on how to do so using `docker` or `docker-compose` methods.

## Support and Contributions

For questions, issues, or contributions, please see the [CONTRIBUTING.md](https://github.com/SYNically-ACKward/zsdk/blob/1bfe49df609474e7820274460238fac2288d3964/CONTRIBUTING.md) file.

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/SYNically-ACKward/zsdk/blob/1bfe49df609474e7820274460238fac2288d3964/LICENSE) file for details.

