mirror of https://github.com/actions/setup-python
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# setup-python
|
|
|
|
<p align="left">
|
|
<a href="https://github.com/actions/setup-python"><img alt="GitHub Actions status" src="https://github.com/actions/setup-python/workflows/Main%20workflow/badge.svg"></a>
|
|
</p>
|
|
|
|
This action sets up a Python environment for use in actions by:
|
|
|
|
- optionally installing a version of Python and adding to PATH. Note that this action only uses versions of Python already installed in the cache. The action will fail if no matching versions are found.
|
|
- registering problem matchers for error output
|
|
|
|
# Usage
|
|
|
|
See [action.yml](action.yml)
|
|
|
|
Basic:
|
|
```yaml
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- uses: actions/setup-python@v1
|
|
with:
|
|
python-version: '3.x' # Version range or exact version of a Python version to use, using semvers version range syntax.
|
|
architecture: 'x64' # optional x64 or x86. Defaults to x64 if not specified
|
|
- run: python my_script.py
|
|
```
|
|
|
|
Matrix Testing:
|
|
```yaml
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-16.04
|
|
strategy:
|
|
matrix:
|
|
python-version: [ '2.x', '3.x', 'pypy2', 'pypy3' ]
|
|
name: Python ${{ matrix.python-version }} sample
|
|
steps:
|
|
- uses: actions/checkout@master
|
|
- name: Setup python
|
|
uses: actions/setup-python@v1
|
|
with:
|
|
python-version: ${{ matrix.python-version }}
|
|
architecture: x64
|
|
- run: python my_script.py
|
|
```
|
|
# Available versions of Python
|
|
|
|
For detailed information regarding the available versions of Python that are installed see [Software installed on GitHub-hosted runners](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/software-installed-on-github-hosted-runners)
|
|
|
|
# License
|
|
|
|
The scripts and documentation in this project are released under the [MIT License](LICENSE)
|
|
|
|
# Contributions
|
|
|
|
Contributions are welcome! See [Contributor's Guide](docs/contributors.md)
|