Package Installation

Follow a method within this section of the guide to help you install the pyclearpass package.

🚧

Python Requirements

Ensure Python v3.9 or greater is installed on your operating system

Method 1 - Installing Package from PyPi

Run the following in a command line terminal to install the pip package directly from Pypi- pip3 install pyclearpass or pip install pyclearpass. This may vary between operating systems. The PyPi repository is located here for reference - https://pypi.org/project/pyclearpass/

Method 2 - Installing Package from Github (not using Git executable)

1. Click into the Aruba Github Repository where the latest version of pyclearpass is located
2. Click Code (in green) and Download to Zip
3. Extract the zip file into a directory
4. Go into a command line terminal and change directory (cd) into the folder where you extracted the zipped file and then down one child folder. The folder contents should pyclearpass (FOLDER), LICENCE, pyproject.toml and README.md
5. In your command line terminal type python3 -m build or python -m build. This will create a folder called dist with a file containing a .gz extension.
6. Run the following in a command line terminal to install the pip package - pip3 install pathtozip.gz or pip install pathtozip.gz. This may vary between Operating Systems.

Method 3 - Installing Package from Github (using Git executable)

1. Install Git for your Operating System from https://git-scm.com/download
2. Run the following in a command line terminal to install the pip package - pip3 install git+https://github.com/aruba/pyclearpass or pip install git+https://github.com/aruba/pyclearpass. This may vary between Operating Systems.