From 41e524eb583e0114e962a9612b653b00bc7133e6 Mon Sep 17 00:00:00 2001 From: Matt Wright Date: Fri, 10 Aug 2012 10:35:27 -0400 Subject: [PATCH] Add notes about easy_install and pip --- rst/modules.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/rst/modules.rst b/rst/modules.rst index 46d0c5852a..c436e31ca5 100644 --- a/rst/modules.rst +++ b/rst/modules.rst @@ -213,14 +213,14 @@ Example action from Ansible :doc:`playbooks`:: -.. _easyinstall: +.. _easy_install: easy_install ```````````` .. versionadded:: 0.7 -The easy_install module installs Python libraries. +The easy_install module installs Python libraries. +--------------------+----------+---------+----------------------------------------------------------------------------+ | parameter | required | default | comments | @@ -231,9 +231,16 @@ The easy_install module installs Python libraries. | | | | does not exist it is created automatically | +--------------------+----------+---------+----------------------------------------------------------------------------+ +Please note that the easy_install command can only install Python libraries. +Thus this module is not able to remove libraries. It is generally recommended to +use the :ref:`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. + Example action from Ansible :doc:`playbooks`:: - easy_install name=flask + easy_install name=pip easy_install name=flask==0.8 easy_install name=flask virtualenv=/srv/webapps/my_app/venv @@ -576,6 +583,9 @@ Manages Python library dependencies. | state | no | present | 'present', 'absent' or 'latest' | +--------------------+----------+---------+----------------------------------------------------------------------------+ +Please note that `virtualenv `_ must be installed on +the remote host if the `virtualenv` parameter is specified. + Examples:: pip name=flask