Setup Python
Pip packages¶
The actions/setup-python actions installs python with a specific version and could cache downloaded Python packages. (But not the installed environment)
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.x'
cache: 'pip'
- run: pip install -r requirements.txt
Cache Python environment¶
You can cache the whole Python environment so pip install can be skipped for the same packages.1
- name: Setup Python
uses: actions/setup-python@v5
id: setup-python
with:
python-version: '3.x'
- name: Cache python
uses: actions/cache@v4
id: cache-py
with:
key: ${{ runner.os }}-py-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('requirements.txt') }}
path: ${{ env.pythonLocation }}
- name: Install Python dependencies
if: ${{ steps.cache-py.outputs.cache-hit != 'true' }}
run: pip install -r requirements.txt
Cache venv environment¶
If you want to cache the whole Python environment, cache the virtual environment folder.2
- name: Setup Python
uses: actions/setup-python@v5
id: setup-python
with:
python-version: '3.x'
- name: Cache virtualenv
uses: actions/cache@v4
id: cache-venv
with:
key: ${{ runner.os }}-venv-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('requirements.txt') }}
path: .venv
- name: Install Python dependencies
if: ${{ steps.cache-venv.outputs.cache-hit != 'true' }}
run: |
python -m venv .venv
source .venv/bin/activate
python -m pip install -r requirements.txt
- name: Add venv to PATH
run: |
echo ".venv/bin" >> $GITHUB_PATH
echo "VIRTUAL_ENV=.venv" >> $GITHUB_ENV
Conda packages¶
The mamba-org/setup-micromamba action installs the micromamba package manager and conda package dependencies. It can also cache the whole runtime environment.
- uses: mamba-org/setup-micromamba@v1
with:
environment-file: environment.yml
init-shell: bash
cache-environment: true
post-cleanup: 'all'
- name: Run custom command in micromamba environment
shell: micromamba-shell {0}
run: python --version