cookbook 'pyenv', '= 0.2.0'
pyenv
(30) Versions
0.2.0
-
Follow4
Manages pyenv and its installed Python versions.
cookbook 'pyenv', '= 0.2.0', :supermarket
knife supermarket install pyenv
knife supermarket download pyenv
pyenv Chef Cookbook
This cookbook is aimed to support chef-client v12.9 or beyond. If you have an older version, please use v0.1.4
tag.
Manages installation of multiple Python versions via
pyenv. Also provides a set of lightweight
resources and providers.
If you've used [rbenv][rbenv] before, this is a port of that concept for
Python.
pyenv Installed System-Wide with Pythons
Most likely, this is the typical case. Include recipe[pyenv::system]
in your
run_list and override the defaults you want changed. See below
for more details.
pyenv Installed For A Specific User with Pythons
If you want a per-user install (like on a Mac/Linux workstation for
development, CI, etc.), include recipe[pyenv::user]
in your run_list and
add a user hash to the user_installs
attribute list. For example:
node.default['pyenv']['user_installs'] = [ { 'user' => 'archie', 'pythons' => ['2.7.6', '3.3.2'], 'global' => '2.7.6', } ]
See below for more details.
pyenv Installed System-Wide and LWRPs Defined
If you want to manage your own pyenv environment with the provided
LWRPs, then include recipe[pyenv::system_install]
in your run_list
to prevent a default pyenv Ruby being installed. See the
Resources and Providers section for more details.
pyenv Installed For A Specific User and LWRPs Defined
If you want to manage your own pyenv environment for users with the provided
LWRPs, then include recipe[pyenv::user_install]
in your run_list and add a
user hash to the user_installs
attribute list. For example:
node.default['pyenv']['user_installs'] = [ { 'user' => 'archie' } ]
See the Resources and Providers section for more details.
Ultra-Minimal Access To LWRPs
Simply include recipe[pyenv]
in your run_list and the LWRPs will be
available to use in other cookbooks. See the Resources and Providers
section for more details.
Requirements
Chef
Tested on 11.8.2 but newer and older version should work just
fine. File an [issue][issues] if this isn't the case.
Platform
The following platforms have been tested with this cookbook, meaning that
the recipes and LWRPs run on these platforms without error:
- ubuntu (14.04 / 16.04)
- centos (6.9 / 7.3)
- oracle (7.3)
Welcome any PRs for additional platforms.
Recipes
default
Initializes Chef to use the Lightweight Resources and Providers
([LWRPs][lwrp]).
Use this recipe explicitly if you only want access to the LWRPs provided.
system_install
Installs the pyenv
codebase system-wide (that is, into /usr/local/pyenv
). This
recipe includes default.
Use this recipe by itself if you want pyenv
installed system-wide but want
to handle installing Pythons, invoking LWRPs, etc..
system
Installs the pyenv
codebase system-wide (that is, into /usr/local/pyenv
) and
installs Pythons driven off attribute metadata. This recipe includes default
and system_install.
Use this recipe by itself if you want pyenv
installed system-wide with
Pythons installed.
user_install
Installs the pyenv
codebase for a list of users (selected from the
node['pyenv']['user_installs']
hash). This recipe includes default.
Use this recipe by itself if you want pyenv
installed for specific users in
isolation but want each user to handle installing Pythons, invoking LWRPs, etc.
user
Installs the pyenv codebase for a list of users (selected from the
node['pyenv']['user_installs']
hash) and installs Pythons driven off
attribute metadata. This recipe includes default and user_install.
Use this recipe by itself if you want pyenv
installed for specific users in
isolation with Pythons installed.
Attributes
git_url
The Git URL which is used to install pyenv.
The default is "https://github.com/pyenv/pyenv.git"
.
git_ref
A specific Git branch/tag/reference to use when installing pyenv
. For
example, to pin pyenv
to a specific release:
node.default['pyenv']['git_ref'] = 'master'
The default is 'master'
.
upgrade
Determines how to handle installing updates to the pyenv
. There are currently
2 valid values:
-
"none"
,false
, ornil
: will not updatepyenv
and leave it in its current state. -
"sync"
ortrue
: updatespyenv
to the version specified by thegit_ref
attribute or the head of the master branch by default.
The default is "none"
.
root_path
The path prefix to pyenv
in a system-wide installation.
The default is /usr/local/pyenv
.
pythons
A list of additional system-wide Python versions to be built and installed.
For example:
node.default['pyenv']['pythons'] = [ "2.7.7", "3.3.2" ]
The default is an empty array: []
.
user_pythons
A list of additional system-wide Python versions to be built and installed
per-user when not explicitly set. For example:
node.default['pyenv']['user_pythons'] = [ "2.7.5" ]
The default is an empty array: []
.
create_profiled
The user's shell needs to know about pyenv's location and set up the
PATH
environment variable. This is handled in the
system_install and
user_install recipes by dropping off
/etc/profile.d/pyenv.sh
. However, this requires root privilege,
which means that a user cannot use a "user install" for only their
user.
Set this attribute to false
to skip creation of the
/etc/profile.d/pyenv.sh
template. For example:
node.default['pyenv']['create_profiled'] = false
The default is true
.
Resources and Providers
pyenv_global
This resource sets the global version of Python to be used in all shells.
Actions
Action | Description | Default |
---|---|---|
create | Sets the global version of Python to be used in all shells | Yes |
Attributes
Attribute | Description | Default Value |
---|---|---|
pyenv_version | Name attribute: a version of Python being managed by pyenv. Note: the version of Python must already be installed--this LWRP will not install it automatically | nil |
user | A users's isolated pyenv installation on which to apply an action. The default value of nil denotes a system-wide pyenv installation is being targeted. Note: if specified, the user must already exist |
nil |
root_path | The path prefix to pyenv installation, for example: /opt/pyenv
|
nil |
Examples
Set A Python As Global
pyenv_global "2.7.6"
Set System Python As Global
pyenv_global 'system'
Set A Python As Global For A User
pyenv_global '3.3.2' do user 'archie' end
pyenv_script
This resource is a wrapper for the script
resource which wraps the code block
in an pyenv
-aware environment. See the Opscode
[script resource][script_resource] documentation for more details.
Actions
Action | Description | Default |
---|---|---|
run | Run the script | Yes |
nothing | Do not run this command |
Use action :nothing
to set a command to only run if another resource
notifies it.
Attributes
Attribute | Description | Default Value |
---|---|---|
name | Name attribute: Name of the command to execute | name |
pyenv_version | A version of Python being managed by pyenv | nil |
root_path | The path prefix to pyenv installation, for example: /opt/pyenv
|
nil |
code | Quoted script of code to execute | nil |
creates | A file this command creates - if the file exists, the command will not be run | nil |
cwd | Current working directory to run the command from | nil |
environment | A has of environment variables to set before running this command | nil |
group | A group or group ID that we should change to before running this command | nil |
path | An array of paths to use when searching for the command |
nil , uses system path |
returns | The return value of the command (may be an array of accepted values) - this resource raises an exception if the return value(s) do not match | 0 |
timeout | How many seconds to let the command run before timing out | nil |
user | A users's isolated pyenv installation on which to apply an action. The default value of nil denotes a system-wide pyenv installation is being targeted. Note: if specified, the user must already exist |
nil |
unmask | Umask for files created by the command | nil |
Examples
Run A Rake Task
pyenv_script 'migrate_rails_database' do pyenv_version '2.7.6' user 'deploy' group 'deploy' cwd '/srv/webapp/current' code %{python manage.py syncdb} end
pyenv_rehash
This resource installs shims for all Python binaries known to pyenv
.
Actions
Action | Description | Default |
---|---|---|
run | Run the script | Yes |
nothing | Do not run this command |
Use action :nothing
to set a command to only run if another resource
notifies it.
Attributes
Attribute | Description | Default Value |
---|---|---|
name | Name attribute: Name of the command to execute | name |
user | A users's isolated pyenv installation on which to apply an action. The default value of nil denotes a system-wide pyenv installation is being targeted. Note: if specified, the user must already exist |
nil |
root_path | The path prefix to pyenv installation, for example: /opt/pyenv
|
nil |
Examples
Rehash A System-Wide pyenv
pyenv_rehash 'Doing the rehash dance'
Rehash A User's pyenv
pyenv_rehash "Rehashing archie's pyenv" do user 'archie' end
pyenv_python
This resource installs a specified version of Python.
Actions
Action | Description | Default |
---|---|---|
install | Build and install a Python version | Yes |
reinstall | Force a recompiliation of the Python version from source. The :install action will skip a build if the target install directory already exists |
Attributes
Attribute | Description | Default Value |
---|---|---|
version |
Name attribute: the name of a Python version (e.g. 2.7.6 ) |
nil |
user | A users's isolated pyenv installation on which to apply an action. The default value of nil denotes a system-wide pyenv installation is being targeted. Note: if specified, the user must already exist |
nil |
root_path | The path prefix to pyenv installation, for example: /opt/pyenv
|
nil |
Examples
Install Python 2.7.6
pyenv_python '2.7.6' do action :install end
pyenv_python '2.7.6'
Note: the install action is default, so the second example is a more common
usage.
Reinstall Python
pyenv_python '2.7.6' do action :reinstall end
System-Wide Mac Installation Note
This cookbook takes advantage of managing profile fragments in an
/etc/profile.d
directory, common on most Unix-flavored platforms.
Unfortunately, Mac OS X does not support this idiom out of the box,
so you may need to [modify][mac_profile_d] your user profile.
License and Author
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Dependent cookbooks
This cookbook has no specified dependencies.
Contingent cookbooks
chef-pyenv Changelog
0.1.4
- Updated deprecated methods used in attributes.rb
0.1.0
- Update default pyenv version to v0.4.0-20140516
- Add support for CentOS 6.5
- Install
make
,build-essential
,libssl-dev
,zlib1g-dev
,wget
,curl
, andllvm
on Debian machines
0.0.1
- Initial port of chef-rbenv
Collaborator Number Metric
0.2.0 failed this metric
Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.
Contributing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.2.0 failed this metric
FC009: Resource attribute not recognised: pyenv/providers/script.rb:7
FC069: Ensure standardized license defined in metadata: pyenv/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/global.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/python.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/rehash.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/script.rb:1
Run with Foodcritic Version 12.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
License Metric
0.2.0 passed this metric
No Binaries Metric
0.2.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
pyenv/TAGS
Testing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 passed this metric
0.2.0 failed this metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file
Foodcritic Metric
0.2.0 failed this metric
FC009: Resource attribute not recognised: pyenv/providers/script.rb:7
FC069: Ensure standardized license defined in metadata: pyenv/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/global.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/python.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/rehash.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/script.rb:1
Run with Foodcritic Version 12.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
License Metric
0.2.0 passed this metric
No Binaries Metric
0.2.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
pyenv/TAGS
Testing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 passed this metric
0.2.0 failed this metric
FC069: Ensure standardized license defined in metadata: pyenv/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/global.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/python.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/rehash.rb:1
FC074: LWRP should use DSL to define resource's default action: pyenv/resources/script.rb:1
Run with Foodcritic Version 12.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any
0.2.0 passed this metric
No Binaries Metric
0.2.0 failed this metric
Failure: Cookbook should not contain binaries. Found:
pyenv/TAGS
Testing File Metric
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 passed this metric
0.2.0 failed this metric
pyenv/TAGS
0.2.0 failed this metric
Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of https://github.com/user/repo, and your repo must contain a TESTING.md file
Version Tag Metric
0.2.0 passed this metric
0.2.0 passed this metric