ReleaseEngineering/PuppetAgain/Modules/python: Difference between revisions

no edit summary
No edit summary
No edit summary
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
This module handles installing Python virtualenvs containing Python packages.  See [[ReleaseEngineering/How To/Install a Python Virtualenv with Puppet]] for a tutorial reference to using the module.
This module handles all things Python.


= Usage =
= python::user_pip_conf =
 
This define sets up a .pip/pip.conf for the named user that directs pip to install from the [[ReleaseEngineering/PuppetAgain/Python|python]] repository, including searching all puppetmasters in case one is down.  It takes an optional ''$homedir'' to specify the user's homedir, with the default being in ''/home''.  This define should generally be used from ''user'' module classes.  See e.g., ''user::root'' for an example.
 
= python::virtualenv =
 
This class installs Python virtualenvs containing Python packages.  See [[ReleaseEngineering/How To/Install a Python Virtualenv with Puppet]] for a tutorial reference to using the module.
 
== Usage ==


The main interface used here is <tt>python::virtualenv</tt>.  It takes the following parameters:
The main interface used here is <tt>python::virtualenv</tt>.  It takes the following parameters:
Line 7: Line 15:
;python: The python to use to build the virtualenv (mandatory)
;python: The python to use to build the virtualenv (mandatory)
;ensure: present (default) or absent
;ensure: present (default) or absent
;require: resources to require before making the virtualenv (e.g., your preferred python)
;packages: array of packages to include, in the format ''pkgname==version''.  Include all required packages - dependencies are not followed.  Running ''pip freeze'' in a test virtualenv can help determine this list (mandatory)
;packages: array of packages to include, in the format ''pkgname==version''.  Include all required packages - dependencies are not followed.  Running ''pip freeze'' in a test virtualenv can help determine this list (mandatory)
;user: user that should own the virtualenv (default root/admin)
;user: user that should own the virtualenv (default root/admin)
Line 12: Line 21:
Note that the python, user, and group attributes only have an effect when the virtualenv is created.  Packages can be added to the packages list, or their versions changed, but removing a package from the list will not result in puppet removing it from the virtualenv.
Note that the python, user, and group attributes only have an effect when the virtualenv is created.  Packages can be added to the packages list, or their versions changed, but removing a package from the list will not result in puppet removing it from the virtualenv.


= Example =
You can add dependencies on a virtualenv using the ''->'' operator.
 
== Example ==
   python::virtualenv {
   python::virtualenv {
       "/path/to/virtualenv":
       "/path/to/virtualenv":
canmove, Confirmed users
1,394

edits