ibm/Setup Python
Set up a specific version of Python and add the command-line tools to the PATH.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| python-version | Version range or exact version of Python or PyPy to use, using SemVer's version range syntax. Reads from .python-version if unset. | — | — |
| python-version-file | File containing the Python version to use. Example: .python-version | — | — |
| cache | Used to specify a package manager for caching in the default directory. Supported values: pip, pipenv, poetry. | no | — |
| architecture | The target architecture (x86, x64, arm64) of the Python or PyPy interpreter. | — | — |
| check-latest | Set this option if you want the action to check for the latest available version that satisfies the version spec. | — | false |
| token | The token used to authenticate when fetching Python distributions from https://github.com/IBM/python-versions-pz. 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. | — | ${{ github.server_url == 'https://github.com' && github.token || '' }} |
| cache-dependency-path | Used to specify the path to dependency files. Supports wildcards or a list of file names for caching multiple dependencies. | — | — |
| update-environment | Set this option if you want the action to update environment variables. | — | true |
| allow-prereleases | 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. | — | false |
| freethreaded | When 'true', use the freethreaded version of Python. | — | false |
| pip-version | Used to specify the version of pip to install with the Python. Supported format: major[.minor][.patch]. | — | — |
| pip-install | Used to specify the packages to install with pip after setting up Python. Can be a requirements file or package names. | — | — |
Outputs
| name | description |
|---|---|
| python-version | The installed Python or PyPy version. Useful when given a version range as input. |
| cache-hit | A boolean value to indicate a cache entry was found |
| python-path | The absolute path to the Python or PyPy executable. |