docs-archive/apache-airflow-providers-github/2.1.0/searchindex.js

Search.setIndex({"docnames": ["_api/airflow/providers/github/hooks/github/index", "_api/airflow/providers/github/hooks/index", "_api/airflow/providers/github/index", "_api/airflow/providers/github/operators/github/index", "_api/airflow/providers/github/operators/index", "_api/airflow/providers/github/sensors/github/index", "_api/airflow/providers/github/sensors/index", "_api/tests/system/providers/github/example_github/index", "_api/tests/system/providers/github/index", "commits", "connections/github", "index", "installing-providers-from-sources", "operators/index"], "filenames": ["_api/airflow/providers/github/hooks/github/index.rst", "_api/airflow/providers/github/hooks/index.rst", "_api/airflow/providers/github/index.rst", "_api/airflow/providers/github/operators/github/index.rst", "_api/airflow/providers/github/operators/index.rst", "_api/airflow/providers/github/sensors/github/index.rst", "_api/airflow/providers/github/sensors/index.rst", "_api/tests/system/providers/github/example_github/index.rst", "_api/tests/system/providers/github/index.rst", "commits.rst", "connections/github.rst", "index.rst", "installing-providers-from-sources.rst", "operators/index.rst"], "titles": ["<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.hooks.github</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.hooks</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.operators.github</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.operators</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.sensors.github</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">airflow.providers.github.sensors</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.github.example_github</span></code>", "<code class=\"xref py py-mod docutils literal notranslate\"><span class=\"pre\">tests.system.providers.github</span></code>", "Package apache-airflow-providers-github", "GitHub Connection", "<code class=\"docutils literal notranslate\"><span class=\"pre\">apache-airflow-providers-github</span></code>", "Installing from sources", "Operators"], "terms": {"thi": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "allow": 0, "you": [0, 11, 12, 13], "connect": [0, 3, 5, 9, 11], "githubhook": [0, 9, 11], "github_conn_id": [0, 3, 5], "default_conn_nam": 0, "arg": 0, "kwarg": [0, 3, 5], "sourc": [0, 3, 5, 7, 11, 13], "base": [0, 3, 5], "basehook": 0, "interact": [0, 3], "perform": [0, 3], "retriev": 0, "client": [0, 13], "paramet": [0, 3, 5], "str": [0, 3, 5, 13], "refer": [0, 3, 5], "id": [0, 12], "conn_name_attr": 0, "github_default": [0, 3, 5], "conn_typ": 0, "hook_nam": 0, "get_conn": 0, "function": [0, 3, 5, 9, 11, 13], "initi": [0, 11], "new": [0, 9], "token": [0, 10], "hostnam": [0, 10], "enterpris": [0, 10], "static": 0, "get_ui_field_behaviour": 0, "return": [0, 5, 13], "custom": 0, "field": 0, "behaviour": 0, "test_connect": 0, "test": [0, 9, 11, 13], "2": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13], "1": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13], "0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13], "4": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "dev0": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "i": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "an": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "experiment": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13], "featur": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 12, 13], "hook": 2, "oper": [2, 11], "sensor": [2, 11], "githuboper": [3, 9, 11, 13], "github_method": [3, 13], "github_method_arg": [3, 13], "none": [3, 5, 12, 13], "result_processor": [3, 5, 13], "model": 3, "baseoper": 3, "action": 3, "api": [3, 10, 11], "design": [3, 9], "us": [3, 9, 10, 11, 12, 13], "python": [3, 11, 12], "sdk": 3, "http": [3, 10, 11, 12], "com": [3, 10, 11, 12], "pygithub": [3, 5, 11, 13], "For": [3, 9, 12], "more": 3, "inform": [3, 9], "how": [3, 12], "take": 3, "look": 3, "guid": [3, 12], "pre": [3, 5, 9], "defin": [3, 5], "method": [3, 5, 13], "name": [3, 5, 13], "from": [3, 5, 11, 13], "call": 3, "option": [3, 5, 10, 13], "dict": [3, 5], "requir": [3, 10], "templat": 3, "callabl": [3, 5, 13], "further": [3, 13], "process": [3, 13], "respons": [3, 5], "template_field": [3, 5], "execut": [3, 5, 13], "context": [3, 5], "main": [3, 9, 11, 12], "deriv": [3, 5], "when": [3, 9], "creat": [3, 10, 12], "same": 3, "dictionari": 3, "render": 3, "jinja": 3, "get_template_context": 3, "githubsensor": [5, 9, 11, 13], "method_nam": [5, 13], "method_param": [5, 13], "basesensoroper": 5, "which": 5, "can": [5, 10, 11, 12, 13], "monitor": 5, "ani": [5, 12, 13], "chang": [5, 9], "boolean": 5, "act": 5, "poke": 5, "while": 5, "should": [5, 10, 12], "overrid": 5, "basegithubrepositorysensor": [5, 13], "repository_nam": [5, 13], "repositori": [5, 11, 13], "level": [5, 9, 13], "full": 5, "qualifi": 5, "ex": 5, "apach": [5, 12, 13], "githubtagsensor": [5, 13], "tag_nam": [5, 13], "tag": [5, 13], "its": 5, "creation": [5, 13], "fulli": 5, "tag_check": [5, 13], "repo": [5, 13], "check": [5, 9, 12], "exist": [5, 11], "env_id": 7, "dag_id": 7, "example_github_oper": 7, "tag_sensor": [7, 13], "test_run": 7, "example_github": [8, 13], "detail": [9, 11, 12], "commit": 9, "list": [9, 11, 13], "version": [9, 11, 12], "high": 9, "changelog": [9, 11], "see": [9, 11], "includ": 9, "latest": [9, 10], "2022": 9, "07": 9, "11": [9, 12], "subject": 9, "ef79a0d1c4": 9, "onli": [9, 11], "assert": 9, "stuff": 9, "mypi": 9, "type": [9, 10, 11, 13], "24937": 9, "7f749b653c": 9, "add": [9, 11], "24903": [9, 11], "0de31bd73a": 9, "06": 9, "29": 9, "move": 9, "depend": 9, "insid": 9, "folder": [9, 12], "24672": 9, "09": 9, "dcdcf3a2b8": 9, "updat": 9, "releas": [9, 11], "note": 9, "rc2": 9, "mai": 9, "24307": 9, "717a7588bc": 9, "descript": 9, "remov": [9, 11, 12], "doubl": 9, "min": 9, "specif": 9, "24292": 9, "aeabe994b3": 9, "prepar": 9, "doc": [9, 10], "": [9, 12], "24231": 9, "5f6d7d202e": 9, "05": 9, "migrat": 9, "exampl": [9, 11, 12, 13], "dag": [9, 11], "22446": 9, "24134": 9, "82d5f7cdb7": 9, "04": 9, "__init__": [9, 11], "24214": [9, 11], "4a85370ca9": 9, "18": 9, "23764": 9, "75c60923e0": 9, "12": [9, 12], "document": 9, "23631": 9, "8b6b0848a3": 9, "23": 9, "brees": 9, "build": [9, 12, 13], "pull": 9, "verifi": 9, "imag": 9, "23104": 9, "6933022e94": 9, "10": [9, 11, 13], "fix": 9, "error": [9, 13], "22884": 9, "03": 9, "22": 9, "d7dbfb7e26": 9, "bugfix": 9, "22383": 9, "14": 9, "16adc035b1": 9, "classifi": [9, 11], "march": 9, "22226": 9, "f5b96315fe": 9, "feb": 9, "22056": 9, "0a3ff43d41": 9, "02": 9, "08": 9, "docstr": 9, "param": 9, "21398": 9, "01": 9, "28": 9, "5d23fbe2bb": 9, "ad": [9, 11], "21076": 9, "The": [10, 12], "provid": [10, 12, 13], "access": 10, "person": 10, "permiss": 10, "en": 10, "authent": 10, "keep": 10, "your": [10, 13], "account": 10, "data": 10, "secur": 10, "cloud": 10, "host": 10, "specifi": 10, "url": 10, "string": 10, "follow": [10, 12, 13], "format": 10, "deploy": 10, "v3": 10, "pypi": 11, "all": [11, 13], "class": 11, "ar": [11, 12], "top": [11, 12, 13], "below": [11, 12], "minimum": 11, "support": 11, "via": [11, 12], "pip": [11, 12], "avail": [11, 12], "explain": 11, "polici": 11, "blob": 11, "readm": 11, "md": 11, "mistakenli": 11, "install_requir": 11, "22382": 11, "trove": 11, "framework": 11, "page": 12, "describ": 12, "download": 12, "airflow": [12, 13], "github": [12, 13], "offici": 12, "also": [12, 13], "most": 12, "choos": 12, "differ": 12, "select": 12, "drop": 12, "down": 12, "left": 12, "sdist": 12, "whl": 12, "want": 12, "origin": 12, "checksum": 12, "signatur": 12, "softwar": 12, "foundat": 12, "asc": 12, "sha512": 12, "those": 12, "If": 12, "code": 12, "link": 12, "abov": 12, "contain": 12, "file": 12, "pgp": 12, "kei": 12, "It": 12, "essenti": 12, "sha": 12, "gpg": 12, "pleas": 12, "well": 12, "relev": 12, "distribut": 12, "recommend": 12, "get": 12, "directori": 12, "mirror": 12, "pgpk": 12, "ka": 12, "To": 12, "binari": 12, "pgpv": 12, "tar": 12, "gz": 12, "made": 12, "sat": 12, "sep": 12, "49": 12, "54": 12, "2021": 12, "bst": 12, "rsa": 12, "cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f": 12, "issuer": 12, "kaxilnaik": 12, "org": 12, "good": 12, "kaxil": 12, "naik": 12, "unknown": 12, "aka": 12, "gmail": 12, "warn": 12, "user": [12, 13], "certifi": 12, "trust": 12, "There": 12, "indic": 12, "belong": 12, "owner": 12, "primari": 12, "fingerprint": 12, "cde1": 12, "5c6e": 12, "4d3a": 12, "8ec4": 12, "ecf4": 12, "ba4b": 12, "6674": 12, "e08a": 12, "d7de": 12, "406f": 12, "correct": 12, "do": 12, "worri": 12, "about": 12, "certif": 12, "manag": 12, "self": 12, "sign": 12, "why": 12, "By": 12, "import": 12, "server": 12, "previou": 12, "step": 12, "know": 12, "valid": 12, "alreadi": 12, "sum": 12, "run": 12, "shasum": 12, "512": 12, "diff": 12, "match": 12, "one": 12, "local": 12, "script": 12, "bin": 12, "bash": 12, "package_vers": 12, "package_nam": 12, "provider_download_dir": 12, "mktemp": 12, "d": 12, "dep": 12, "dest": 12, "curl": 12, "apache_airflow_providers_github": 12, "py3": 12, "l": 12, "o": 12, "echo": 12, "la": 12, "onc": 12, "instruct": 12, "chapter": 12, "temporari": 12, "own": 13, "pass": 13, "result": 13, "like": 13, "get_us": 13, "get_repo": 13, "implement": 13, "system": 13, "py": 13, "github_list_repo": 13, "task_id": 13, "lambda": 13, "log": 13, "info": 13, "full_name_or_id": 13, "get_tag": 13, "list_repo_tag": 13, "wait": 13, "v1": 13, "example_tag_sensor": 13, "timeout": 13, "60": 13, "poke_interv": 13, "similar": 13, "achiev": 13, "directli": 13, "def": 13, "bool": 13, "try": 13, "all_tag": 13, "x": 13, "except": 13, "githubexcept": 13, "github_error": 13, "ignor": 13, "misc": 13, "rais": 13, "airflowexcept": 13, "f": 13, "fail": 13, "e": 13, "github_sensor": 13, "example_sensor": 13}, "objects": {"airflow.providers": [[2, 0, 0, "-", "github"]], "airflow.providers.github": [[1, 0, 0, "-", "hooks"], [4, 0, 0, "-", "operators"], [6, 0, 0, "-", "sensors"]], "airflow.providers.github.hooks": [[0, 0, 0, "-", "github"]], "airflow.providers.github.hooks.github": [[0, 1, 1, "", "GithubHook"]], "airflow.providers.github.hooks.github.GithubHook": [[0, 2, 1, "", "conn_name_attr"], [0, 2, 1, "", "conn_type"], [0, 2, 1, "", "default_conn_name"], [0, 3, 1, "", "get_conn"], [0, 3, 1, "", "get_ui_field_behaviour"], [0, 2, 1, "", "hook_name"], [0, 3, 1, "", "test_connection"]], "airflow.providers.github.operators": [[3, 0, 0, "-", "github"]], "airflow.providers.github.operators.github": [[3, 1, 1, "", "GithubOperator"]], "airflow.providers.github.operators.github.GithubOperator": [[3, 3, 1, "", "execute"], [3, 2, 1, "", "template_fields"]], "airflow.providers.github.sensors": [[5, 0, 0, "-", "github"]], "airflow.providers.github.sensors.github": [[5, 1, 1, "", "BaseGithubRepositorySensor"], [5, 1, 1, "", "GithubSensor"], [5, 1, 1, "", "GithubTagSensor"]], "airflow.providers.github.sensors.github.BaseGithubRepositorySensor": [[5, 3, 1, "", "poke"]], "airflow.providers.github.sensors.github.GithubSensor": [[5, 3, 1, "", "poke"]], "airflow.providers.github.sensors.github.GithubTagSensor": [[5, 3, 1, "", "poke"], [5, 3, 1, "", "tag_checker"], [5, 2, 1, "", "template_fields"]], "tests.system.providers": [[8, 0, 0, "-", "github"]], "tests.system.providers.github": [[7, 0, 0, "-", "example_github"]], "tests.system.providers.github.example_github": [[7, 4, 1, "", "DAG_ID"], [7, 4, 1, "", "ENV_ID"], [7, 4, 1, "", "tag_sensor"], [7, 4, 1, "", "test_run"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:method", "4": "py:data"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "method", "Python method"], "4": ["py", "data", "Python data"]}, "titleterms": {"airflow": [0, 1, 2, 3, 4, 5, 6, 9, 11], "provid": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 11], "github": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "hook": [0, 1], "modul": [0, 3, 5, 7], "content": [0, 3, 5, 7, 11], "class": [0, 3, 5], "submodul": [1, 4, 6, 8], "subpackag": 2, "oper": [3, 4, 13], "sensor": [5, 6, 13], "test": [7, 8], "system": [7, 8], "example_github": 7, "packag": [9, 11, 12], "apach": [9, 11], "2": [9, 11], "1": [9, 11], "0": [9, 11], "3": [9, 11], "connect": 10, "configur": 10, "guid": 11, "refer": 11, "resourc": 11, "commit": 11, "instal": [11, 12], "requir": 11, "featur": 11, "break": 11, "chang": 11, "bug": 11, "fix": 11, "misc": 11, "from": 12, "sourc": 12, "releas": 12, "integr": 12, "verifi": 12, "pypi": 12}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1, "sphinx.ext.intersphinx": 1, "sphinx": 56}})