setup-pipx's Introduction

setup-pipx

🍰 this project is deprecated. Just do this instead:

on: [push]

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v4
        id: cpython_setup
        with:
          python-version: "3.10"
      - run: pipx install poetry --python '${{ steps.cpython_setup.outputs.python-path }}'
      - run: poetry install

Original README below:

Pipx setup for GitHub Actions.

Quickstart example

on: [push]

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: "3.10"
      - uses: fredrikaverpil/[email protected]
        with:
          pipx-version: "1.1.0"
      - run: pipx install <package>

Features

You decide the Python and pipx versions used.
Pipx will be installed in an isolated virtual environment, in .venv_pipx. You may want to add this to your .gitignore so to avoid a dirty git branch during CI execution.
Can be used in conjunction with actions/cache
Support for linux, macOS and windows runners

Inputs

Inputs	Description	Required	Default
pipx-version	Pipx Version	false	`N/A`
venv-name	Name of pipx virtual environment	false	`.venv_pipx`

Advanced usage

Matrix with caching and poetry

on: [push]

jobs:
  example:
    strategy:
      fail-fast: false
      matrix:
        python-version: ["3.7", "3.8", "3.9", "3.10"]
        pipx-version: ["1.1.0"]
        poetry-version: ["1.1.13"]
        os: [ubuntu-latest, windows-latest, macos-latest]
    runs-on: ${{ matrix.os }}
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v2
        with:
          python-version: ${{ matrix.python-version }}
      - uses: fredrikaverpil/[email protected]
        with:
          pipx-version: ${{ matrix.pipx-version }}
      - uses: actions/cache@v2
        id: cache
        with:
          path: |
            ~/.cache/pip
            ~/.cache/pypoetry/virtualenvs
            .venv_pipx
          key: ${{ runner.os }}-${{ runner.arch }}-py-${{ matrix.python-version }}-pipx-${{ matrix.pipx-version }}-poetry-${{ matrix.poetry-version }}-${{ hashFiles('poetry.lock') }}

      - run: pipx install poetry==${{ matrix.poetry-version }}
      - run: poetry install
      - run: poetry show --outdated

setup-pipx's People

Contributors

Stargazers

Watchers

setup-pipx's Issues

Override environment variables

Pipx paths already exists in some environment variables. This action should overwrite those and make everything point to the new pipx, provided by this action.

See fredrikaverpil/gha-labs actions for more details on the existing environment variables.

Pipx and caching

If caching is enabled, like in the advanced example, the ../pipx_venv should not be created. Only the $PATH should be updated, so the pipx-installed binaries can be found.

Or, more likely, might want this order instead:

      - uses: fredrikaverpil/[email protected]
        with:
          pipx-version: "1.0"

      - uses: actions/cache@v2
        id: cache
        with:
          path: |
            ~/.cache/pip
            ~/.cache/pypoetry/virtualenvs
            ../pipx_venv
            ~/.local/bin
            ~/.local/Scripts
          key: ${{ runner.os }}-py-${{ matrix.python-version }}-pipx-${{ matrix.pipx-version }}-poetry-${{ matrix.poetry-version }}-${{ hashFiles('poetry.lock') }}

Recommend Projects