Class: Ansible::Ruby::Modules::Pip

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Pip

Defined in:

lib/ansible/ruby/modules/generated/packaging/language/pip.rb

Overview

Manage Python library dependencies. To use this module, one of the following keys is required: C(name) or C(requirements).

Instance Method Summary

• #chdir ⇒ Object^?

  Cd into this directory before running the command.

• #editable ⇒ :yes, ...

  Pass the editable flag.

• #executable ⇒ String^?

  The explicit executable or a pathname to the executable to be used to run pip for a specific version of Python installed in the system.

• #extra_args ⇒ String^?

  Extra arguments passed to pip.

• #name ⇒ Array<String>, ...

  The name of a Python library to install or the url(bzr+,hg+,git+,svn+) of the remote package.,This can be a list (since 2.2) and contain version specifiers (since 2.7).

• #requirements ⇒ String^?

  The path to a pip requirements file, which should be local to the remote system.

• #state ⇒ :absent, ...

  The state of module,The ‘forcereinstall’ option is only available in Ansible 2.1 and above.

• #umask ⇒ String^?

  The system umask to apply before installing the pip package.

• #version ⇒ Object^?

  The version number to install of the Python library specified in the I(name) parameter.

• #virtualenv ⇒ String^?

  An optional path to a I(virtualenv) directory to install into.

• #virtualenv_command ⇒ String^?

  The command or a pathname to the command to create the virtual environment with.

• #virtualenv_python ⇒ Object^?

  The Python executable used for creating the virtual environment.

• #virtualenv_site_packages ⇒ :yes, ...

  Whether the virtual environment will inherit packages from the global site-packages directory.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#chdir ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 50

attribute :chdir

#editable ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 46

attribute :editable

#executable ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 53

attribute :executable

#extra_args ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 42

attribute :extra_args

#name ⇒ Array<String>, ...

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 12

attribute :name

#requirements ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 19

attribute :requirements

#state ⇒ :absent, ...

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 38

attribute :state

#umask ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 57

attribute :umask

#version ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 16

attribute :version

#virtualenv ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 23

attribute :virtualenv

#virtualenv_command ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 31

attribute :virtualenv_command

#virtualenv_python ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 35

attribute :virtualenv_python

#virtualenv_site_packages ⇒ :yes, ...

# File 'lib/ansible/ruby/modules/generated/packaging/language/pip.rb', line 27

attribute :virtualenv_site_packages