| Name | github-custom-actions JSON |
| Version |
2.0.1
JSON |
| download |
| home_page | None |
| Summary | Python package for creating custom GitHub Actions. |
| upload_time | 2024-04-24 07:55:24 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | Copyright (c) 2024 Andrey Sorokin <andrey@sorokin.engineer> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
actions
github
workflow
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://github.com/andgineer/github-custom-actions/actions)
[](https://htmlpreview.github.io/?https://github.com/andgineer/github-custom-actions/blob/python-coverage-comment-action-data/htmlcov/index.html)
# github-custom-actions
Python package for creating [custom GitHub Actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions).
#### Example of usage
```python
from github_custom_actions import ActionBase
class MyAction(ActionBase):
def main(self):
self.outputs["runner-os"] = self.env.runner_os
self.summary.text += (
self.render(
"### {{ inputs['my-input'] }}.\n"
"Have a nice day!"
)
)
if __name__ == "__main__":
MyAction().run()
```
# Documentation
[Github Custom Actions](https://andgineer.github.io/github-custom-actions/)
# Developers
Do not forget to run `. ./activate.sh`.
# Scripts
Install [invoke](https://docs.pyinvoke.org/en/stable/) preferably with [pipx](https://pypa.github.io/pipx/):
pipx install invoke
For a list of available scripts run:
invoke --list
For more information about a script run:
invoke <script> --help
## Coverage report
* [Codecov](https://app.codecov.io/gh/andgineer/github-custom-actions/tree/main/src%2Fgithub_custom_actions)
* [Coveralls](https://coveralls.io/github/andgineer/github-custom-actions)
> Created with cookiecutter using [template](https://github.com/andgineer/cookiecutter-python-package)
Raw data
{
"_id": null,
"home_page": null,
"name": "github-custom-actions",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "actions, github, workflow",
"author": null,
"author_email": "Andrey Sorokin <andrey@sorokin.engineer>",
"download_url": "https://files.pythonhosted.org/packages/a9/ba/dfde88af782e58a97ce6f5f2006d5204d502ddd5ea403f1838b931e36676/github_custom_actions-2.0.1.tar.gz",
"platform": null,
"description": "[](https://github.com/andgineer/github-custom-actions/actions)\n[](https://htmlpreview.github.io/?https://github.com/andgineer/github-custom-actions/blob/python-coverage-comment-action-data/htmlcov/index.html)\n# github-custom-actions\n\nPython package for creating [custom GitHub Actions](https://docs.github.com/en/actions/creating-actions/about-custom-actions). \n\n#### Example of usage\n\n```python\nfrom github_custom_actions import ActionBase\n \nclass MyAction(ActionBase):\n def main(self):\n self.outputs[\"runner-os\"] = self.env.runner_os\n self.summary.text += (\n self.render(\n \"### {{ inputs['my-input'] }}.\\n\"\n \"Have a nice day!\"\n )\n )\n\nif __name__ == \"__main__\":\n MyAction().run()\n```\n# Documentation\n\n[Github Custom Actions](https://andgineer.github.io/github-custom-actions/)\n\n# Developers\n\nDo not forget to run `. ./activate.sh`.\n\n# Scripts\nInstall [invoke](https://docs.pyinvoke.org/en/stable/) preferably with [pipx](https://pypa.github.io/pipx/):\n\n pipx install invoke\n\nFor a list of available scripts run:\n\n invoke --list\n\nFor more information about a script run:\n\n invoke <script> --help\n\n## Coverage report\n* [Codecov](https://app.codecov.io/gh/andgineer/github-custom-actions/tree/main/src%2Fgithub_custom_actions)\n* [Coveralls](https://coveralls.io/github/andgineer/github-custom-actions)\n\n> Created with cookiecutter using [template](https://github.com/andgineer/cookiecutter-python-package)",
"bugtrack_url": null,
"license": "Copyright (c) 2024 Andrey Sorokin <andrey@sorokin.engineer> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \u201cSoftware\u201d), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \u201cAS IS\u201d, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Python package for creating custom GitHub Actions.",
"version": "2.0.1",
"project_urls": {
"Documentation": "https://andgineer.github.io/github-custom-actions/",
"Homepage": "https://andgineer.github.io/github-custom-actions/"
},
"split_keywords": [
"actions",
" github",
" workflow"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb683e4207a9c77dc8f17a582e4e1b8cc450d79fd66b5a1a337a7fedb1f4be6f",
"md5": "786c4ec3af8952e0ada3c53571c2d297",
"sha256": "fb899e12c2a407e82edfb711e9343763cde11ed5b294cd3e95415f7617786838"
},
"downloads": -1,
"filename": "github_custom_actions-2.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "786c4ec3af8952e0ada3c53571c2d297",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 13810,
"upload_time": "2024-04-24T07:55:23",
"upload_time_iso_8601": "2024-04-24T07:55:23.108874Z",
"url": "https://files.pythonhosted.org/packages/fb/68/3e4207a9c77dc8f17a582e4e1b8cc450d79fd66b5a1a337a7fedb1f4be6f/github_custom_actions-2.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a9badfde88af782e58a97ce6f5f2006d5204d502ddd5ea403f1838b931e36676",
"md5": "9b93da1eb398e94affc47e5bf141e41a",
"sha256": "ae1d9daf2976ed9e718bc26265ed187022e00462261998612cecd0f8d1f7a07d"
},
"downloads": -1,
"filename": "github_custom_actions-2.0.1.tar.gz",
"has_sig": false,
"md5_digest": "9b93da1eb398e94affc47e5bf141e41a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 86116,
"upload_time": "2024-04-24T07:55:24",
"upload_time_iso_8601": "2024-04-24T07:55:24.896649Z",
"url": "https://files.pythonhosted.org/packages/a9/ba/dfde88af782e58a97ce6f5f2006d5204d502ddd5ea403f1838b931e36676/github_custom_actions-2.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 07:55:24",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "github-custom-actions"
}
