2019-12-27 13:08:34 -05:00
---
2022-07-26 08:47:59 -04:00
name : "Setup Python"
description : "Set up a specific version of Python and add the command-line tools to the PATH."
author : "GitHub"
2019-08-20 10:27:52 -04:00
inputs :
python-version :
2022-07-28 03:38:24 -04:00
description : "Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset."
2022-06-02 10:37:57 -04:00
python-version-file :
2022-07-13 07:43:28 -04:00
description : "File containing the Python version to use. Example: .python-version"
2021-11-17 05:31:22 -05:00
cache :
2022-07-26 08:47:59 -04:00
description : "Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry."
2021-11-17 05:31:22 -05:00
required : false
2019-08-20 10:27:52 -04:00
architecture :
2022-07-28 03:38:24 -04:00
description : "The target architecture (x86, x64) of the Python or PyPy interpreter."
2022-07-13 07:43:28 -04:00
check-latest :
2022-07-26 08:47:59 -04:00
description : "Set this option if you want the action to check for the latest available version that satisfies the version spec."
2022-07-13 07:43:28 -04:00
default : false
2020-04-29 13:57:02 -04:00
token :
2022-08-30 15:02:20 -04:00
description : "The token used to authenticate when fetching Python distributions from https://github.com/actions/python-versions. When running this action on github.com, the default value is sufficient. When running on GHES, you can pass a personal access token for github.com if you are experiencing rate limiting."
default : ${{ github.server_url == 'https://github.com' && github.token || '' }}
2021-11-17 05:31:22 -05:00
cache-dependency-path :
2022-07-26 08:47:59 -04:00
description : "Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies."
2022-06-29 11:00:51 -04:00
update-environment :
2022-07-26 08:47:59 -04:00
description : "Set this option if you want the action to update environment variables."
2022-06-29 11:00:51 -04:00
default : true
2023-01-27 16:19:31 -05:00
allow-prereleases :
description : "When 'true', a version range passed to 'python-version' input will match prerelease versions if no GA versions are found. Only 'x.y' version range is supported for CPython."
default : false
2024-08-29 11:48:40 -04:00
ignore-platform-version :
2024-08-30 00:56:07 -04:00
description : "Ignore the specific platform version to allow usage on Debian"
default : ""
2024-08-29 11:48:40 -04:00
required : false
2020-03-09 03:18:12 -04:00
outputs :
python-version :
2022-07-28 03:38:24 -04:00
description : "The installed Python or PyPy version. Useful when given a version range as input."
2022-04-05 09:57:13 -04:00
cache-hit :
2022-07-26 08:47:59 -04:00
description : "A boolean value to indicate a cache entry was found"
2022-05-23 14:59:37 -04:00
python-path :
2022-07-28 03:38:24 -04:00
description : "The absolute path to the Python or PyPy executable."
2019-08-20 10:27:52 -04:00
runs :
2023-12-05 08:52:09 -05:00
using : 'node20'
2021-11-17 05:31:22 -05:00
main : 'dist/setup/index.js'
post : 'dist/cache-save/index.js'
post-if : success()
2019-11-05 17:12:58 -05:00
branding :
2019-11-06 10:20:01 -05:00
icon : 'code'
2020-03-09 05:31:20 -04:00
color : 'yellow'