Documentation

easy_install - Installs Python libraries

Synopsis

  • Installs Python libraries, optionally in a virtualenv

Options

parameter required default choices comments
executable
(added in 1.3)
no
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.
name
yes
A Python library name
state
(added in 2.0)
no present
  • present
  • latest
The desired state of the library. latest ensures that the latest version is installed.
virtualenv
no
an optional virtualenv directory path to install into. If the virtualenv does not exist, it is created automatically
virtualenv_command
no virtualenv
The command to create the virtual environment with. For example pyvenv, virtualenv, virtualenv2.
virtualenv_site_packages
no no
  • yes
  • no
Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created.

Examples

# Examples from Ansible Playbooks
- easy_install:
    name: pip
    state: latest

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

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 pip module which you can first install using easy_install.
  • Also note that virtualenv must be installed on the remote host if the virtualenv parameter is specified.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.