summaryrefslogtreecommitdiff
path: root/lib/ansible/modules/packaging/language
diff options
context:
space:
mode:
authorapmits <apmits@users.noreply.github.com>2017-07-17 08:17:06 +0200
committerRené Moser <mail@renemoser.net>2017-07-17 08:17:06 +0200
commit033a68d453885d40d8a0dd1a1c64a0019abec722 (patch)
tree4bb0bacd97b47870ed035e9e7c893b01ebf8cba9 /lib/ansible/modules/packaging/language
parentd0d2beafbac744c0ddc7e9527ffed0d532301747 (diff)
downloadansible-033a68d453885d40d8a0dd1a1c64a0019abec722.tar.gz
pip: Add example for --user (#26856)
* state type of arguments explicitly * add example for --user argument
Diffstat (limited to 'lib/ansible/modules/packaging/language')
-rw-r--r--lib/ansible/modules/packaging/language/pip.py11
1 files changed, 8 insertions, 3 deletions
diff --git a/lib/ansible/modules/packaging/language/pip.py b/lib/ansible/modules/packaging/language/pip.py
index 0af800bd2c..6015bd25b2 100644
--- a/lib/ansible/modules/packaging/language/pip.py
+++ b/lib/ansible/modules/packaging/language/pip.py
@@ -186,6 +186,11 @@ EXAMPLES = '''
virtualenv: /my_app/venv
virtualenv_command: virtualenv-2.7
+# Install (Bottle) within a user home directory.
+- pip:
+ name: bottle
+ extra_args: --user
+
# Install specified python requirements.
- pip:
requirements: /my_app/requirements.txt
@@ -393,17 +398,17 @@ def main():
state=dict(default='present', choices=state_map.keys()),
name=dict(type='list'),
version=dict(type='str'),
- requirements=dict(),
+ requirements=dict(type='str'),
virtualenv=dict(type='path'),
virtualenv_site_packages=dict(default=False, type='bool'),
virtualenv_command=dict(default='virtualenv', type='path'),
virtualenv_python=dict(type='str'),
use_mirrors=dict(default=True, type='bool'),
- extra_args=dict(),
+ extra_args=dict(type='str'),
editable=dict(default=False, type='bool'),
chdir=dict(type='path'),
executable=dict(type='path'),
- umask=dict(),
+ umask=dict(type='str'),
),
required_one_of=[['name', 'requirements']],
mutually_exclusive=[['name', 'requirements'], ['executable', 'virtualenv']],