community.general.pipx_info module – Rretrieves information about applications installed with pipx
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.pipx_info
.
New in community.general 5.6.0
Synopsis
Retrieve details about Python applications installed in isolated virtualenvs using pipx.
Aliases: packaging.language.pipx_info
Parameters
Parameter |
Comments |
---|---|
Path to the If not specified, the module will use |
|
Include dependent packages in the output. Choices:
|
|
Include injected packages in the output. Choices:
|
|
Returns the raw output of The raw output is not affected by Choices:
|
|
Name of an application installed with |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
This module does not install the
pipx
python package, however that can be easily done with the module ansible.builtin.pip.This module does not require
pipx
to be in the shellPATH
, but it must be loadable by Python as a module.This module will honor
pipx
environment variables such as but not limited toPIPX_HOME
andPIPX_BIN_DIR
passed using the environment Ansible keyword.This module requires
pipx
version 0.16.2.1 or above.Please note that
pipx
requires Python 3.6 or above.See also the
pipx
documentation at https://pypa.github.io/pipx/.
Examples
- name: retrieve all installed applications
community.general.pipx_info: {}
- name: retrieve all installed applications, include dependencies and injected packages
community.general.pipx_info:
include_deps: true
include_injected: true
- name: retrieve application tox
community.general.pipx_info:
name: tox
include_deps: true
- name: retrieve application ansible-lint, include dependencies
community.general.pipx_info:
name: ansible-lint
include_deps: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The list of installed applications Returned: success |
|
The dependencies of the installed application, when Returned: success Sample: |
|
The injected packages for the installed application, when Returned: success Sample: |
|
The name of the installed application. Returned: success Sample: |
|
The version of the installed application. Returned: success Sample: |
|
Command executed to obtain the list of installed applications. Returned: success Sample: |
|
The raw output of the Returned: success |