Class: Ansible::Ruby::Modules::Easy_install

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/packaging/language/easy_install.rb

Overview

Installs Python libraries, optionally in a I(virtualenv)

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

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

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

Constructor Details

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

Instance Method Details

#executable ⇒ Object?

Returns The explicit executable or a pathname to the executable to be used to run easy_install for a specific version of Python installed in the system. For example C(easy_install-3.3), if there are both Python 2.7 and 3.3 installations in the system and you want to run easy_install for the Python 3.3 installation.

Returns:

  • (Object, nil) —

    The explicit executable or a pathname to the executable to be used to run easy_install for a specific version of Python installed in the system. For example C(easy_install-3.3), if there are both Python 2.7 and 3.3 installations in the system and you want to run easy_install for the Python 3.3 installation.



28
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/easy_install.rb', line 28

attribute :executable

#name ⇒ String

Returns A Python library name.

Returns:

  • (String) —

    A Python library name



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

attribute :name

#state ⇒ :present, ...

Returns The desired state of the library. C(latest) ensures that the latest version is installed.

Returns:

  • (:present, :latest, nil) —

    The desired state of the library. C(latest) ensures that the latest version is installed.



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

attribute :state

#virtualenv ⇒ String?

Returns an optional I(virtualenv) directory path to install into. If the I(virtualenv) does not exist, it is created automatically.

Returns:

  • (String, nil) —

    an optional I(virtualenv) directory path to install into. If the I(virtualenv) does not exist, it is created automatically



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

attribute :virtualenv

#virtualenv_command ⇒ String?

Returns The command to create the virtual environment with. For example C(pyvenv), C(virtualenv), C(virtualenv2).

Returns:

  • (String, nil) —

    The command to create the virtual environment with. For example C(pyvenv), C(virtualenv), C(virtualenv2).



24
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/easy_install.rb', line 24

attribute :virtualenv_command

#virtualenv_site_packages ⇒ :yes, ...

Returns Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created.

Returns:

  • (:yes, :no, nil) —

    Whether the virtual environment will inherit packages from the global site-packages directory. Note that if this setting is changed on an already existing virtual environment it will not have any effect, the environment must be deleted and newly created.



20
 
# File 'lib/ansible/ruby/modules/generated/packaging/language/easy_install.rb', line 20

attribute :virtualenv_site_packages