This GitHub Action installs Python package dependencies from a user-defined requirements.txt file path with pip, setuptools, and wheel installs/updates during execution. A Python package environment report is displayed at the end of Action execution.

Optional The requirements.txt file path relative to the root of your source repository. Default = "requirements.txt".

Optional A boolean string indicating that a pip package update should occur before the dependency installation. Options: ["true", "false"]. Default="true"

Optional A boolean string indicating that a setuptools package update should occur before the dependency installation. Options: ["true", "false"]. Default="true"

Optional A boolean string indicating that a wheel package update should occur before the dependency installation. Options: ["true", "false"]. Default="true"

None

Uses path requirements.txt and updates pip, setuptools, and wheel before the install.

- name: Install Python dependencies
  uses: py-actions/py-dependency-install@v2

Define a requirements.txt file on a path relative to the root of your repository.

- name: Install Python dependencies
  uses: py-actions/py-dependency-install@v2
  with:
    path: "path/to/requirements.txt"

The pip, setuptools, and wheel install/updates can be toggled off in your configuration. Use one or more of the update-pip, update-setuptools, and update-wheel settings with a boolean string to customize the default behavior:

- name: Install Python dependencies
  uses: py-actions/py-dependency-install@v2
  with:
    update-pip: "false"
    update-setuptools: "false"
    update-wheel: "false"

Apache License, v2.0