Repository files navigation

This action provides the following functionality for GitHub Actions users:

• Installing a version of Python or PyPy and (by default) adding it to the PATH
• Optionally caching dependencies for pip, pipenv and poetry
• Registering problem matchers for error output

Seeaction.yml

Python

steps:-uses:actions/checkout@v4-uses:actions/setup-python@v5with:python-version:'3.13' -run:python my_script.py

PyPy

steps:-uses:actions/checkout@v4-uses:actions/setup-python@v5with:python-version:'pypy3.10' -run:python my_script.py

GraalPy

steps:-uses:actions/checkout@v4-uses:actions/setup-python@v5with:python-version:'graalpy-24.0' -run:python my_script.py

Free threaded Python

steps:-uses:actions/checkout@v4-uses:actions/setup-python@v5with:python-version:'3.13t'-run:python my_script.py

Thepython-version input is optional. If not supplied, the action will try to resolve the version from the default.python-version file. If the.python-version file doesn't exist Python or PyPy version from the PATH will be used. The default version of Python or PyPy in PATH varies between runners and can be changed unexpectedly so we recommend always setting Python version explicitly using thepython-version orpython-version-file inputs.

The action will first check the localtool cache for asemver match. If unable to find a specific version in the tool cache, the action will attempt to download a version of Python fromGitHub Releases and for PyPy from the officialPyPy's dist.

For information regarding locally cached versions of Python or PyPy on GitHub hosted runners, check outGitHub Actions Runner Images.

Thepython-version input supports theSemantic Versioning Specification and some special version notations (e.g.semver ranges,x.y-dev syntax, etc.), for detailed examples please refer to the section:Using python-version input of theAdvanced usage guide.

Using thearchitecture input, it is possible to specify the required Python or PyPy interpreter architecture:x86,x64, orarm64. If the input is not specified, the architecture defaults to the host OS architecture.

The action has built-in functionality for caching and restoring dependencies. It usestoolkit/cache under the hood for caching dependencies but requires less configuration settings. Supported package managers arepip,pipenv andpoetry. Thecache input is optional, and caching is turned off by default.

The action defaults to searching for a dependency file (requirements.txt orpyproject.toml for pip,Pipfile.lock for pipenv orpoetry.lock for poetry) in the repository, and uses its hash as a part of the cache key. Inputcache-dependency-path is used for cases when multiple dependency files are used, they are located in different subdirectories or different files for the hash that want to be used.

• Forpip, the action will cache the global cache directory
• Forpipenv, the action will cache virtualenv directory
• Forpoetry, the action will cache virtualenv directories -- one for each poetry project found

Caching pip dependencies:

steps:-uses:actions/checkout@v4-uses:actions/setup-python@v5with:python-version:'3.13'cache:'pip'# caching pip dependencies-run:pip install -r requirements.txt

Note: Restored cache will not be used if the requirements.txt file is not updated for a long time and a newer version of the dependency is available which can lead to an increase in total build time.

The requirements file format allows for specifying dependency versions using logical operators (for example chardet>=3.0.4) or specifying dependencies without any versions. In this case the pip install -r requirements.txt command will always try to install the latest available package version. To be sure that the cache will be used, please stick to a specific dependency version and update it manually if necessary.

See examples of usingcache andcache-dependency-path forpipenv andpoetry in the section:Caching packages of theAdvanced usage guide.

• Using the python-version input
• Using the python-version-file input
• Check latest version
• Caching packages
• Outputs and environment variables
• Available versions of Python, PyPy and GraalPy
• Hosted tool cache
• Usingsetup-python with a self-hosted runner
• Usingsetup-python on GHES
• Allow pre-releases
• Using the pip-version input

When using thesetup-python action in your GitHub Actions workflow, it is recommended to set the following permissions to ensure proper functionality:

permissions:contents:read# access to check out code and install dependencies

The scripts and documentation in this project are released under theMIT License.

Contributions are welcome! See ourContributor's Guide.