# 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": "https://github.com/smithjw/autopkg-wrapper",
"name": "autopkg-wrapper",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "James Smith",
"author_email": "james@smithjw.me",
"download_url": "https://files.pythonhosted.org/packages/b5/66/0d93d9a15fbc56521494372165fdc9fc47ff1f4a43136ed5324a423e2205/autopkg_wrapper-2024.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\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A package used to execute some autopkg functions, primarily within the context of a GitHub Actions runner.",
"version": "2024.8.1",
"project_urls": {
"Homepage": "https://github.com/smithjw/autopkg-wrapper",
"Repository": "https://github.com/smithjw/autopkg-wrapper"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "75c7183da5472c1127ec3f7ab89ec39cc0d9f20c1462238a5d1fa0d06de72f6b",
"md5": "4ac2e7e6e7e013bb5de68a17bd7deb40",
"sha256": "cbebd6ae0d43101d656dbb3d7fb724d7c8a28ae2b977972ac8e6056973313023"
},
"downloads": -1,
"filename": "autopkg_wrapper-2024.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4ac2e7e6e7e013bb5de68a17bd7deb40",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 11319,
"upload_time": "2024-08-02T04:50:46",
"upload_time_iso_8601": "2024-08-02T04:50:46.266646Z",
"url": "https://files.pythonhosted.org/packages/75/c7/183da5472c1127ec3f7ab89ec39cc0d9f20c1462238a5d1fa0d06de72f6b/autopkg_wrapper-2024.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b5660d93d9a15fbc56521494372165fdc9fc47ff1f4a43136ed5324a423e2205",
"md5": "fca9868e985ed21746280dfaf79b6ac1",
"sha256": "e684f72125d5c7cd1640092b18eadd8033d122543285f54a782dcd86810e6927"
},
"downloads": -1,
"filename": "autopkg_wrapper-2024.8.1.tar.gz",
"has_sig": false,
"md5_digest": "fca9868e985ed21746280dfaf79b6ac1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 9064,
"upload_time": "2024-08-02T04:50:47",
"upload_time_iso_8601": "2024-08-02T04:50:47.771708Z",
"url": "https://files.pythonhosted.org/packages/b5/66/0d93d9a15fbc56521494372165fdc9fc47ff1f4a43136ed5324a423e2205/autopkg_wrapper-2024.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-02 04:50:47",
"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"
}
JSON
