zuul-jobs/roles/ensure-pip/README.rst
Andreas Jaeger 83982f9fb7 nit: Fix missing word in roles/ensure-pip/README.rst
Change-Id: Ibb898d0d50a8dfb79ae1def2d56e39daf1e4ffdb
2020-06-18 13:57:17 +00:00

2.6 KiB

Ensure pip is available

This role is intended install the requirements for the pip module on hosts.

Jobs that also wish to call pip via shell commands directly can also use this to ensure pip is available. However, it should be noted that calling pip is ambiguous when supporting many platforms. On some platforms it may install the package under the Python 2 interpreter and in others Python 3. You should use a qualified name (pip2 or pip3) to avoid confusion.

This role will also install wheel components sufficient to run bdist_wheel builds or pip wheel on a source tree.

Role Variables

Output Variables

This variable will be set to a command appropriate for general usage with the pip module virtualenv_command argument on the host. On Python 3 hosts this will be the inbuilt venv module, on Python 2 hosts the virtualenv package will be installed (this is avoided on Python 3 hosts as an unnecessary dependency).