| 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","commits","connections/github","index","installing-providers-from-sources","operators/index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":5,"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.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},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","commits.rst","connections/github.rst","index.rst","installing-providers-from-sources.rst","operators/index.rst"],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"]],"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"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method"},terms:{"0":[0,1,2,3,4,5,6,8,10,11],"01":7,"02":7,"03":7,"07":7,"08":7,"0a3ff43d41":7,"1":[0,1,2,3,4,5,6,8,10,11],"10":[9,11],"11":10,"12":10,"14":7,"16adc035b1":7,"2":[0,1,2,3,4,5,6,8,10,11],"2021":10,"2022":7,"21076":7,"21398":7,"22056":7,"22226":7,"22382":9,"28":7,"3":[0,1,2,3,4,5,6,7,8,10,11],"4":[0,1,2,3,4,5,6,7,8,9,10,11],"406f":10,"49":10,"4d3a":10,"512":10,"54":10,"5c6e":10,"5d23fbe2bb":7,"60":11,"6674":10,"8ec4":10,"boolean":5,"class":9,"do":10,"function":[0,3,5,11],"import":10,"new":0,"return":[0,5,11],"static":0,"try":11,"while":5,By:10,For:[3,7,10],If:10,It:10,The:[8,10],There:10,To:10,about:10,abov:10,access:8,account:8,achiev:11,act:5,action:3,ad:[7,9],add:[7,9],airflow:[10,11],airflowexcept:11,aka:10,all:[9,11],all_tag:11,allow:0,alreadi:10,also:[10,11],an:[0,1,2,3,4,5,6,7,8,9,10,11],ani:[5,10,11],apach:[5,10,11],apache_airflow_providers_github:10,api:[3,8,9],ar:[9,10],arg:0,asc:10,authent:8,avail:10,ba4b:10,base:[0,3,5],basegithubrepositorysensor:[5,11],basehook:0,baseoper:3,basesensoroper:5,bash:10,behaviour:0,belong:10,below:10,bin:10,binari:10,bool:11,bst:10,build:[10,11],call:3,callabl:[3,5,11],can:[5,8,9,10,11],cde15c6e4d3a8ec4ecf4ba4b6674e08ad7de406f:10,cde1:10,certif:10,certifi:10,chang:[5,7],changelog:[7,9],chapter:10,check:[5,7,10],checksum:10,choos:10,classifi:[7,9],client:[0,11],cloud:8,code:10,com:[3,8,10],commit:7,conn_name_attr:0,conn_typ:0,connect:[0,3,5,9],contain:10,context:[3,5],correct:10,creat:[3,8,10],creation:[5,11],curl:10,custom:0,d7de:10,d:10,dag:[9,11],data:8,def:11,default_conn_nam:0,defin:[3,5],dep:10,deploy:8,deriv:[3,5],describ:10,design:3,dest:10,detail:[7,9,10],dev0:[0,1,2,3,4,5,6,7,8,9,10,11],dict:[3,5],dictionari:3,diff:10,differ:10,directli:11,directori:10,distribut:10,doc:8,docstr:7,document:7,down:10,download:10,drop:10,e08a:10,e:11,ecf4:10,echo:10,en:8,enterpris:[0,8],error:11,essenti:10,ex:5,exampl:[9,10,11],example_dag:11,example_github:11,example_sensor:11,example_tag_sensor:11,except:11,execut:[3,5,11],exist:[5,9],experiment:[0,1,2,3,4,5,6,7,8,9,10,11],f5b96315fe:7,f:11,fail:11,featur:[0,1,2,3,4,5,6,7,8,9,10,11],feb:7,field:0,file:10,fingerprint:10,folder:10,follow:[8,10,11],format:8,foundat:10,framework:9,from:[3,5,9,11],full:5,full_name_or_id:11,fulli:5,further:[3,11],get:10,get_conn:0,get_repo:11,get_tag:11,get_template_context:3,get_ui_field_behaviour:0,get_us:11,github:[10,11],github_conn_id:[0,3,5],github_default:[0,3,5],github_error:11,github_list_repo:11,github_method:[3,11],github_method_arg:[3,11],github_sensor:11,githubexcept:11,githubhook:0,githuboper:[3,11],githubsensor:[5,11],githubtagsensor:[5,11],gmail:10,good:10,gpg:10,guid:[3,10],gz:10,high:7,hook:2,hook_nam:0,host:8,hostnam:[0,8],how:[3,10],http:[3,8,10],i:10,id:[0,10],ignor:11,implement:11,includ:7,indic:10,info:11,inform:[3,7],initi:[0,9],install_requir:9,instruct:10,interact:[0,3],issuer:10,its:5,jinja:3,ka:10,kaxil:10,kaxilnaik:10,keep:8,kei:10,know:10,kwarg:[0,3,5],l:10,la:10,lambda:11,latest:[7,8],left:10,level:[5,7,11],like:11,link:10,list:[7,9,11],list_repo_tag:11,local:10,log:11,look:3,ls:10,made:10,main:[3,10],manag:10,march:7,match:10,method:[3,5,11],method_nam:[5,11],method_param:[5,11],mirror:10,misc:11,mistakenli:9,mktemp:10,model:3,monitor:5,more:3,most:10,naik:10,name:[3,5,11],none:[3,5,10,11],o:10,offici:10,onc:10,one:10,oper:[2,9],option:[3,5,8,11],org:10,origin:10,overrid:5,own:11,owner:10,package_nam:10,package_vers:10,page:10,param:7,paramet:[0,3,5],pass:11,perform:[0,3],permiss:8,person:8,pgp:10,pgpk:10,pgpv:10,pip:10,pleas:10,poke:5,poke_interv:11,pre:[3,5,7],previou:10,primari:10,process:[3,11],provid:[8,10,11],provider_download_dir:10,py3:10,py:11,pygithub:[3,5,9,11],pypi:9,python:[3,9,10],qualifi:5,rais:11,recommend:10,refer:[0,3,5],releas:[7,9],relev:10,remov:10,render:3,repo:[5,11],repositori:[5,9,11],repository_nam:[5,11],requir:[3,8],respons:[3,5],result:11,result_processor:[3,5,11],retriev:0,rsa:10,run:10,s:10,same:3,sat:10,script:10,sdist:10,sdk:3,secur:8,see:7,select:10,self:[0,3,5,10],sensor:[2,9],sep:10,server:10,sha512:10,sha:10,shasum:10,should:[5,8,10],sign:10,signatur:10,similar:11,softwar:10,sourc:[0,3,5,9,11],specifi:8,step:10,str:[0,3,5,11],string:8,subject:7,sum:10,support:9,tag:[5,11],tag_check:[5,11],tag_nam:[5,11],tag_sensor:11,take:3,tar:10,task_id:11,templat:3,template_field:[3,5],temporari:10,thi:[0,1,2,3,4,5,6,7,8,9,10,11],those:10,timeout:11,token:[0,8],top:[9,10,11],trove:9,trust:10,type:[7,8,9,11],unknown:10,url:8,us:[3,8,10,11],user:[10,11],v1:11,v3:8,valid:10,version:[7,9,10],via:[9,10],wait:11,want:10,warn:10,well:10,when:3,which:5,whl:10,why:10,worri:10,x:11,you:[9,10,11],your:[8,11]},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>","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"],titleterms:{"0":[7,9],"1":[7,9],"2":[7,9],"3":9,"class":[0,3,5],airflow:[0,1,2,3,4,5,6,7,9],apach:[7,9],bug:9,commit:9,configur:8,connect:8,content:[0,3,5,9],fix:9,from:10,github:[0,1,2,3,4,5,6,7,8,9],guid:9,hook:[0,1],instal:[9,10],integr:10,misc:9,modul:[0,3,5],oper:[3,4,11],packag:[7,9,10],pip:9,provid:[0,1,2,3,4,5,6,7,9],pypi:10,refer:9,releas:10,requir:9,resourc:9,sensor:[5,6,11],sourc:10,submodul:[1,4,6],subpackag:2,verifi:10}}) |