{"id":28251848,"url":"https://github.com/py-actions/py-dependency-install","last_synced_at":"2025-06-15T16:31:10.581Z","repository":{"id":37794376,"uuid":"261942478","full_name":"py-actions/py-dependency-install","owner":"py-actions","description":"A GitHub Action that installs Python package dependencies from a user-defined requirements.txt file path with optional pip, setuptools, and wheel installs/updates","archived":false,"fork":false,"pushed_at":"2024-06-28T18:38:42.000Z","size":1753,"stargazers_count":27,"open_issues_count":5,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-03T23:15:21.949Z","etag":null,"topics":["ci","continuous-integration","dependency","dependency-manager","github-actions","pypi","python","python3","requirements"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/py-actions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-07T03:41:32.000Z","updated_at":"2025-03-31T18:42:46.000Z","dependencies_parsed_at":"2023-12-18T21:32:50.623Z","dependency_job_id":"7ec3863e-5d35-4bb6-963d-a95ef9d7d97c","html_url":"https://github.com/py-actions/py-dependency-install","commit_stats":{"total_commits":265,"total_committers":4,"mean_commits":66.25,"dds":"0.38113207547169814","last_synced_commit":"e162f166ed6dd22b8c2af80d21c678a3d185bfa2"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fpy-dependency-install","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fpy-dependency-install/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fpy-dependency-install/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fpy-dependency-install/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/py-actions","download_url":"https://codeload.github.com/py-actions/py-dependency-install/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fpy-dependency-install/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":258589331,"owners_count":22725088,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","continuous-integration","dependency","dependency-manager","github-actions","pypi","python","python3","requirements"],"created_at":"2025-05-19T15:15:41.861Z","updated_at":"2025-06-15T16:31:10.572Z","avatar_url":"https://github.com/py-actions.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# py-actions/py-dependency-install GitHub Action\n\n![Version](https://img.shields.io/github/v/release/py-actions/py-dependency-install?sort=semver)\n[![Linux CI](https://github.com/py-actions/py-dependency-install/workflows/Linux%20CI/badge.svg)](https://github.com/py-actions/py-dependency-install/actions?query=workflow%3A%22Linux+CI%22)\n[![macOS CI](https://github.com/py-actions/py-dependency-install/workflows/macOS%20CI/badge.svg)](https://github.com/py-actions/py-dependency-install/actions?query=workflow%3A%22macOS+CI%22)\n[![Windows CI](https://github.com/py-actions/py-dependency-install/workflows/Windows%20CI/badge.svg)](https://github.com/py-actions/py-dependency-install/actions?query=workflow%3A%22Windows+CI%22)\n[![Lint](https://github.com/py-actions/py-dependency-install/workflows/Lint/badge.svg)](https://github.com/py-actions/py-dependency-install/actions?query=workflow%3ALint)\n[![CodeQL](https://github.com/py-actions/py-dependency-install/actions/workflows/codeql.yml/badge.svg)](https://github.com/py-actions/py-dependency-install/actions/workflows/codeql.yml)\n\nThis 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.\n\nThis Action is tested nightly with cPython v3.9.x - v3.12.x in the latest Linux, macOS, and Windows GitHub Actions runner environments.\n\n## Quick Start\n\nInsert a dependency installation step under the `steps:` field in a GitHub workflow job with a configuration like this:\n\n### Default\n\nUses path `requirements.txt` and updates `pip`, `setuptools`, and `wheel` before the install.\n\n```yaml\nsteps:\n  # this Action should follow steps to set up Python build environment\n  - name: Install Python dependencies\n    uses: py-actions/py-dependency-install@v4\n```\n\n### Define the `requirements.txt` path\n\nDefine a requirements.txt file on a path relative to the root of your repository.\n\n```yaml\nsteps:\n  # this Action should follow steps to set up Python build environment\n  - name: Install Python dependencies\n    uses: py-actions/py-dependency-install@v4\n    with:\n      path: \"path/to/requirements.txt\"\n```\n\n### Toggle `pip`, `setuptools`, and `wheel` installs/updates off\n\nThe `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:\n\n```yaml\nsteps:\n  # this Action should follow steps to set up Python build environment\n  - name: Install Python dependencies\n    uses: py-actions/py-dependency-install@v4\n    with:\n      update-pip: \"false\"\n      update-setuptools: \"false\"\n      update-wheel: \"false\"\n```\n\n## Inputs\n\n### `path`\n\n**Optional** The `requirements.txt` file path relative to the root of your source repository. Default = `\"requirements.txt\"`.\n\n### `update-pip`\n\n**Optional** A boolean string indicating that a `pip` package update should occur before the dependency installation. Options: [`\"true\"`, `\"false\"`].  Default=`\"true\"`\n\n### `update-setuptools`\n\n**Optional** A boolean string indicating that a `setuptools` package update should occur before the dependency installation. Options: [`\"true\"`, `\"false\"`].  Default=`\"true\"`\n\n### `update-wheel`\n\n**Optional** A boolean string indicating that a `wheel` package update should occur before the dependency installation. Options: [`\"true\"`, `\"false\"`].  Default=`\"true\"`\n\n## Outputs\n\nNone\n\n## License\n\n[Apache License, v2.0](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpy-actions%2Fpy-dependency-install","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpy-actions%2Fpy-dependency-install","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpy-actions%2Fpy-dependency-install/lists"}