Platform installation for Python 3
The Splunk SOAR installation includes a Python 3 runtime environment.
If you are developing an app, supports apps written in Python 3. Python 2 is not supported.
Python installation path
Only Python 3 is included in the platform installation.
- The path to Python 3 is
- For Splunk SOAR (Cloud) installations,
A symlink to
<SOAR_HOME>/opt/phantom/usr/bin/python3 is included for convenience. Splunk SOAR (Cloud) uses this symlink to access Python.
Pip installation path
Pip 3 is included in the platform for installing Python 3 packages.
Pip 3 is included in
A symlink to pip 3,
<SOAR_HOME>/usr/bin/pip3 is included. Splunk SOAR (Cloud) uses this symlink to access pip 3.
App development script installation path
This entire section refers to scripts and CLI/SSH items which are not available in Splunk SOAR (Cloud).
The following scripts and commands are included in the platform for developing Python 3 apps:
Compatible Python 3 scripts
Scripts that are compatible with Python 3 are included in the following location:
- For Splunk SOAR (Cloud) deployments,
- For Splunk SOAR ((On-premises) privileged deployments prior to release 5.4.0,
- For Splunk SOAR (On-premises) unprivileged deployments,
<SOAR_HOME>is configured by your Splunk SOAR Administrator.
- The path to scripts is
Run the scripts using
phenv python3 as follows:
[phantom@phantom phipinfoio]$ phenv python <SOAR_HOME>/bin/<script>.pyc
Convert apps from Python 2 to Python 3
This documentation applies to the following versions of Splunk® SOAR (Cloud): current