Installation

The KAPPA Python SDK requires Python 3.12.0 and the same major version is used by KAPPA-Automate when executing user tasks. To run the SDK locally, it is advised to use the same Python distribution as what is installed on the server.

The Python SDK itself is distributed with your KAPPA-Automate installation and can be installed using pip.

$ pip install --trusted-host your-ka-instance --extra-index-url https://your-ka-instance/pi/ kappa-sdk

where “your-ka-instance” is replaced by the name of your KAPPA-Automate instance.

All dependencies will be automatically installed if installing the kappa-sdk package through pip.

The SDK should work with earlier versions of Python, but we do not guarantee compatibility with versions prior to Python 3.12.0.

Note

It is recommended to use a virtual environment to manage your Python dependencies and avoid conflicts with other projects. You can create and activate a virtual environment as follows:

$ python -m venv myenv
$ source myenv/bin/activate  # On Windows use `myenv\Scripts\activate`

Then, proceed with the installation of the KAPPA-Automate Python SDK within the virtual environment.

Manual Installation: If you prefer, you can manually download the tar.gz file and install the package. First, download the file from your KAPPA-Automate instance, then run:

$ pip install kappa_sdk-6.20.2492.tar.gz

Reinstallation: To ensure the package is installed or reinstalled even if it is already present, use the following command:

$ pip install --trusted-host your-ka-instance --extra-index-url https://your-ka-instance/pi/ kappa-sdk --force-reinstall

Troubleshooting: If you encounter any issues during installation, ensure that your pip is up to date:

$ pip install --upgrade pip