Skip to content

Warning

You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?

Python Dependency Installation

Actions
Install Python dependencies from requirements.txt file
v2.0.1
Star (27)

py-actions/py-dependency-install GitHub Action

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.

Inputs

path

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

update-pip

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

update-setuptools

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

update-wheel

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

Outputs

None

Example usage

Default

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 the requirements.txt path

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"

Toggle pip, setuptools, and wheel installs/updates off

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"

License

Apache License, v2.0

Python Dependency Installation is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

Install Python dependencies from requirements.txt file
v2.0.1

Python Dependency Installation is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.