.. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct.svg
:target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md
:alt: SWUbanner
.. image:: https://img.shields.io/pypi/v/octomachinery.svg?logo=Python&logoColor=white
:target: https://pypi.org/project/octomachinery
:alt: octomachinery @ PyPI
.. image:: https://tidelift.com/badges/package/pypi/octomachinery
:target: https://tidelift.com/subscription/pkg/pypi-octomachinery?utm_source=pypi-octomachinery&utm_medium=readme
:alt: octomachinery is available as part of the Tidelift Subscription
.. image:: https://github.com/sanitizers/octomachinery/workflows/Build%2FTest%2FPublish/badge.svg
:target: https://github.com/sanitizers/octomachinery/actions?workflow=Build%2FTest%2FPublish
:alt: GitHub Actions CI/CD build status — Python package
.. DO-NOT-REMOVE-docs-badges-END
.. image:: https://img.shields.io/readthedocs/octomachinery/latest.svg?logo=Read%20The%20Docs&logoColor=white
:target: https://docs.octomachinery.dev/en/latest/?badge=latest
:alt: Documentation Status
octomachinery: Bots Without Boilerplate
=======================================
Invisible engine driving octobot machines. Simple, yet powerful.
Web-site @ https://octomachinery.dev. Stay tuned!
.. DO-NOT-REMOVE-docs-intro-START
**How-to create a GitHub Bot tutorial** is ready for preview
@ `tutorial.octomachinery.dev
<https://tutorial.octomachinery.dev/en/latest/>`_
Elevator pitch
--------------
Here's how you 👍 a just-created comment:
.. code:: python
from octomachinery.app.server.runner import run as run_app
from octomachinery.routing import process_event_actions
from octomachinery.routing.decorators import process_webhook_payload
from octomachinery.runtime.context import RUNTIME_CONTEXT
@process_event_actions('issue_comment', {'created'})
@process_webhook_payload
async def on_comment(
*,
action, issue, comment,
repository=None, sender=None,
installation=None,
assignee=None, changes=None,
):
github_api = RUNTIME_CONTEXT.app_installation_client
comment_reactions_api_url = f'{comment["url"]}/reactions'
await github_api.post(
comment_reactions_api_url,
preview_api_version='squirrel-girl',
data={'content': '+1'},
)
run_app(
name='Thumbs-Up-Bot',
version='1.0.0',
url='https://github.com/apps/thuuuuuuuuuuuuuumbs-uuuuuuuuuuuup',
)
Prerequisites
-------------
Python 3.7+
Contribute octomachinery
------------------------
**Want to add something to upstream?** Feel free to submit a PR or file
an issue if unsure.
Note that PR is more likely to be accepted if it includes tests and
detailed description helping maintainers to understand it better 🎉
Oh, and be pythonic, please 🐍
**Don't know how?** Check out `How to Contribute to Open Source
<https://opensource.guide/how-to-contribute/>`_ article by GitHub 🚀
License
-------
The source code and the documentation in this project are released under
the `GPL v3 license`_.
.. _`GPL v3 license`:
https://github.com/sanitizers/octomachinery/blob/master/LICENSE
For Enterprise
--------------
octomachinery is available as part of the Tidelift Subscription.
The octomachinery maintainers and the maintainers of thousands of other packages
are working with Tidelift to deliver one enterprise subscription that covers
all of the open source you use.
`Learn more <https://tidelift.com/subscription/pkg/pypi-octomachinery?utm_source=pypi-octomachinery&utm_medium=referral&utm_campaign=github>`_.
Raw data
{
"_id": null,
"home_page": "https://octomachinery.dev",
"name": "octomachinery",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Bot,Framework,Framework for writing GitHub Apps,GitHub,GitHub Actions,GitHub API,GitHub Apps,GitHub Checks API",
"author": "Sviatoslav Sydorenko (@webknjaz)",
"author_email": "wk+octomachinery@sydorenko.org.ua",
"download_url": "https://files.pythonhosted.org/packages/80/1d/0bdbb2ff840968b74077d187e048e49f08d75276b2c278c0a362e61c1b48/octomachinery-0.3.7.tar.gz",
"platform": null,
"description": ".. image:: https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct.svg\n :target: https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md\n :alt: SWUbanner\n\n.. image:: https://img.shields.io/pypi/v/octomachinery.svg?logo=Python&logoColor=white\n :target: https://pypi.org/project/octomachinery\n :alt: octomachinery @ PyPI\n\n.. image:: https://tidelift.com/badges/package/pypi/octomachinery\n :target: https://tidelift.com/subscription/pkg/pypi-octomachinery?utm_source=pypi-octomachinery&utm_medium=readme\n :alt: octomachinery is available as part of the Tidelift Subscription\n\n.. image:: https://github.com/sanitizers/octomachinery/workflows/Build%2FTest%2FPublish/badge.svg\n :target: https://github.com/sanitizers/octomachinery/actions?workflow=Build%2FTest%2FPublish\n :alt: GitHub Actions CI/CD build status \u2014 Python package\n\n.. DO-NOT-REMOVE-docs-badges-END\n\n.. image:: https://img.shields.io/readthedocs/octomachinery/latest.svg?logo=Read%20The%20Docs&logoColor=white\n :target: https://docs.octomachinery.dev/en/latest/?badge=latest\n :alt: Documentation Status\n\noctomachinery: Bots Without Boilerplate\n=======================================\n\nInvisible engine driving octobot machines. Simple, yet powerful.\n\nWeb-site @ https://octomachinery.dev. Stay tuned!\n\n.. DO-NOT-REMOVE-docs-intro-START\n\n**How-to create a GitHub Bot tutorial** is ready for preview\n@ `tutorial.octomachinery.dev\n<https://tutorial.octomachinery.dev/en/latest/>`_\n\nElevator pitch\n--------------\n\nHere's how you \ud83d\udc4d a just-created comment:\n\n.. code:: python\n\n from octomachinery.app.server.runner import run as run_app\n from octomachinery.routing import process_event_actions\n from octomachinery.routing.decorators import process_webhook_payload\n from octomachinery.runtime.context import RUNTIME_CONTEXT\n\n\n @process_event_actions('issue_comment', {'created'})\n @process_webhook_payload\n async def on_comment(\n *,\n action, issue, comment,\n repository=None, sender=None,\n installation=None,\n assignee=None, changes=None,\n ):\n github_api = RUNTIME_CONTEXT.app_installation_client\n comment_reactions_api_url = f'{comment[\"url\"]}/reactions'\n await github_api.post(\n comment_reactions_api_url,\n preview_api_version='squirrel-girl',\n data={'content': '+1'},\n )\n\n\n run_app(\n name='Thumbs-Up-Bot',\n version='1.0.0',\n url='https://github.com/apps/thuuuuuuuuuuuuuumbs-uuuuuuuuuuuup',\n )\n\nPrerequisites\n-------------\n\nPython 3.7+\n\nContribute octomachinery\n------------------------\n\n**Want to add something to upstream?** Feel free to submit a PR or file\nan issue if unsure.\nNote that PR is more likely to be accepted if it includes tests and\ndetailed description helping maintainers to understand it better \ud83c\udf89\n\nOh, and be pythonic, please \ud83d\udc0d\n\n**Don't know how?** Check out `How to Contribute to Open Source\n<https://opensource.guide/how-to-contribute/>`_ article by GitHub \ud83d\ude80\n\nLicense\n-------\n\nThe source code and the documentation in this project are released under\nthe `GPL v3 license`_.\n\n.. _`GPL v3 license`:\n https://github.com/sanitizers/octomachinery/blob/master/LICENSE\n\nFor Enterprise\n--------------\n\noctomachinery is available as part of the Tidelift Subscription.\n\nThe octomachinery maintainers and the maintainers of thousands of other packages\nare working with Tidelift to deliver one enterprise subscription that covers\nall of the open source you use.\n\n`Learn more <https://tidelift.com/subscription/pkg/pypi-octomachinery?utm_source=pypi-octomachinery&utm_medium=referral&utm_campaign=github>`_.\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "Invisible engine driving octobot machines. Simple, yet powerful.",
"version": "0.3.7",
"project_urls": {
"CI: GitHub": "https://github.com/sanitizers/octomachinery/actions?workflow=Build/Test/Publish",
"Chat: Matrix": "https://matrix.to/#/#octomachinery:matrix.org",
"Chat: Matrix (@webknjaz)": "https://matrix.to/#/@webknjaz:matrix.org",
"Chat: Matrix (PyBA)": "https://matrix.to/#/#pyba:matrix.org",
"Docs: RTD": "https://docs.octomachinery.dev",
"GitHub: issues": "https://github.com/sanitizers/octomachinery/issues",
"GitHub: repo": "https://github.com/sanitizers/octomachinery",
"Homepage": "https://octomachinery.dev"
},
"split_keywords": [
"bot",
"framework",
"framework for writing github apps",
"github",
"github actions",
"github api",
"github apps",
"github checks api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8f1473e8db5442786bf71bfa27be9b0dc86c8f7008f211503d4c3139f42720d4",
"md5": "67190f64211743007743d33369629fce",
"sha256": "97a570bb09c8b9c94f85488c4663dcee89a19e5bfb6543302063efbc6c4c076b"
},
"downloads": -1,
"filename": "octomachinery-0.3.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67190f64211743007743d33369629fce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 75123,
"upload_time": "2023-06-17T19:50:46",
"upload_time_iso_8601": "2023-06-17T19:50:46.922492Z",
"url": "https://files.pythonhosted.org/packages/8f/14/73e8db5442786bf71bfa27be9b0dc86c8f7008f211503d4c3139f42720d4/octomachinery-0.3.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "801d0bdbb2ff840968b74077d187e048e49f08d75276b2c278c0a362e61c1b48",
"md5": "a370b98cba322417e505d121835692a3",
"sha256": "38e6cafaf14abbc46daea84e7457e45de2b2b2a904aff4beefb3427a4af90bcc"
},
"downloads": -1,
"filename": "octomachinery-0.3.7.tar.gz",
"has_sig": false,
"md5_digest": "a370b98cba322417e505d121835692a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 80208,
"upload_time": "2023-06-17T19:50:48",
"upload_time_iso_8601": "2023-06-17T19:50:48.583289Z",
"url": "https://files.pythonhosted.org/packages/80/1d/0bdbb2ff840968b74077d187e048e49f08d75276b2c278c0a362e61c1b48/octomachinery-0.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-17 19:50:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sanitizers",
"github_project": "octomachinery",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "octomachinery"
}
JSON
