Class: PoisePython::Resources::PythonVirtualenv::Resource

Inherits:
PoisePython::Resources::PythonRuntime::Resource show all
Includes:
PythonCommandMixin
Defined in:
lib/poise_python/resources/python_virtualenv.rb

Overview

A python_virtualenv resource to manage Python virtual environments.

Examples:

python_virtualenv '/opt/myapp'

Since:

  • 1.0.0

Provides:

  • python_virtualenv

Actions:

  • create

  • delete

Instance Attribute Summary collapse

Instance Attribute Details

#group ⇒ String, ...

System group to create the virtualenv.

Returns:

  • (String, Integer, nil) 


49
 
# File 'lib/poise_python/resources/python_virtualenv.rb', line 49

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

#path ⇒ String

Path to create the environment at.

Returns:

  • (String) 


45
 
# File 'lib/poise_python/resources/python_virtualenv.rb', line 45

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

#system_site_packages ⇒ Boolean

Enable or disable visibilty of system packages in the environment.

Returns:

  • (Boolean) 


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

attribute(:system_site_packages, equal_to: [true, false], default: false)

#user ⇒ String, ...

System user to create the virtualenv.

Returns:

  • (String, Integer, nil) 


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

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