| Name | autopkg-wrapper JSON |
| Version |
2025.8.1
JSON |
| download |
| home_page | None |
| Summary | A package used to execute some autopkg functions, primarily within the context of a GitHub Actions runner. |
| upload_time | 2025-08-28 00:32:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | ~=3.12.0 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# autopkg-wrapper
`autopkg_wrapper` is a small package that can be used to run [`autopkg`](https://github.com/autopkg/autopkg) within CI/CD environments such as GitHub Actions.
The easiest way to run it is by installing with pip.
```shell
pip install autopkg-wrapper
```
## Command Line Parameters
```shell
-h, --help Show this help message and exit
--recipe-file RECIPE_FILE Path to a list of recipes to run (cannot be run with --recipes)
--recipes [RECIPES ...] Recipes to run with autopkg (cannot be run with --recipe-file)
--debug Enable debug logging when running script
--override-trust If set recipe override trust verification will be disabled. (Default: True)
--github-token GITHUB_TOKEN A token used to publish a PR to your GitHub repo if overrides require their trust to be updated
--branch-name BRANCH_NAME Branch name to be used where recipe overrides have failed their trust verification and need to be updated.
By default, this will be in the format of "fix/update_trust_information/YYYY-MM-DDTHH-MM-SS"
--create-pr If enabled, autopkg_wrapper will open a PR for updated trust information
--autopkg-prefs AW_AUTOPKG_PREFS_FILE
Path to the autopkg preferences you'd like to use
--autopkg-overrides-repo-path AUTOPKG_OVERRIDES_REPO_PATH
The path on disk to the git repository containing the autopkg overrides directory. If none is provided, we will try to determine it for you.
```
## Example
An example folder structure and GitHub Actions Workflow is available within the [`actions-demo`](actions-demo)
## Credits
- [`autopkg_tools` from Facebook](https://github.com/facebook/IT-CPE/tree/main/legacy/autopkg_tools)
- [`autopkg_tools` from Facebook, modified by Gusto](https://github.com/Gusto/it-cpe-opensource/tree/main/autopkg)
Raw data
{
"_id": null,
"home_page": null,
"name": "autopkg-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": "~=3.12.0",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "James Smith <james@smithjw.me>",
"download_url": "https://files.pythonhosted.org/packages/6f/aa/e0db0c23a989d12bb679d8ee4bf8dc019e5f864168b60c8cf76e14590f2c/autopkg_wrapper-2025.8.1.tar.gz",
"platform": null,
"description": "# autopkg-wrapper\n\n`autopkg_wrapper` is a small package that can be used to run [`autopkg`](https://github.com/autopkg/autopkg) within CI/CD environments such as GitHub Actions.\n\nThe easiest way to run it is by installing with pip.\n\n```shell\npip install autopkg-wrapper\n```\n\n## Command Line Parameters\n\n```shell\n-h, --help Show this help message and exit\n--recipe-file RECIPE_FILE Path to a list of recipes to run (cannot be run with --recipes)\n--recipes [RECIPES ...] Recipes to run with autopkg (cannot be run with --recipe-file)\n--debug Enable debug logging when running script\n--override-trust If set recipe override trust verification will be disabled. (Default: True)\n--github-token GITHUB_TOKEN A token used to publish a PR to your GitHub repo if overrides require their trust to be updated\n--branch-name BRANCH_NAME Branch name to be used where recipe overrides have failed their trust verification and need to be updated.\n By default, this will be in the format of \"fix/update_trust_information/YYYY-MM-DDTHH-MM-SS\"\n--create-pr If enabled, autopkg_wrapper will open a PR for updated trust information\n--autopkg-prefs AW_AUTOPKG_PREFS_FILE\n Path to the autopkg preferences you'd like to use\n--autopkg-overrides-repo-path AUTOPKG_OVERRIDES_REPO_PATH\n The path on disk to the git repository containing the autopkg overrides directory. If none is provided, we will try to determine it for you.\n```\n\n## Example\n\nAn example folder structure and GitHub Actions Workflow is available within the [`actions-demo`](actions-demo)\n\n## Credits\n\n- [`autopkg_tools` from Facebook](https://github.com/facebook/IT-CPE/tree/main/legacy/autopkg_tools)\n- [`autopkg_tools` from Facebook, modified by Gusto](https://github.com/Gusto/it-cpe-opensource/tree/main/autopkg)\n",
"bugtrack_url": null,
"license": null,
"summary": "A package used to execute some autopkg functions, primarily within the context of a GitHub Actions runner.",
"version": "2025.8.1",
"project_urls": {
"Repository": "https://github.com/smithjw/autopkg-wrapper"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2409356dd63d4fad174b3c7eced932b8d67d2096a8283002317633d8dbe8acb8",
"md5": "9378b41af1b7924236a8d13039531ce5",
"sha256": "88c9478154c1f6bc739b9137ec7f6ffdc0cb2323cd9d8b8c49d778f92811a3ce"
},
"downloads": -1,
"filename": "autopkg_wrapper-2025.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9378b41af1b7924236a8d13039531ce5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "~=3.12.0",
"size": 11807,
"upload_time": "2025-08-28T00:32:26",
"upload_time_iso_8601": "2025-08-28T00:32:26.860331Z",
"url": "https://files.pythonhosted.org/packages/24/09/356dd63d4fad174b3c7eced932b8d67d2096a8283002317633d8dbe8acb8/autopkg_wrapper-2025.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "6faae0db0c23a989d12bb679d8ee4bf8dc019e5f864168b60c8cf76e14590f2c",
"md5": "fa052cc880d878dd0d7c555613cf72ce",
"sha256": "f28972d6bf00f525b24c7ae6cea54a72d7c61df4780417550c3c0bd6bd408b51"
},
"downloads": -1,
"filename": "autopkg_wrapper-2025.8.1.tar.gz",
"has_sig": false,
"md5_digest": "fa052cc880d878dd0d7c555613cf72ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "~=3.12.0",
"size": 25688,
"upload_time": "2025-08-28T00:32:37",
"upload_time_iso_8601": "2025-08-28T00:32:37.820811Z",
"url": "https://files.pythonhosted.org/packages/6f/aa/e0db0c23a989d12bb679d8ee4bf8dc019e5f864168b60c8cf76e14590f2c/autopkg_wrapper-2025.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-28 00:32:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smithjw",
"github_project": "autopkg-wrapper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "autopkg-wrapper"
}
