community.general.pip_package_info – pip package information

Note

This plugin is part of the community.general collection (version 1.3.6).

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.pip_package_info.

Synopsis

  • Return information about installed pip packages

Requirements

The below requirements are needed on the host that executes this module.

  • The requested pip executables must be installed on the target.

Parameters

Parameter Choices/Defaults Comments
clients
list / elements=string
Default:
["pip"]
A list of the pip executables that will be used to get the packages. They can be supplied with the full path or just the executable name, i.e `pip3.7`.

Examples

- name: Just get the list from default pip
  community.general.pip_package_info:

- name: Get the facts for default pip, pip2 and pip3.6
  community.general.pip_package_info:
    clients: ['pip', 'pip2', 'pip3.6']

- name: Get from specific paths (virtualenvs?)
  community.general.pip_package_info:
    clients: '/home/me/projec42/python/pip3.5'

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
packages
dictionary
always
a dictionary of installed package data
 
python
dictionary
always
A dictionary with each pip client which then contains a list of dicts with python package information

Sample:
{'packages': {'pip': {'Babel': [{'name': 'Babel', 'source': 'pip', 'version': '2.6.0'}], 'Flask': [{'name': 'Flask', 'source': 'pip', 'version': '1.0.2'}], 'Flask-SQLAlchemy': [{'name': 'Flask-SQLAlchemy', 'source': 'pip', 'version': '2.3.2'}], 'Jinja2': [{'name': 'Jinja2', 'source': 'pip', 'version': '2.10'}]}}}


Authors

  • Matthew Jones (@matburt)

  • Brian Coca (@bcoca)

  • Adam Miller (@maxamillion)