From 2f9e3d141e213eb74a1a59eae45ec7800112ebe6 Mon Sep 17 00:00:00 2001 From: Matt Wright Date: Tue, 7 Aug 2012 17:05:21 -0400 Subject: [PATCH] Add pip module documentation --- rst/modules.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/rst/modules.rst b/rst/modules.rst index 8497bb55fa..739739e936 100644 --- a/rst/modules.rst +++ b/rst/modules.rst @@ -494,6 +494,38 @@ from /usr/bin/ansible:: .. postgresql_db: + +.. _pip: + +pip +``` + +Manages Python library dependencies. + ++--------------------+----------+---------+----------------------------------------------------------------------------+ +| parameter | required | default | comments | ++====================+==========+=========+============================================================================+ +| name | no | | The name of a Python library to install | ++--------------------+----------+---------+----------------------------------------------------------------------------+ +| version | no | | The version number to install of the Python library specified in the | +| | | | 'name' parameter | ++--------------------+----------+---------+----------------------------------------------------------------------------+ +| requirements | no | | The path to a pip requirements file | ++--------------------+----------+---------+----------------------------------------------------------------------------+ +| virtualenv | no | | An optional path to a virtualenv directory to install into | ++--------------------+----------+---------+----------------------------------------------------------------------------+ +| state | no | present | 'present', 'absent' or 'latest' | ++--------------------+----------+---------+----------------------------------------------------------------------------+ + +Examples:: + + pip name=flask + pip name=flask version=0.8 + pip name=flask virtualenv=/srv/webapps/my_app/venv + pip requirements=/srv/webapps/my_app/src/requirements.txt + pip requirements=/srv/webapps/my_app/src/requirements.txt virtualenv=/srv/webapps/my_app/venv + + postgresql_db `````````````