Class: PoisePython::Resources::PipRequirements::Resource

Inherits:
Chef::Resource
  • Object
show all
Includes:
PythonCommandMixin
Defined in:
lib/poise_python/resources/pip_requirements.rb

Overview

A pip_requirements resource to install packages from a requirements.txt file using pip.

Examples:

pip_requirements '/opt/myapp/requirements.txt'

Since:

  • 1.0.0

Provides:

  • pip_requirements

Actions:

  • install

  • upgrade

Instance Attribute Summary collapse

Instance Attribute Details

#cwd ⇒ String

Directory to run pip from. Defaults to the folder containing the requirements.txt.

Returns:

  • (String) 


53
 
# File 'lib/poise_python/resources/pip_requirements.rb', line 53

attribute(:cwd, kind_of: String, default: lazy { default_cwd })

#group ⇒ String, ...

System group to install the package.

Returns:

  • (String, Integer, nil) 


57
 
# File 'lib/poise_python/resources/pip_requirements.rb', line 57

attribute(:group, kind_of: [String, Integer, NilClass])

#options ⇒ String, ...

Options string to be used with pip install.

Returns:

  • (String, nil, false) 


61
 
# File 'lib/poise_python/resources/pip_requirements.rb', line 61

attribute(:options, kind_of: [String, NilClass, FalseClass])

#path ⇒ String

Path to the requirements file, or a folder containing the requirements file.

Returns:

  • (String) 


48
 
# File 'lib/poise_python/resources/pip_requirements.rb', line 48

attribute(:path, kind_of: String, name_attribute: true)

#user ⇒ String, ...

System user to install the package.

Returns:

  • (String, Integer, nil) 


65
 
# File 'lib/poise_python/resources/pip_requirements.rb', line 65

attribute(:user, kind_of: [String, Integer, NilClass])