Metadata-Version: 2.1
Name: octomachinery
Version: 0.3.7
Summary: Invisible engine driving octobot machines. Simple, yet powerful.
Home-page: https://octomachinery.dev
Author: Sviatoslav Sydorenko (@webknjaz)
Author-email: wk+octomachinery@sydorenko.org.ua
License: GPLv3+
Project-URL: Chat: Matrix, https://matrix.to/#/#octomachinery:matrix.org
Project-URL: Chat: Matrix (PyBA), https://matrix.to/#/#pyba:matrix.org
Project-URL: Chat: Matrix (@webknjaz), https://matrix.to/#/@webknjaz:matrix.org
Project-URL: CI: GitHub, https://github.com/sanitizers/octomachinery/actions?workflow=Build/Test/Publish
Project-URL: Docs: RTD, https://docs.octomachinery.dev
Project-URL: GitHub: issues, https://github.com/sanitizers/octomachinery/issues
Project-URL: GitHub: repo, https://github.com/sanitizers/octomachinery
Keywords: Bot,Framework,Framework for writing GitHub Apps,GitHub,GitHub Actions,GitHub API,GitHub Apps,GitHub Checks API
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Environment :: Console
Classifier: Environment :: Other Environment
Classifier: Environment :: Web Environment
Classifier: Framework :: AsyncIO
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Version Control
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/x-rst
Provides-Extra: docs
Provides-Extra: testing
License-File: LICENSE

.. 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>`_.
