community.general.easy_install module – Installs Python libraries

Note

This module is part of the community.general collection (version 10.7.5).

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. You need further requirements to be able to use this module, see Requirements for details.

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

Synopsis

  • Installs Python libraries, optionally in a virtualenv.

Requirements

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

  • virtualenv

Parameters

Parameter

Comments

executable

string

The explicit executable or a pathname to the executable to be used to run easy_install for a specific version of Python installed in the system. For example easy_install-3.3, if there are both Python 2.7 and 3.3 installations in the system and you want to run easy_install for the Python 3.3 installation.

Default: "easy_install"

name

string / required

A Python library name.

state

string

The desired state of the library. latest ensures that the latest version is installed.

Choices:

  • "present" ← (default)

  • "latest"

virtualenv

string

An optional virtualenv directory path to install into. If the virtualenv does not exist, it is created automatically.

virtualenv_command

string

The command to create the virtual environment with. For example pyvenv, virtualenv, virtualenv2.

Default: "virtualenv"

virtualenv_site_packages

boolean

Whether the virtual environment inherits packages from the global site-packages directory. Note that this setting has no effect on an already existing virtual environment, so if you want to change it, the environment must be deleted and newly created.

Choices:

  • false ← (default)

  • true

Attributes

Attribute

Support

Description

check_mode

Support: full

Can run in check_mode and return changed status prediction without modifying target.

diff_mode

Support: none

Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Notes

Note

  • Please note that the easy_install module can only install Python libraries. Thus this module is not able to remove libraries. It is generally recommended to use the ansible.builtin.pip module which you can first install using community.general.easy_install.

  • Also note that virtualenv must be installed on the remote host if the virtualenv parameter is specified.

Examples

- name: Install or update pip
  community.general.easy_install:
    name: pip
    state: latest

- name: Install Bottle into the specified virtualenv
  community.general.easy_install:
    name: bottle
    virtualenv: /webapps/myapp/venv

- name: Install a python package using pyvenv as the virtualenv tool
  community.general.easy_install:
    name: package_name
    virtualenv: /opt/myenv
    virtualenv_command: pyvenv

Authors

  • Matt Wright (@mattupstate)