Skip to content

Commit cd8c2a9

Browse files
authored
Merge pull request #421 from tprestegard/master
Updated README for python::virtualenv
2 parents 5626f9c + 9b168b0 commit cd8c2a9

1 file changed

Lines changed: 30 additions & 15 deletions

File tree

README.md

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -167,37 +167,52 @@ Creates Python virtualenv.
167167

168168
**requirements** - Path to pip requirements.txt file. Default: none
169169

170-
**proxy** - Proxy server to use for outbound connections. Default: none
171-
172170
**systempkgs** - Copy system site-packages into virtualenv. Default: don't
173171

172+
**venv_dir** - The location of the virtualenv if resource path not specified. Must be absolute path. Default: resource name
173+
174+
**ensure_venv_dir** - Create virtualenv directory. Default: true
175+
174176
**distribute** - Include distribute in the virtualenv. Default: true
175177

176-
**venv_dir** - The location of the virtualenv if resource path not specified. Must be absolute path. Default: resource name
178+
**index** - Base URL of Python package index. Default: none
177179

178180
**owner** - Specify the owner of this virtualenv
179181

180182
**group** - Specify the group for this virtualenv
181183

182-
**index** - Base URL of Python package index. Default: none
184+
**mode** - Specify the directory mode. Default: 0755
185+
186+
**proxy** - Proxy server to use for outbound connections. Default: none
187+
188+
**environment** - Additional environment variables required to install the packages. Default: none
189+
190+
**path** - Set the $PATH environment variable. Default: [ '/bin', '/usr/bin', '/usr/sbin' ]
183191

184192
**cwd** - The directory from which to run the "pip install" command. Default: undef
185193

186194
**timeout** - The maximum time in seconds the "pip install" command should take. Default: 1800
187195

196+
**pip_args** - Arguments to pass to pip during installation. Default: blank
197+
198+
**extra_pip_args** - Arguments to pass to pip for package install. These are included in the pip command *after* the requirements file. Default: blank
199+
188200
```puppet
189201
python::virtualenv { '/var/www/project1' :
190-
ensure => present,
191-
version => 'system',
192-
requirements => '/var/www/project1/requirements.txt',
193-
proxy => 'http://proxy.domain.com:3128',
194-
systempkgs => true,
195-
distribute => false,
196-
venv_dir => '/home/appuser/virtualenvs',
197-
owner => 'appuser',
198-
group => 'apps',
199-
cwd => '/var/www/project1',
200-
timeout => 0,
202+
ensure => present,
203+
version => 'system',
204+
requirements => '/var/www/project1/requirements.txt',
205+
systempkgs => true,
206+
venv_dir => '/home/appuser/virtualenvs',
207+
ensure_venv_dir => false,
208+
distribute => false,
209+
index => 'appuser',
210+
owner => 'appuser',
211+
group => 'apps',
212+
proxy => 'http://proxy.domain.com:3128',
213+
cwd => '/var/www/project1',
214+
timeout => 0,
215+
extra_pip_args => '--no-binary :none:',
201216
}
202217
```
203218

0 commit comments

Comments
 (0)