Required Python Packages and Versions for AAI CLI Utilities
search cancel

Required Python Packages and Versions for AAI CLI Utilities

book

Article ID: 422736

calendar_today

Updated On:

Products

Automation Analytics & Intelligence

Issue/Introduction

Beginning with AAI version 24.1, the Command Line Interface (CLI) utilities transitioned from Java-based execution to Python 3.x. Users attempting to run CLI commands without the appropriate Python environment or prerequisite libraries will encounter execution errors (e.g., ModuleNotFoundError).

As of AAI 24.3, Python 3.12 or later is the required version.

Check the  AAI compatibility matrix for the required Python version for your AAI release.

Environment

AAI 24.1 and later

Resolution

AAI provides a pre-configured requirements file containing all necessary Python dependencies. These must be installed to ensure the CLI utilities function correctly.

1. Locate the Requirements File The required packages are defined in: <AAI_Install_Dir>/batch/lib/requirements.txt

2. Install Dependencies Use the Python package manager (pip) to install the dependencies. It is recommended to run this from the AAI server or the machine where the CLI is being executed:

Bash
 
# Standard installation command
python3 -m pip install -r "<AAI_Install_Dir>/batch/lib/requirements.txt"

3. Common Required Modules If your environment does not have internet access to pull from PyPI, ensure the following core modules are manually installed and always reference the requirements.txt for the specific versions:

  • six

  • urllib3

  • certifi

  • python-dateutil

Note: Always refer to the AAI Compatibility Matrix for the most up-to-date Python version requirements for your specific release.

 

Additional Information

https://docs.automic.com/tools/compatibility_matrix?compatibility-mode=component&offering_version_id=1750835871471&lifecycle_entity_id=1591012779304