airflow.providers.github.operators.github

Module Contents

Classes

GithubOperator

GithubOperator to interact and perform action on GitHub API.

class airflow.providers.github.operators.github.GithubOperator(*, github_method, github_conn_id='github_default', github_method_args=None, result_processor=None, **kwargs)[source]

Bases: airflow.models.BaseOperator

GithubOperator to interact and perform action on GitHub API. This operator is designed to use GitHub Python SDK: https://github.com/PyGithub/PyGithub

See also

For more information on how to use this operator, take a look at the guide: Operators

Parameters
  • github_conn_id (str) -- reference to a pre-defined GitHub Connection

  • github_method (str) -- method name from GitHub Python SDK to be called

  • github_method_args (Optional[dict]) -- required method parameters for the github_method. (templated)

  • result_processor (Optional[Callable]) -- function to further process the response from GitHub API

template_fields = ['github_method_args'][source]
execute(self, context)[source]

This is the main method to derive when creating an operator. Context is the same dictionary used as when rendering jinja templates.

Refer to get_template_context for more context.

Was this entry helpful?