poise-python 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +11 -0
- data/.kitchen.travis.yml +9 -0
- data/.kitchen.yml +8 -0
- data/.travis.yml +21 -0
- data/.yardopts +7 -0
- data/Berksfile +28 -0
- data/Gemfile +33 -0
- data/LICENSE +201 -0
- data/README.md +399 -0
- data/Rakefile +17 -0
- data/chef/attributes/default.rb +24 -0
- data/chef/recipes/default.rb +20 -0
- data/lib/poise_python.rb +25 -0
- data/lib/poise_python/cheftie.rb +18 -0
- data/lib/poise_python/error.rb +23 -0
- data/lib/poise_python/python_command_mixin.rb +45 -0
- data/lib/poise_python/python_providers.rb +35 -0
- data/lib/poise_python/python_providers/base.rb +177 -0
- data/lib/poise_python/python_providers/portable_pypy.rb +96 -0
- data/lib/poise_python/python_providers/scl.rb +77 -0
- data/lib/poise_python/python_providers/system.rb +86 -0
- data/lib/poise_python/resources.rb +31 -0
- data/lib/poise_python/resources/pip_requirements.rb +102 -0
- data/lib/poise_python/resources/python_execute.rb +83 -0
- data/lib/poise_python/resources/python_package.rb +322 -0
- data/lib/poise_python/resources/python_runtime.rb +114 -0
- data/lib/poise_python/resources/python_runtime_pip.rb +167 -0
- data/lib/poise_python/resources/python_runtime_test.rb +185 -0
- data/lib/poise_python/resources/python_virtualenv.rb +164 -0
- data/lib/poise_python/utils.rb +63 -0
- data/lib/poise_python/utils/python_encoder.rb +73 -0
- data/lib/poise_python/version.rb +20 -0
- data/poise-python.gemspec +41 -0
- data/test/cookbooks/poise-python_test/metadata.rb +18 -0
- data/test/cookbooks/poise-python_test/recipes/default.rb +40 -0
- data/test/gemfiles/chef-12.gemfile +19 -0
- data/test/gemfiles/master.gemfile +23 -0
- data/test/integration/default/serverspec/default_spec.rb +102 -0
- data/test/spec/python_command_mixin_spec.rb +115 -0
- data/test/spec/python_providers/portable_pypy_spec.rb +68 -0
- data/test/spec/python_providers/scl_spec.rb +75 -0
- data/test/spec/python_providers/system_spec.rb +81 -0
- data/test/spec/resources/pip_requirements_spec.rb +69 -0
- data/test/spec/resources/python_package_spec.rb +65 -0
- data/test/spec/resources/python_runtime_pip_spec.rb +33 -0
- data/test/spec/resources/python_virtualenv_spec.rb +103 -0
- data/test/spec/spec_helper.rb +19 -0
- data/test/spec/utils/python_encoder_spec.rb +79 -0
- data/test/spec/utils_spec.rb +86 -0
- metadata +170 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 59c887593f03041124e297ead423a1bea2606724
|
4
|
+
data.tar.gz: 4adb8c74b9d0d9d7384b52fef81b59296deea96a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: e537cd49c014a599ea9adb74c5c272875d738de6fba7c9e224850ab121635235d94345db19083f90f46730c016494a320423d9060d0d3e92eed139a12f3dcb0c
|
7
|
+
data.tar.gz: 450cef04ad1723458c063ad0444022e65f8c03179c5c8956cff4de256e1a74a76d2f3a7b5e90213a7b9b62a9a12caacbc6f539d7e8ce6c940e9b1f3c24372a03
|
data/.gitignore
ADDED
data/.kitchen.travis.yml
ADDED
data/.kitchen.yml
ADDED
data/.travis.yml
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
---
|
2
|
+
sudo: false
|
3
|
+
cache: bundler
|
4
|
+
language: ruby
|
5
|
+
rvm:
|
6
|
+
- '2.2'
|
7
|
+
addons:
|
8
|
+
apt:
|
9
|
+
packages:
|
10
|
+
- libgecode-dev
|
11
|
+
env:
|
12
|
+
global:
|
13
|
+
- USE_SYSTEM_GECODE=true
|
14
|
+
- KITCHEN_LOCAL_YAML=.kitchen.travis.yml
|
15
|
+
- secure: j4GV/0NXC6p/+XxgK2isMCzccR7ry8cxLJZZbJN5P+958lLGmYtPPsfAN+aRzcR3Uc/alLcsjXvceCjJWU7qYpkN1x9cn564J1X3OIOygi6xdYQIMLL5Guxp01QYabFlrmZeUnTVMTkdR1H4aRrpzW4kTuc5hbIZaJl0enEe1Dd+vbCw2GOTXFnPTeLDCaCSNXXhXmqqWD64leFR2PTwx8fwrXyCB/bDRXhFdsFA5Q/tCGW7PDaYujbqSCegpuz+uvHoM5S2k2XY3pShWZm9WcmEzCLEfhOGCc1s+ia7TZ0iV7kzEq11mNTdSl6nJtBUiKsgqw1TRPFhhUj2Bp/K+cNsd06rtFE3In2zbqbgyJ0qnyQHs2FZO//ve8bug+B0lA3i6SantruS1Fc9NjwjqzOmqmaqNhnVl1jEQTOB3JUC465QShySF0aJtjE5khD7PzGwCw6cqhPBLH5ZTmqCYvl/egYLMlvVr1Nboa+0YFdzUqoTFJpRTsu89l8+1+Eu9pvHn0CwsjWmEVHahIw/GEBjhLPDinquJNxWz1q49ozlohntbRmWhbgzz6D4wPrbBdyW7rYm8p6d2sOy6Op2zsVv4c7Dj3pcLLd9J5o6RaNxf4wLd5VFLNJR6/wldsZXGxV/iP16oyasabYIQYZNbP0U1hZiUpLQ5cvKYc6xRTM=
|
16
|
+
bundler_args: "--binstubs=$PWD/bin --jobs 3 --retry 3"
|
17
|
+
script:
|
18
|
+
- "./bin/rake travis"
|
19
|
+
gemfile:
|
20
|
+
- test/gemfiles/chef-12.gemfile
|
21
|
+
- test/gemfiles/master.gemfile
|
data/.yardopts
ADDED
data/Berksfile
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2015, Noah Kantrowitz
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
source 'https://supermarket.chef.io/'
|
18
|
+
extension 'halite'
|
19
|
+
|
20
|
+
# Force the rebuild every time for development.
|
21
|
+
cookbook 'poise', gem: 'poise'
|
22
|
+
cookbook 'poise-languages', gem: 'poise-languages'
|
23
|
+
cookbook 'poise-python', gem: 'poise-python'
|
24
|
+
|
25
|
+
group :test do
|
26
|
+
cookbook 'poise-python_test', path: 'test/cookbooks/poise-python_test'
|
27
|
+
cookbook 'apt'
|
28
|
+
end
|
data/Gemfile
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
#
|
2
|
+
# Copyright 2015, Noah Kantrowitz
|
3
|
+
#
|
4
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
5
|
+
# you may not use this file except in compliance with the License.
|
6
|
+
# You may obtain a copy of the License at
|
7
|
+
#
|
8
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
9
|
+
#
|
10
|
+
# Unless required by applicable law or agreed to in writing, software
|
11
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
12
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
13
|
+
# See the License for the specific language governing permissions and
|
14
|
+
# limitations under the License.
|
15
|
+
#
|
16
|
+
|
17
|
+
source 'https://rubygems.org/'
|
18
|
+
|
19
|
+
gemspec path: File.expand_path('..', __FILE__)
|
20
|
+
|
21
|
+
def dev_gem(name, path: File.join('..', name), github: nil)
|
22
|
+
path = File.expand_path(File.join('..', path), __FILE__)
|
23
|
+
if File.exist?(path)
|
24
|
+
gem name, path: path
|
25
|
+
elsif github
|
26
|
+
gem name, github: github
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
dev_gem 'halite'
|
31
|
+
dev_gem 'poise'
|
32
|
+
dev_gem 'poise-boiler'
|
33
|
+
dev_gem 'poise-languages'
|
data/LICENSE
ADDED
@@ -0,0 +1,201 @@
|
|
1
|
+
Apache License
|
2
|
+
Version 2.0, January 2004
|
3
|
+
http://www.apache.org/licenses/
|
4
|
+
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
6
|
+
|
7
|
+
1. Definitions.
|
8
|
+
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
11
|
+
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
13
|
+
the copyright owner that is granting the License.
|
14
|
+
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
16
|
+
other entities that control, are controlled by, or are under common
|
17
|
+
control with that entity. For the purposes of this definition,
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
19
|
+
direction or management of such entity, whether by contract or
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
22
|
+
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
24
|
+
exercising permissions granted by this License.
|
25
|
+
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
27
|
+
including but not limited to software source code, documentation
|
28
|
+
source, and configuration files.
|
29
|
+
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
31
|
+
transformation or translation of a Source form, including but
|
32
|
+
not limited to compiled object code, generated documentation,
|
33
|
+
and conversions to other media types.
|
34
|
+
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
36
|
+
Object form, made available under the License, as indicated by a
|
37
|
+
copyright notice that is included in or attached to the work
|
38
|
+
(an example is provided in the Appendix below).
|
39
|
+
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
46
|
+
the Work and Derivative Works thereof.
|
47
|
+
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
49
|
+
the original version of the Work and any modifications or additions
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
61
|
+
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
64
|
+
subsequently incorporated within the Work.
|
65
|
+
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
72
|
+
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
78
|
+
where such license applies only to those patent claims licensable
|
79
|
+
by such Contributor that are necessarily infringed by their
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
82
|
+
institute patent litigation against any entity (including a
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
85
|
+
or contributory patent infringement, then any patent licenses
|
86
|
+
granted to You under this License for that Work shall terminate
|
87
|
+
as of the date such litigation is filed.
|
88
|
+
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
91
|
+
modifications, and in Source or Object form, provided that You
|
92
|
+
meet the following conditions:
|
93
|
+
|
94
|
+
(a) You must give any other recipients of the Work or
|
95
|
+
Derivative Works a copy of this License; and
|
96
|
+
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
98
|
+
stating that You changed the files; and
|
99
|
+
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
102
|
+
attribution notices from the Source form of the Work,
|
103
|
+
excluding those notices that do not pertain to any part of
|
104
|
+
the Derivative Works; and
|
105
|
+
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
108
|
+
include a readable copy of the attribution notices contained
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
111
|
+
of the following places: within a NOTICE text file distributed
|
112
|
+
as part of the Derivative Works; within the Source form or
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
114
|
+
within a display generated by the Derivative Works, if and
|
115
|
+
wherever such third-party notices normally appear. The contents
|
116
|
+
of the NOTICE file are for informational purposes only and
|
117
|
+
do not modify the License. You may add Your own attribution
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
120
|
+
that such additional attribution notices cannot be construed
|
121
|
+
as modifying the License.
|
122
|
+
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
124
|
+
may provide additional or different license terms and conditions
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
128
|
+
the conditions stated in this License.
|
129
|
+
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
133
|
+
this License, without any additional terms or conditions.
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
135
|
+
the terms of any separate license agreement you may have executed
|
136
|
+
with Licensor regarding such Contributions.
|
137
|
+
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
140
|
+
except as required for reasonable and customary use in describing the
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
142
|
+
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
152
|
+
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
158
|
+
incidental, or consequential damages of any character arising as a
|
159
|
+
result of this License or out of the use or inability to use the
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
162
|
+
other commercial damages or losses), even if such Contributor
|
163
|
+
has been advised of the possibility of such damages.
|
164
|
+
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
168
|
+
or other liability obligations and/or rights consistent with this
|
169
|
+
License. However, in accepting such obligations, You may act only
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
174
|
+
of your accepting any such warranty or additional liability.
|
175
|
+
|
176
|
+
END OF TERMS AND CONDITIONS
|
177
|
+
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
179
|
+
|
180
|
+
To apply the Apache License to your work, attach the following
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
182
|
+
replaced with your own identifying information. (Don't include
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
184
|
+
comment syntax for the file format. We also recommend that a
|
185
|
+
file or class name and description of purpose be included on the
|
186
|
+
same "printed page" as the copyright notice for easier
|
187
|
+
identification within third-party archives.
|
188
|
+
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
190
|
+
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
192
|
+
you may not use this file except in compliance with the License.
|
193
|
+
You may obtain a copy of the License at
|
194
|
+
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
196
|
+
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
200
|
+
See the License for the specific language governing permissions and
|
201
|
+
limitations under the License.
|
data/README.md
ADDED
@@ -0,0 +1,399 @@
|
|
1
|
+
# Poise-Python Cookbook
|
2
|
+
|
3
|
+
[![Build Status](https://img.shields.io/travis/poise/poise-python.svg)](https://travis-ci.org/poise/poise-python)
|
4
|
+
[![Gem Version](https://img.shields.io/gem/v/poise-python.svg)](https://rubygems.org/gems/poise-python)
|
5
|
+
[![Cookbook Version](https://img.shields.io/cookbook/v/poise-python.svg)](https://supermarket.chef.io/cookbooks/poise-python)
|
6
|
+
[![Coverage](https://img.shields.io/codecov/c/github/poise/poise-python.svg)](https://codecov.io/github/poise/poise-python)
|
7
|
+
[![Gemnasium](https://img.shields.io/gemnasium/poise/poise-python.svg)](https://gemnasium.com/poise/poise-python)
|
8
|
+
[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
|
9
|
+
|
10
|
+
A [Chef](https://www.chef.io/) cookbook to provide a unified interface for
|
11
|
+
installing Python, managing Python packages, and creating virtualenvs.
|
12
|
+
|
13
|
+
## Quick Start
|
14
|
+
|
15
|
+
To install the latest available version of Python 2 and then use it to create
|
16
|
+
a virtualenv and install some packages:
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
python_runtime '2'
|
20
|
+
|
21
|
+
python_virtualenv '/opt/myapp/.env'
|
22
|
+
|
23
|
+
python_package 'Django' do
|
24
|
+
version '1.8'
|
25
|
+
end
|
26
|
+
|
27
|
+
pip_requirements '/opt/myapp/requirements.txt'
|
28
|
+
```
|
29
|
+
|
30
|
+
## Supported Python Versions
|
31
|
+
|
32
|
+
This cookbook can install at least Python 2.7, Python 3, and PyPy on all
|
33
|
+
supported platforms (Debian, Ubuntu, RHEL, CentOS, Fedora).
|
34
|
+
|
35
|
+
## Requirements
|
36
|
+
|
37
|
+
Chef 12 or newer is required.
|
38
|
+
|
39
|
+
## Attributes
|
40
|
+
|
41
|
+
Attributes are used to configure the default recipe.
|
42
|
+
|
43
|
+
* `node['poise-python']['install_python2']` – Install a Python 2.x runtime. *(default: true)*
|
44
|
+
* `node['poise-python']['install_python3']` – Install a Python 3.x runtime. *(default: false)*
|
45
|
+
* `node['poise-python']['install_pypy']` – Install a PyPy runtime. *(default: false)*
|
46
|
+
|
47
|
+
## Recipes
|
48
|
+
|
49
|
+
### `default`
|
50
|
+
|
51
|
+
The default recipe installs Python 2, 3, and/or PyPy based on the node
|
52
|
+
attributes. It is entirely optional and can be ignored in favor of direct use
|
53
|
+
of the `python_runtime` resource.
|
54
|
+
|
55
|
+
## Resources
|
56
|
+
|
57
|
+
### `python_runtime`
|
58
|
+
|
59
|
+
The `python_runtime` resource installs a Python interpreter.
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
python_runtime '2'
|
63
|
+
```
|
64
|
+
|
65
|
+
#### Actions
|
66
|
+
|
67
|
+
* `:install` – Install the Python interpreter. *(default)*
|
68
|
+
* `:uninstall` – Uninstall the Python interpreter.
|
69
|
+
|
70
|
+
#### Properties
|
71
|
+
|
72
|
+
* `version` – Version of Python to install. If a partial version is given, use the
|
73
|
+
latest available version matching that prefix. *(name property)*
|
74
|
+
* `pip_version` – Version of pip to install. If set to `true`, use the latest.
|
75
|
+
If set to `false`, do not install pip. Can also be set to a URL to a copy of
|
76
|
+
the `get-pip.py` script. *(default: true)*
|
77
|
+
* `setuptools_version` – Version of Setuptools to install. If set to `true`, use
|
78
|
+
the latest. If set to `false`, do not install Setuptools. *(default: true)*
|
79
|
+
* `virtualenv_version` – Version of virtualenv to install. If set to `true`,
|
80
|
+
use the latest. If set to `false`, do not install virtualenv. Will never be
|
81
|
+
installed if the `venv` module is already available, such as on Python 3.
|
82
|
+
*(default: true)*
|
83
|
+
* `wheel_version` – Version of wheel to install. If set to `true`, use the
|
84
|
+
latest. If set to `false`, do not install wheel.
|
85
|
+
|
86
|
+
#### Provider Options
|
87
|
+
|
88
|
+
The `poise-python` library offers an additional way to pass configuration
|
89
|
+
information to the final provider called "options". Options are key/value pairs
|
90
|
+
that are passed down to the `python_runtime` provider and can be used to control how it
|
91
|
+
installs Python. These can be set in the `python_runtime`
|
92
|
+
resource using the `options` method, in node attributes or via the
|
93
|
+
`python_runtime_options` resource. The options from all sources are merged
|
94
|
+
together in to a single hash.
|
95
|
+
|
96
|
+
When setting options in the resource you can either set them for all providers:
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
python_runtime 'myapp' do
|
100
|
+
version '2.7'
|
101
|
+
options pip_version: false
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
or for a single provider:
|
106
|
+
|
107
|
+
```ruby
|
108
|
+
python_runtime 'myapp' do
|
109
|
+
version '2.7'
|
110
|
+
options :system, dev_package: false
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
Setting via node attributes is generally how an end-user or application cookbook
|
115
|
+
will set options to customize installations in the library cookbooks they are using.
|
116
|
+
You can set options for all installations or for a single runtime:
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
# Global, for all installations.
|
120
|
+
override['poise-python']['options']['pip_version'] = false
|
121
|
+
# Single installation.
|
122
|
+
override['poise-python']['myapp']['version'] = 'pypy'
|
123
|
+
```
|
124
|
+
|
125
|
+
The `python_runtime_options` resource is also available to set node attributes
|
126
|
+
for a specific installation in a DSL-friendly way:
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
python_runtime_options 'myapp' do
|
130
|
+
version '3'
|
131
|
+
end
|
132
|
+
```
|
133
|
+
|
134
|
+
Unlike resource attributes, provider options can be different for each provider.
|
135
|
+
Not all providers support the same options so make sure to the check the
|
136
|
+
documentation for each provider to see what options the use.
|
137
|
+
|
138
|
+
### `python_runtime_options`
|
139
|
+
|
140
|
+
The `python_runtime_options` resource allows setting provider options in a
|
141
|
+
DSL-friendly way. See [the Provider Options](#provider-options) section for more
|
142
|
+
information about provider options overall.
|
143
|
+
|
144
|
+
```ruby
|
145
|
+
python_runtime_options 'myapp' do
|
146
|
+
version '3'
|
147
|
+
end
|
148
|
+
```
|
149
|
+
|
150
|
+
#### Actions
|
151
|
+
|
152
|
+
* `:run` – Apply the provider options. *(default)*
|
153
|
+
|
154
|
+
#### Properties
|
155
|
+
|
156
|
+
* `resource` – Name of the `python_runtime` resource. *(name property)*
|
157
|
+
* `for_provider` – Provider to set options for.
|
158
|
+
|
159
|
+
All other attribute keys will be used as options data.
|
160
|
+
|
161
|
+
### `python_execute`
|
162
|
+
|
163
|
+
The `python_execute` resource executes a Python script using the configured runtime.
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
python_execute 'myapp.py' do
|
167
|
+
user 'myuser'
|
168
|
+
end
|
169
|
+
```
|
170
|
+
|
171
|
+
This uses the built-in `execute` resource and supports all the same properties.
|
172
|
+
|
173
|
+
#### Actions
|
174
|
+
|
175
|
+
* `:run` – Execute the script. *(default)*
|
176
|
+
|
177
|
+
#### Properties
|
178
|
+
|
179
|
+
* `command` – Script and arguments to run. Must not include the `python`. *(name attribute)*
|
180
|
+
* `python` – Name of the `python_runtime` resource to use. If not specified, the
|
181
|
+
most recently declared `python_runtime` will be used. Can also be set to the
|
182
|
+
full path to a `python` binary.
|
183
|
+
* `virtualenv` – Name of the `python_virtualenv` resource to use. This is
|
184
|
+
mutually exclusive with the `python` property.
|
185
|
+
|
186
|
+
For other properties see the [Chef documentation](https://docs.chef.io/resource_execute.html#attributes).
|
187
|
+
|
188
|
+
### `python_package`
|
189
|
+
|
190
|
+
The `python_package` resource installs Python packages using
|
191
|
+
[pip](https://pip.pypa.io/).
|
192
|
+
|
193
|
+
```ruby
|
194
|
+
python_package 'Django' do
|
195
|
+
version '1.8'
|
196
|
+
end
|
197
|
+
```
|
198
|
+
|
199
|
+
This uses the built-in `package` resource and supports the same actions and
|
200
|
+
properties. Multi-package installs are supported using the standard syntax.
|
201
|
+
|
202
|
+
#### Actions
|
203
|
+
|
204
|
+
* `:install` – Install the package. *(default)*
|
205
|
+
* `:upgrade` – Install using the `--upgrade` flag.
|
206
|
+
* `:remove` – Uninstall the package.
|
207
|
+
|
208
|
+
The `:purge` and `:reconfigure` actions are not supported.
|
209
|
+
|
210
|
+
#### Properties
|
211
|
+
|
212
|
+
* `group` – System group to install the package.
|
213
|
+
* `package_name` – Package or packages to install. *(name property)*
|
214
|
+
* `version` – Version or versions to install.
|
215
|
+
* `python` – Name of the `python_runtime` resource to use. If not specified, the
|
216
|
+
most recently declared `python_runtime` will be used. Can also be set to the
|
217
|
+
full path to a `python` binary.
|
218
|
+
* `user` – System user to install the package.
|
219
|
+
* `virtualenv` – Name of the `python_virtualenv` resource to use. This is
|
220
|
+
mutually exclusive with the `python` property.
|
221
|
+
|
222
|
+
For other properties see the [Chef documentation](https://docs.chef.io/resource_package.html#attributes).
|
223
|
+
The `response_file`, `response_file_variables`, and `source` properties are not
|
224
|
+
supported.
|
225
|
+
|
226
|
+
### `python_virtualenv`
|
227
|
+
|
228
|
+
The `python_virtualenv` resource creates Python virtual environments.
|
229
|
+
|
230
|
+
```ruby
|
231
|
+
python_virtualenv '/opt/myapp'
|
232
|
+
```
|
233
|
+
|
234
|
+
This will use the `venv` module if available, or `virtualenv` otherwise.
|
235
|
+
|
236
|
+
#### Actions
|
237
|
+
|
238
|
+
* `:create` – Create the virtual environment. *(default)*
|
239
|
+
* `:delete` – Delete the virtual environment.
|
240
|
+
|
241
|
+
#### Properties
|
242
|
+
|
243
|
+
* `group` – System group to create the virtualenv.
|
244
|
+
* `path` – Path to create the environment at. *(name property)*
|
245
|
+
* `pip_version` – Version of pip to install. If set to `true`, use the latest.
|
246
|
+
If set to `false`, do not install pip. Can also be set to a URL to a copy of
|
247
|
+
the `get-pip.py` script. *(default: true)*
|
248
|
+
* `python` – Name of the `python_runtime` resource to use. If not specified, the
|
249
|
+
most recently declared `python_runtime` will be used. Can also be set to the
|
250
|
+
full path to a `python` binary.
|
251
|
+
* `setuptools_version` – Version of Setuptools to install. If set to `true`, use
|
252
|
+
the latest. If set to `false`, do not install Setuptools. *(default: true)*
|
253
|
+
* `system_site_packages` – Enable or disable visibilty of system packages in
|
254
|
+
the environment. *(default: false)*
|
255
|
+
* `user` – System user to create the virtualenv.
|
256
|
+
* `wheel_version` – Version of wheel to install. If set to `true`, use the
|
257
|
+
latest. If set to `false`, do not install wheel.
|
258
|
+
|
259
|
+
### `pip_requirements`
|
260
|
+
|
261
|
+
The `pip_requirements` resource installs packages based on a `requirements.txt`
|
262
|
+
file.
|
263
|
+
|
264
|
+
```ruby
|
265
|
+
pip_requirements '/opt/myapp/requirements.txt'
|
266
|
+
```
|
267
|
+
|
268
|
+
The underlying `pip install` command will run on every converge, but
|
269
|
+
notifications will only be triggered if a package is actually installed.
|
270
|
+
|
271
|
+
#### Actions
|
272
|
+
|
273
|
+
* `:install` – Install the requirements. *(default)*
|
274
|
+
* `:upgrade` – Install using the `--upgrade` flag.
|
275
|
+
|
276
|
+
#### Properties
|
277
|
+
|
278
|
+
* `path` – Path to the requirements file, or a folder containing the
|
279
|
+
requirements file. *(name property)*
|
280
|
+
* `python` – Name of the `python_runtime` resource to use. If not specified, the
|
281
|
+
most recently declared `python_runtime` will be used. Can also be set to the
|
282
|
+
full path to a `python` binary.
|
283
|
+
* `virtualenv` – Name of the `python_virtualenv` resource to use. This is
|
284
|
+
mutually exclusive with the `python` property.
|
285
|
+
|
286
|
+
## Python Providers
|
287
|
+
|
288
|
+
### Common Options
|
289
|
+
|
290
|
+
These provider options are supported by all providers.
|
291
|
+
|
292
|
+
* `pip_version` – Override the pip version.
|
293
|
+
* `setuptools_version` – Override the Setuptools version.
|
294
|
+
* `version` – Override the Python version.
|
295
|
+
* `virtualenv_version` – Override the virtualenv version.
|
296
|
+
* `wheel_version` – Override the wheel version.
|
297
|
+
|
298
|
+
### `system`
|
299
|
+
|
300
|
+
The `system` provider installs Python using system packages. This is currently
|
301
|
+
only tested on platforms using `apt-get` and `yum` (Debian, Ubuntu, RHEL, CentOS
|
302
|
+
Amazon Linux, and Fedora) and is a default provider on those platforms. It may
|
303
|
+
work on other platforms but is untested.
|
304
|
+
|
305
|
+
```ruby
|
306
|
+
python_runtime 'myapp' do
|
307
|
+
provider :system
|
308
|
+
version '2.7'
|
309
|
+
end
|
310
|
+
```
|
311
|
+
|
312
|
+
#### Options
|
313
|
+
|
314
|
+
* `dev_package` – Install the package with the headers and other development
|
315
|
+
files. Can be set to a string to select the dev package specifically.
|
316
|
+
*(default: true)*
|
317
|
+
* `package_name` – Override auto-detection of the package name.
|
318
|
+
* `package_upgrade` – Install using action `:upgrade`. *(default: false)*
|
319
|
+
* `package_version` – Override auto-detection of the package version.
|
320
|
+
|
321
|
+
### `scl`
|
322
|
+
|
323
|
+
The `scl` provider installs Python using the [Software Collections](https://www.softwarecollections.org/)
|
324
|
+
packages. This is only available on RHEL, CentOS, and Fedora. SCL offers more
|
325
|
+
recent versions of Python than the system packages for the most part. If an SCL
|
326
|
+
package exists for the requests version, it will be used in preference to the
|
327
|
+
`system` provider.
|
328
|
+
|
329
|
+
```ruby
|
330
|
+
python_runtime 'myapp' do
|
331
|
+
provider :scl
|
332
|
+
version '3.4'
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
### `portable_pypy`
|
337
|
+
|
338
|
+
The `portable_pypy` provider installs Python using the [Portable PyPy](https://github.com/squeaky-pl/portable-pypy)
|
339
|
+
packages. These are only available for Linux, but should work on any Linux OS.
|
340
|
+
Support is included for both `pypy` and `pypy3`.
|
341
|
+
|
342
|
+
```ruby
|
343
|
+
python_runtime 'myapp' do
|
344
|
+
provider :portable_pypy
|
345
|
+
version 'pypy'
|
346
|
+
end
|
347
|
+
```
|
348
|
+
|
349
|
+
#### Options
|
350
|
+
|
351
|
+
* `folder` – Folder to install PyPy in. *(default: /opt/<package name>)*
|
352
|
+
* `url` – URL to download the package from. *(default: automatic)*
|
353
|
+
|
354
|
+
### `deadsnakes`
|
355
|
+
|
356
|
+
*Coming soon!*
|
357
|
+
|
358
|
+
### `python-build`
|
359
|
+
|
360
|
+
*Coming soon!*
|
361
|
+
|
362
|
+
## Upgrading from the `python` Cookbook
|
363
|
+
|
364
|
+
The older `python` cookbook is not directly compatible with this one, but the
|
365
|
+
broad strokes overlap well. The `python::default` recipe is roughly equivalent
|
366
|
+
to the `poise-python::default` recipe. The `python::pip` and `python::virtualenv`
|
367
|
+
recipes are no longer needed as installing those things is now part of the
|
368
|
+
`python_runtime` resource. The `python::package` recipe corresponds with the
|
369
|
+
`system` provider for the `python_runtime` resource, and can generally be
|
370
|
+
replaced with `poise-python::default`. At this time there is no provider to
|
371
|
+
install from source so there is no replacement for the `python::source` recipe,
|
372
|
+
however this is planned for the future via a `python-build` provider.
|
373
|
+
|
374
|
+
The `python_pip` resource can be replaced with `python_package`, though the
|
375
|
+
`environment` property has been removed. The `python_virtualenv` resource can remain
|
376
|
+
unchanged except for the `interpreter` property now being `python` and the
|
377
|
+
`options` property has been removed.
|
378
|
+
|
379
|
+
## Sponsors
|
380
|
+
|
381
|
+
Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).
|
382
|
+
|
383
|
+
The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/).
|
384
|
+
|
385
|
+
## License
|
386
|
+
|
387
|
+
Copyright 2015, Noah Kantrowitz
|
388
|
+
|
389
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
390
|
+
you may not use this file except in compliance with the License.
|
391
|
+
You may obtain a copy of the License at
|
392
|
+
|
393
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
394
|
+
|
395
|
+
Unless required by applicable law or agreed to in writing, software
|
396
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
397
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
398
|
+
See the License for the specific language governing permissions and
|
399
|
+
limitations under the License.
|