Skip to main content

Invisible engine driving octobot machines. Simple, yet powerful.

Project description

SWUbanner octomachinery @ PyPI octomachinery is available as part of the Tidelift Subscription GitHub Actions CI/CD workflows status Matrix Room — #octomachinery:matrix.org Matrix Space — #pyba:matrix.org Documentation Status

octomachinery: Bots Without Boilerplate

Invisible engine driving octobot machines. Simple, yet powerful.

Web-site @ https://octomachinery.dev. Stay tuned!

How-to create a GitHub Bot tutorial is ready for preview @ tutorial.octomachinery.dev

Elevator pitch

Here’s how you 👍 a just-created comment:

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 article by GitHub 🚀

License

The source code and the documentation in this project are released under the GPL v3 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

octomachinery-0.3.11.tar.gz (85.8 kB view details)

Uploaded Source

Built Distribution

octomachinery-0.3.11-py3-none-any.whl (74.9 kB view details)

Uploaded Python 3

File details

Details for the file octomachinery-0.3.11.tar.gz.

File metadata

  • Download URL: octomachinery-0.3.11.tar.gz
  • Upload date:
  • Size: 85.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.5

File hashes

Hashes for octomachinery-0.3.11.tar.gz
Algorithm Hash digest
SHA256 cccc364fddbc52a9fb172745b3c07774b09c5ff1bc3622ae084c7c5fea71e51a
MD5 10048a8ea3066750bae2489dbf0307f6
BLAKE2b-256 f45809d839863902467b6a833b67a6413a895f70456b96c535fad7432e5f0b95

See more details on using hashes here.

File details

Details for the file octomachinery-0.3.11-py3-none-any.whl.

File metadata

File hashes

Hashes for octomachinery-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 fe3db5d76e90f153e6ebecfe4c2edff08b2742716ee0de6c8899c6b31560e1f4
MD5 847db0118b086bf48a9b868e9855cd07
BLAKE2b-256 15efd3ef8a3804640bd1efff5343be26feab275b6550eb7baf00fbd5ad0d711b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page