Skip to content

Commit

Permalink
fix: Updated requirements.txt and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
willguibr committed May 24, 2024
1 parent a815905 commit f2c28c6
Show file tree
Hide file tree
Showing 5 changed files with 252 additions and 77 deletions.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,24 @@ This collection contains modules and plugins to assist in automating the configu
This collection is tested with the most current Ansible releases. Ansible versions
before 2.15 are **not supported**.

## Python Version
## Python dependencies

The minimum python version for this collection is python `3.9`.

The Python module dependencies are not automatically handled by `ansible-galaxy`. To manually install these dependencies, you have the following options:

1. Utilize the `requirements.txt` file located [here](https://github.com/zscaler/ziacloud-ansible/blob/master/requirements.txt) to install all required packages:

```bash
pip install -r requirements.txt
```

2. Alternatively, install the [Zscaler SDK Python](https://pypi.org/project/zscaler-sdk-python/) package directly:

```bash
pip install zscaler-sdk-python
```

## Installation

Install this collection using the Ansible Galaxy CLI:
Expand Down
21 changes: 19 additions & 2 deletions docs/source/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,26 @@
Requirements
==========================

The **Zscaler Internet Access Collection** has the following requirements in order to be successfully used:
The **Zscaler Internet Access Collection** has the following requirements in order to be successfully used.

* **zscaler-sdk-python**
Python dependencies
----------------------

The minimum python version for this collection is python `3.9`.

The Python module dependencies are not automatically handled by `ansible-galaxy`. To manually install these dependencies, you have the following options:

1. Utilize the `requirements.txt` file located `here <https://github.com/zscaler/ziacloud-ansible/blob/master/requirements.txt>`_ to install all required packages:

```bash
pip install -r requirements.txt
```

2. Alternatively, install the `Zscaler SDK Python <https://pypi.org/project/zscaler-sdk-python/>`_ package directly:

```bash
pip install zscaler-sdk-python
```

If you believe you have installed these dependencies but Ansible is not finding them, it is likely a
problem with where your local shell is searching for installed dependencies and where Ansible is
Expand Down
117 changes: 70 additions & 47 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 9 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,16 @@ zscaler-sdk-python = ">=0.1.7"
xmltodict = "^0.12.0"
aiohttp = ">=3.9.0"
dpath = "^2.1.5"
pytz = "*"
netaddr = "*"
pycountry = "*"
pytz = ">=2024.1"
netaddr = ">=1.2.1"
pycountry = ">=23.12.11"
sphinx-ansible-theme = "^0.10.3"
python-box = "^7.1.1"

[tool.poetry.dev-dependencies]
black = "24.3.0"
pytest = "*"
coverage = "4.5.4"
pytest = "^8.2.1"
coverage = ">=4.5.4"
pylint = "2.13.*"
pytest-xdist = "*"
pytest-mock = "*"
Expand All @@ -43,10 +43,11 @@ six = "*"
pycodestyle = "*"

# from requirements.txt
certifi = "^2023.11.17"
chardet = "3.0.4"
certifi = ">=2023.11.17"
chardet = ">=5.2.0"
idna = "3.7"
requests = "^2.22.0"
requests = ">=2.22.0"
urllib3 = ">=2.0"

[build-system]
requires = ["poetry>=0.12"]
Expand Down
Loading

0 comments on commit f2c28c6

Please sign in to comment.