Ansible Role: Pip (for Python)

An Ansible Role that installs Pip on Linux.

Requirements

On RedHat/CentOS, you may need to have EPEL installed before running this role. You can use the geerlingguy.repo-epel role if you need a simple way to ensure it's installed.

Role Variables

Available variables are listed below, along with default values (see defaults/main.yml):

pip_package: python3-pip

The name of the package to install to get pip on the system. For older systems that don't have Python 3 available, you can set this to python-pip.

pip_executable: pip3

The role will try to autodetect the pip executable based on the pip_package (e.g. pip for Python 2 and pip3 for Python 3). You can also override this explicitly, e.g. pip_executable: pip3.6.

pip_install_packages: []

A list of packages to install with pip. Examples below:

pip_install_packages:
  # Specify names and versions.
  - name: docker
    version: "1.2.3"
  - name: awscli
    version: "1.11.91"

  # Or specify bare packages to get the latest release.
  - docker
  - awscli

  # Or uninstall a package.
  - name: docker
    state: absent

  # Or update a package to the latest version.
  - name: docker
    state: latest

  # Or force a reinstall.
  - name: docker
    state: forcereinstall

  # Or install a package in a particular virtualenv.
  - name: docker
    virtualenv: /my_app/venv

Virtualenv Options

Generally everything regarding virtualenvs can be defined for all packages and/or can be overridden for individual packages.

Variables for all installed packages:

# Path to the virtualenv
pip_virtualenv: /my-app/venv

# Command to create the virtualenv
pip_virtualenv_command: python3 -m venv

# Python version to use in the virtualenv
pip_virtualenv_python: python3.3

Variables per package:

pip_install_packages:
  - name: docker
    virtualenv: /my_docker_app/venv
    virtualenv_command: python3 -m venv
  - name: ansible
    virtualenv: /my_ansible_playbooks/venv
    virtualenv_python: python3.3

Combined example:

pip_virtualenv: /my-default/venv

pip_install_packages:
  - name: requests
  - name: yaml
  - name: docker-compose
    virtualenv: /my_docker_app/venv
    virtualenv_python: python3.8
    state: absent
  - name: docker
    virtualenv: /my_docker_app/venv
    virtualenv_python: python3.8
  - name: ansible
    virtualenv: /my_ansible_playbooks/venv
    virtualenv_command: python3 -m venv
  - name: ansible-lint
    virtualenv: /my_ansible_playbooks/venv
    virtualenv_command: python3 -m venv

Other Variables

Global:

# all packages shall be absent
pip_state: absent

# extra args for pip
pip_extra_args

# set umask
pip_umask

# install other packages for virtualenvs
pip_virtualenv_packages:
  - virtualenv
  - python3-venv

Per package:

pip_install_packages:
  # requests shall be absent
  - name: requests
    state: absent
  # pass extra arguments for yaml package
  - name: yaml
    extra_args: --timeout 60
  # use a different umask for docker-compose
  - name: docker-compose
    umask: "0022"

For detailed information about the options check the documenation of the Ansibl pip module, which is used by this role.

Dependencies

None.

Example Playbook

- hosts: all

  vars:
    pip_install_packages:
      - name: docker
      - name: awscli

  roles:
    - geerlingguy.pip

License

MIT / BSD

Author Information

This role was created in 2017 by Jeff Geerling, author of Ansible for DevOps.