{"id":16962523,"url":"https://github.com/threeal/pipx-install-action","last_synced_at":"2025-07-06T22:36:18.533Z","repository":{"id":219772035,"uuid":"749864326","full_name":"threeal/pipx-install-action","owner":"threeal","description":"Install Python packages using pipx with cache support on GitHub Actions","archived":false,"fork":false,"pushed_at":"2024-04-14T09:18:22.000Z","size":1640,"stargazers_count":1,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-14T09:40:01.355Z","etag":null,"topics":["action","actions","ci","github-actions","javascript","nodejs","pipx","python","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/threeal.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2024-01-29T14:52:51.000Z","updated_at":"2024-04-15T15:04:32.295Z","dependencies_parsed_at":"2024-03-02T15:42:03.361Z","dependency_job_id":"e1c78c96-4e35-48e7-a21b-fc83b95b4bdc","html_url":"https://github.com/threeal/pipx-install-action","commit_stats":null,"previous_names":["threeal/pipx-install-action"],"tags_count":3,"template":false,"template_full_name":"threeal/action-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Fpipx-install-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Fpipx-install-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Fpipx-install-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/threeal%2Fpipx-install-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/threeal","download_url":"https://codeload.github.com/threeal/pipx-install-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361598,"owners_count":20926642,"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":["action","actions","ci","github-actions","javascript","nodejs","pipx","python","typescript"],"created_at":"2024-10-13T23:07:01.524Z","updated_at":"2025-04-05T15:43:26.582Z","avatar_url":"https://github.com/threeal.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Pipx Install Action\n\nInstall [Python](https://www.python.org/) packages using [pipx](https://pipx.pypa.io/stable/) with [cache support](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows) on [GitHub Actions](https://github.com/features/actions).\n\nUse this project to install Python packages with pipx, especially for tools written in Python that should be installed in isolated environments.\nAfter installation, it automatically saves the installed packages to a cache, speeding up installations for subsequent workflow runs.\n\nThis project includes two components: a GitHub Action that can be used directly in workflows, and a [JavaScript](https://developer.mozilla.org/en-US/docs/Web/JavaScript) library that provides functions for use in a [JavaScript Action](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-javascript-action).\n\n## Key Features\n\n- Installs Python packages using pipx.\n- Caches Python package installations for reuse in subsequent workflow runs.\n\n## Using the GitHub Action\n\nUse the following snippet to include the action in a GitHub workflow:\n\n```yaml\n- name: Install Packages\n  uses: threeal/pipx-install-action@v2.0.0\n  with:\n    packages: a-package another-package\n```\n\n### Available Inputs\n\n| Name       | Type             | Description                                   |\n| ---------- | ---------------- | --------------------------------------------- |\n| `packages` | Multiple strings | Names of the Python packages to be installed. |\n\n### Example Usage\n\nThis example demonstrates how to use the Pipx Install Action to install [Ruff](https://pypi.org/project/ruff/) in a GitHub Actions workflow:\n\n```yaml\nname: Python CI\non:\n  push:\njobs:\n  build:\n    name: Build\n    runs-on: ubuntu-24.04\n    steps:\n      - name: Checkout\n        uses: actions/checkout@v4.2.2\n\n      - name: Install Ruff\n        uses: threeal/pipx-install-action@v2.0.0\n        with:\n          packages: ruff\n\n      # Add more steps as needed for the workflow\n```\n\n## Using the JavaScript Library\n\nInstall the JavaScript library using a package manager:\n\n```bash\nnpm install pipx-install-action\n```\n\nThe library provides several functions for installing and caching Python packages within GitHub Actions. Refer to the [documentation](https://threeal.github.io/pipx-install-action/) for more information about the functions available in this action and their usage.\n\n## Example Usage\n\nThis example demonstrates how to use this library to install and cache [Ruff](https://pypi.org/project/ruff/) in a JavaScript action:\n\n```js\nimport {\n  installPipxPackage,\n  restorePipxPackageCache,\n  savePipxPackageCache,\n} from \"pipx-install-action\";\n\nconst restored = await restorePipxPackageCache(\"ruff\");\nif (!restored) {\n  await installPipxPackage(\"ruff\");\n  await savePipxPackageCache(\"ruff\");\n}\n```\n\nThe code above first attempts to restore the Ruff package cache. If the cache is unavailable, it installs the package and saves it to the cache for future workflow runs.\n\n## License\n\nThis project is licensed under the terms of the [MIT License](./LICENSE).\n\nCopyright © 2024-2025 [Alfi Maulana](https://github.com/threeal/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthreeal%2Fpipx-install-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthreeal%2Fpipx-install-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthreeal%2Fpipx-install-action/lists"}