poise-python 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59c887593f03041124e297ead423a1bea2606724
+  data.tar.gz: 4adb8c74b9d0d9d7384b52fef81b59296deea96a
+SHA512:
+  metadata.gz: e537cd49c014a599ea9adb74c5c272875d738de6fba7c9e224850ab121635235d94345db19083f90f46730c016494a320423d9060d0d3e92eed139a12f3dcb0c
+  data.tar.gz: 450cef04ad1723458c063ad0444022e65f8c03179c5c8956cff4de256e1a74a76d2f3a7b5e90213a7b9b62a9a12caacbc6f539d7e8ce6c940e9b1f3c24372a03

data/.gitignore

@@ -0,0 +1,11 @@
+Berksfile.lock
+Gemfile.lock
+test/gemfiles/*.lock
+.kitchen/
+.kitchen.local.yml
+test/docker/
+coverage/
+pkg/
+.yardoc/
+doc/
+

data/.kitchen.travis.yml

@@ -0,0 +1,9 @@
+---
+driver:
+  name: docker
+  binary: "./docker"
+  socket: tcp://docker.poise.io:443
+  tls_verify: true
+  tls_cacert: test/docker/docker.ca
+  tls_cert: test/docker/docker.pem
+  tls_key: test/docker/docker.key

data/.kitchen.yml

@@ -0,0 +1,8 @@
+---
+#<% require 'poise_boiler' %>
+<%= PoiseBoiler.kitchen(platforms: 'linux') %>
+
+suites:
+- name: default
+  run_list:
+  - recipe[poise-python_test]

data/.travis.yml

@@ -0,0 +1,21 @@
+---
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+- '2.2'
+addons:
+  apt:
+    packages:
+    - libgecode-dev
+env:
+  global:
+  - USE_SYSTEM_GECODE=true
+  - KITCHEN_LOCAL_YAML=.kitchen.travis.yml
+  - secure: j4GV/0NXC6p/+XxgK2isMCzccR7ry8cxLJZZbJN5P+958lLGmYtPPsfAN+aRzcR3Uc/alLcsjXvceCjJWU7qYpkN1x9cn564J1X3OIOygi6xdYQIMLL5Guxp01QYabFlrmZeUnTVMTkdR1H4aRrpzW4kTuc5hbIZaJl0enEe1Dd+vbCw2GOTXFnPTeLDCaCSNXXhXmqqWD64leFR2PTwx8fwrXyCB/bDRXhFdsFA5Q/tCGW7PDaYujbqSCegpuz+uvHoM5S2k2XY3pShWZm9WcmEzCLEfhOGCc1s+ia7TZ0iV7kzEq11mNTdSl6nJtBUiKsgqw1TRPFhhUj2Bp/K+cNsd06rtFE3In2zbqbgyJ0qnyQHs2FZO//ve8bug+B0lA3i6SantruS1Fc9NjwjqzOmqmaqNhnVl1jEQTOB3JUC465QShySF0aJtjE5khD7PzGwCw6cqhPBLH5ZTmqCYvl/egYLMlvVr1Nboa+0YFdzUqoTFJpRTsu89l8+1+Eu9pvHn0CwsjWmEVHahIw/GEBjhLPDinquJNxWz1q49ozlohntbRmWhbgzz6D4wPrbBdyW7rYm8p6d2sOy6Op2zsVv4c7Dj3pcLLd9J5o6RaNxf4wLd5VFLNJR6/wldsZXGxV/iP16oyasabYIQYZNbP0U1hZiUpLQ5cvKYc6xRTM=
+bundler_args: "--binstubs=$PWD/bin --jobs 3 --retry 3"
+script:
+- "./bin/rake travis"
+gemfile:
+- test/gemfiles/chef-12.gemfile
+- test/gemfiles/master.gemfile

data/.yardopts

@@ -0,0 +1,7 @@
+--plugin classmethods
+--embed-mixin ClassMethods
+--hide-api private
+--markup markdown
+--hide-void-return
+--tag provides:Provides
+--tag action:Actions

data/Berksfile

@@ -0,0 +1,28 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+source 'https://supermarket.chef.io/'
+extension 'halite'
+
+# Force the rebuild every time for development.
+cookbook 'poise', gem: 'poise'
+cookbook 'poise-languages', gem: 'poise-languages'
+cookbook 'poise-python', gem: 'poise-python'
+
+group :test do
+  cookbook 'poise-python_test', path: 'test/cookbooks/poise-python_test'
+  cookbook 'apt'
+end

data/Gemfile

@@ -0,0 +1,33 @@
+#
+# Copyright 2015, Noah Kantrowitz
+#
+# 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.
+#
+
+source 'https://rubygems.org/'
+
+gemspec path: File.expand_path('..', __FILE__)
+
+def dev_gem(name, path: File.join('..', name), github: nil)
+  path = File.expand_path(File.join('..', path), __FILE__)
+  if File.exist?(path)
+    gem name, path: path
+  elsif github
+    gem name, github: github
+  end
+end
+
+dev_gem 'halite'
+dev_gem 'poise'
+dev_gem 'poise-boiler'
+dev_gem 'poise-languages'

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,399 @@
+# Poise-Python Cookbook
+
+[![Build Status](https://img.shields.io/travis/poise/poise-python.svg)](https://travis-ci.org/poise/poise-python)
+[![Gem Version](https://img.shields.io/gem/v/poise-python.svg)](https://rubygems.org/gems/poise-python)
+[![Cookbook Version](https://img.shields.io/cookbook/v/poise-python.svg)](https://supermarket.chef.io/cookbooks/poise-python)
+[![Coverage](https://img.shields.io/codecov/c/github/poise/poise-python.svg)](https://codecov.io/github/poise/poise-python)
+[![Gemnasium](https://img.shields.io/gemnasium/poise/poise-python.svg)](https://gemnasium.com/poise/poise-python)
+[![License](https://img.shields.io/badge/license-Apache_2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+A [Chef](https://www.chef.io/) cookbook to provide a unified interface for
+installing Python, managing Python packages, and creating virtualenvs.
+
+## Quick Start
+
+To install the latest available version of Python 2 and then use it to create
+a virtualenv and install some packages:
+
+```ruby
+python_runtime '2'
+
+python_virtualenv '/opt/myapp/.env'
+
+python_package 'Django' do
+  version '1.8'
+end
+
+pip_requirements '/opt/myapp/requirements.txt'
+```
+
+## Supported Python Versions
+
+This cookbook can install at least Python 2.7, Python 3, and PyPy on all
+supported platforms (Debian, Ubuntu, RHEL, CentOS, Fedora).
+
+## Requirements
+
+Chef 12 or newer is required.
+
+## Attributes
+
+Attributes are used to configure the default recipe.
+
+* `node['poise-python']['install_python2']` – Install a Python 2.x runtime. *(default: true)*
+* `node['poise-python']['install_python3']` – Install a Python 3.x runtime. *(default: false)*
+* `node['poise-python']['install_pypy']` – Install a PyPy runtime. *(default: false)*
+
+## Recipes
+
+### `default`
+
+The default recipe installs Python 2, 3, and/or PyPy based on the node
+attributes. It is entirely optional and can be ignored in favor of direct use
+of the `python_runtime` resource.
+
+## Resources
+
+### `python_runtime`
+
+The `python_runtime` resource installs a Python interpreter.
+
+```ruby
+python_runtime '2'
+```
+
+#### Actions
+
+* `:install` – Install the Python interpreter. *(default)*
+* `:uninstall` – Uninstall the Python interpreter.
+
+#### Properties
+
+* `version` – Version of Python to install. If a partial version is given, use the
+  latest available version matching that prefix. *(name property)*
+* `pip_version` – Version of pip to install. If set to `true`, use the latest.
+  If set to `false`, do not install pip. Can also be set to a URL to a copy of
+  the `get-pip.py` script. *(default: true)*
+* `setuptools_version` – Version of Setuptools to install. If set to `true`, use
+  the latest. If set to `false`, do not install Setuptools. *(default: true)*
+* `virtualenv_version` – Version of virtualenv to install. If set to `true`,
+  use the latest. If set to `false`, do not install virtualenv. Will never be
+  installed if the `venv` module is already available, such as on Python 3.
+  *(default: true)*
+* `wheel_version` – Version of wheel to install. If set to `true`, use the
+  latest. If set to `false`, do not install wheel.
+
+#### Provider Options
+
+The `poise-python` library offers an additional way to pass configuration
+information to the final provider called "options". Options are key/value pairs
+that are passed down to the `python_runtime` provider and can be used to control how it
+installs Python. These can be set in the `python_runtime`
+resource using the `options` method, in node attributes or via the
+`python_runtime_options` resource. The options from all sources are merged
+together in to a single hash.
+
+When setting options in the resource you can either set them for all providers:
+
+```ruby
+python_runtime 'myapp' do
+  version '2.7'
+  options pip_version: false
+end
+```
+
+or for a single provider:
+
+```ruby
+python_runtime 'myapp' do
+  version '2.7'
+  options :system, dev_package: false
+end
+```
+
+Setting via node attributes is generally how an end-user or application cookbook
+will set options to customize installations in the library cookbooks they are using.
+You can set options for all installations or for a single runtime:
+
+```ruby
+# Global, for all installations.
+override['poise-python']['options']['pip_version'] = false
+# Single installation.
+override['poise-python']['myapp']['version'] = 'pypy'
+```
+
+The `python_runtime_options` resource is also available to set node attributes
+for a specific installation in a DSL-friendly way:
+
+```ruby
+python_runtime_options 'myapp' do
+  version '3'
+end
+```
+
+Unlike resource attributes, provider options can be different for each provider.
+Not all providers support the same options so make sure to the check the
+documentation for each provider to see what options the use.
+
+### `python_runtime_options`
+
+The `python_runtime_options` resource allows setting provider options in a
+DSL-friendly way. See [the Provider Options](#provider-options) section for more
+information about provider options overall.
+
+```ruby
+python_runtime_options 'myapp' do
+  version '3'
+end
+```
+
+#### Actions
+
+* `:run` – Apply the provider options. *(default)*
+
+#### Properties
+
+* `resource` – Name of the `python_runtime` resource. *(name property)*
+* `for_provider` – Provider to set options for.
+
+All other attribute keys will be used as options data.
+
+### `python_execute`
+
+The `python_execute` resource executes a Python script using the configured runtime.
+
+```ruby
+python_execute 'myapp.py' do
+  user 'myuser'
+end
+```
+
+This uses the built-in `execute` resource and supports all the same properties.
+
+#### Actions
+
+* `:run` – Execute the script. *(default)*
+
+#### Properties
+
+* `command` – Script and arguments to run. Must not include the `python`. *(name attribute)*
+* `python` – Name of the `python_runtime` resource to use. If not specified, the
+  most recently declared `python_runtime` will be used. Can also be set to the
+  full path to a `python` binary.
+* `virtualenv` – Name of the `python_virtualenv` resource to use. This is
+  mutually exclusive with the `python` property.
+
+For other properties see the [Chef documentation](https://docs.chef.io/resource_execute.html#attributes).
+
+### `python_package`
+
+The `python_package` resource installs Python packages using
+[pip](https://pip.pypa.io/).
+
+```ruby
+python_package 'Django' do
+  version '1.8'
+end
+```
+
+This uses the built-in `package` resource and supports the same actions and
+properties. Multi-package installs are supported using the standard syntax.
+
+#### Actions
+
+* `:install` – Install the package. *(default)*
+* `:upgrade` – Install using the `--upgrade` flag.
+* `:remove` – Uninstall the package.
+
+The `:purge` and `:reconfigure` actions are not supported.
+
+#### Properties
+
+* `group` – System group to install the package.
+* `package_name` – Package or packages to install. *(name property)*
+* `version` – Version or versions to install.
+* `python` – Name of the `python_runtime` resource to use. If not specified, the
+  most recently declared `python_runtime` will be used. Can also be set to the
+  full path to a `python` binary.
+* `user` – System user to install the package.
+* `virtualenv` – Name of the `python_virtualenv` resource to use. This is
+  mutually exclusive with the `python` property.
+
+For other properties see the [Chef documentation](https://docs.chef.io/resource_package.html#attributes).
+The `response_file`, `response_file_variables`, and `source` properties are not
+supported.
+
+### `python_virtualenv`
+
+The `python_virtualenv` resource creates Python virtual environments.
+
+```ruby
+python_virtualenv '/opt/myapp'
+```
+
+This will use the `venv` module if available, or `virtualenv` otherwise.
+
+#### Actions
+
+* `:create` – Create the virtual environment. *(default)*
+* `:delete` – Delete the virtual environment.
+
+#### Properties
+
+* `group` – System group to create the virtualenv.
+* `path` – Path to create the environment at. *(name property)*
+* `pip_version` – Version of pip to install. If set to `true`, use the latest.
+  If set to `false`, do not install pip. Can also be set to a URL to a copy of
+  the `get-pip.py` script. *(default: true)*
+* `python` – Name of the `python_runtime` resource to use. If not specified, the
+  most recently declared `python_runtime` will be used. Can also be set to the
+  full path to a `python` binary.
+* `setuptools_version` – Version of Setuptools to install. If set to `true`, use
+  the latest. If set to `false`, do not install Setuptools. *(default: true)*
+* `system_site_packages` – Enable or disable visibilty of system packages in
+  the environment. *(default: false)*
+* `user` – System user to create the virtualenv.
+* `wheel_version` – Version of wheel to install. If set to `true`, use the
+  latest. If set to `false`, do not install wheel.
+
+### `pip_requirements`
+
+The `pip_requirements` resource installs packages based on a `requirements.txt`
+file.
+
+```ruby
+pip_requirements '/opt/myapp/requirements.txt'
+```
+
+The underlying `pip install` command will run on every converge, but
+notifications will only be triggered if a package is actually installed.
+
+#### Actions
+
+* `:install` – Install the requirements. *(default)*
+* `:upgrade` – Install using the `--upgrade` flag.
+
+#### Properties
+
+* `path` – Path to the requirements file, or a folder containing the
+  requirements file. *(name property)*
+* `python` – Name of the `python_runtime` resource to use. If not specified, the
+  most recently declared `python_runtime` will be used. Can also be set to the
+  full path to a `python` binary.
+* `virtualenv` – Name of the `python_virtualenv` resource to use. This is
+  mutually exclusive with the `python` property.
+
+## Python Providers
+
+### Common Options
+
+These provider options are supported by all providers.
+
+* `pip_version` – Override the pip version.
+* `setuptools_version` – Override the Setuptools version.
+* `version` – Override the Python version.
+* `virtualenv_version` – Override the virtualenv version.
+* `wheel_version` – Override the wheel version.
+
+### `system`
+
+The `system` provider installs Python using system packages. This is currently
+only tested on platforms using `apt-get` and `yum` (Debian, Ubuntu, RHEL, CentOS
+Amazon Linux, and Fedora) and is a default provider on those platforms. It may
+work on other platforms but is untested.
+
+```ruby
+python_runtime 'myapp' do
+  provider :system
+  version '2.7'
+end
+```
+
+#### Options
+
+* `dev_package` – Install the package with the headers and other development
+  files. Can be set to a string to select the dev package specifically.
+  *(default: true)*
+* `package_name` – Override auto-detection of the package name.
+* `package_upgrade` – Install using action `:upgrade`. *(default: false)*
+* `package_version` – Override auto-detection of the package version.
+
+### `scl`
+
+The `scl` provider installs Python using the [Software Collections](https://www.softwarecollections.org/)
+packages. This is only available on RHEL, CentOS, and Fedora. SCL offers more
+recent versions of Python than the system packages for the most part. If an SCL
+package exists for the requests version, it will be used in preference to the
+`system` provider.
+
+```ruby
+python_runtime 'myapp' do
+  provider :scl
+  version '3.4'
+end
+```
+
+### `portable_pypy`
+
+The `portable_pypy` provider installs Python using the [Portable PyPy](https://github.com/squeaky-pl/portable-pypy)
+packages. These are only available for Linux, but should work on any Linux OS.
+Support is included for both `pypy` and `pypy3`.
+
+```ruby
+python_runtime 'myapp' do
+  provider :portable_pypy
+  version 'pypy'
+end
+```
+
+#### Options
+
+* `folder` – Folder to install PyPy in. *(default: /opt/<package name>)*
+* `url` – URL to download the package from. *(default: automatic)*
+
+### `deadsnakes`
+
+*Coming soon!*
+
+### `python-build`
+
+*Coming soon!*
+
+## Upgrading from the `python` Cookbook
+
+The older `python` cookbook is not directly compatible with this one, but the
+broad strokes overlap well. The `python::default` recipe is roughly equivalent
+to the `poise-python::default` recipe. The `python::pip` and `python::virtualenv`
+recipes are no longer needed as installing those things is now part of the
+`python_runtime` resource. The `python::package` recipe corresponds with the
+`system` provider for the `python_runtime` resource, and can generally be
+replaced with `poise-python::default`. At this time there is no provider to
+install from source so there is no replacement for the `python::source` recipe,
+however this is planned for the future via a `python-build` provider.
+
+The `python_pip` resource can be replaced with `python_package`, though the
+`environment` property has been removed. The `python_virtualenv` resource can remain
+unchanged except for the `interpreter` property now being `python` and the
+`options` property has been removed.
+
+## Sponsors
+
+Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).
+
+The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/).
+
+## License
+
+Copyright 2015, Noah Kantrowitz
+
+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.