ansible.builtin.easy_install (v2.9.27) — module

Installs Python libraries

| "added in version" 0.7 of ansible.builtin"

Authors: Matt Wright (@mattupstate)

preview | supported by community

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

Installs Python libraries, optionally in a I(virtualenv)


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Examples from Ansible Playbooks
- easy_install:
    name: pip
    state: latest
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Install Bottle into the specified virtualenv.
- easy_install:
    name: bottle
    virtualenv: /webapps/myapp/venv

Inputs

    
name:
    description:
    - A Python library name
    required: true

state:
    choices:
    - present
    - latest
    default: present
    description:
    - The desired state of the library. C(latest) ensures that the latest version is installed.
    version_added: '2.0'
    version_added_collection: ansible.builtin

executable:
    description:
    - 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 C(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.
    version_added: '1.3'
    version_added_collection: ansible.builtin

virtualenv:
    description:
    - an optional I(virtualenv) directory path to install into. If the I(virtualenv) does
      not exist, it is created automatically

virtualenv_command:
    default: virtualenv
    description:
    - The command to create the virtual environment with. For example C(pyvenv), C(virtualenv),
      C(virtualenv2).
    version_added: '1.1'
    version_added_collection: ansible.builtin

virtualenv_site_packages:
    default: 'no'
    description:
    - 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.
    type: bool
    version_added: '1.1'
    version_added_collection: ansible.builtin