From 931f50bcd680d465336424fab9142f12b2b9f15c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 5 Dec 2023 23:27:00 +0000 Subject: [PATCH] Update documentation --- latest/.buildinfo | 2 +- latest/.doctrees/commands/run.doctree | Bin 11759 -> 11759 bytes latest/.doctrees/environment.pickle | Bin 285778 -> 285778 bytes .../.doctrees/methoddocs/application.doctree | Bin 83781 -> 83781 bytes .../.doctrees/methoddocs/exceptions.doctree | Bin 105835 -> 105835 bytes .../.doctrees/methoddocs/middlewares.doctree | Bin 139424 -> 139424 bytes latest/.doctrees/methoddocs/runner.doctree | Bin 163913 -> 163913 bytes .../methoddocs/subscriptions.doctree | Bin 171615 -> 171615 bytes latest/.doctrees/methoddocs/utils.doctree | Bin 178507 -> 178507 bytes latest/commands/run.html | 3 ++- latest/genindex.html | 1 + latest/index.html | 1 + latest/methoddocs/application.html | 1 + latest/methoddocs/exceptions.html | 1 + latest/methoddocs/middlewares.html | 1 + latest/methoddocs/runner.html | 1 + latest/methoddocs/subscriptions.html | 1 + latest/methoddocs/utils.html | 1 + latest/py-modindex.html | 1 + latest/search.html | 1 + latest/searchindex.js | 2 +- latest/userguides/development.html | 1 + latest/userguides/quickstart.html | 1 + 23 files changed, 16 insertions(+), 3 deletions(-) diff --git a/latest/.buildinfo b/latest/.buildinfo index 5818901d..32905845 100644 --- a/latest/.buildinfo +++ b/latest/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: ccb6ed74fa352cc8fbfede0bd0036fd7 +config: ac89d44b62bac8d6bc3661d438dc9349 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/latest/.doctrees/commands/run.doctree b/latest/.doctrees/commands/run.doctree index d3fa1b412a012b2645a066065e0a7213ec0212f9..03efa2d273db1af926fbdcc76e12d6cec7686972 100644 GIT binary patch delta 37 ncmaDK{XTlbW#P$!BDRw+3EOS<6A@s9aVGnTC~f{N`b8W7B~lKI delta 37 ncmaDK{XTlbW#P$!BDRw+3EOS<6A@s9aVGnTC~f{N`b8W7B~lKI diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle index 6d5784552c142be08de4401f87d1f8bc15006774..87a218cba687302099acbe723fd61c6879f67521 100644 GIT binary patch delta 3048 zcmZWrc~n&A73X{36$XcG24zGMaDZW8a9A{A6bu^0Wkxn}Yii<#%M+QZxMXqR)Y?un z8seLHvsA0L_1F_@^l<8B@Au}ho&NLg?{~j@@AuvN zzI)$0TW>mBZ`$*bO*y;RBKcyJt1Dv+eqXowRkJHrC8~o4)6_D+L(|ikgwY%9TYiH}qA`kN)+2r|i4);PjKYqe9hxu;|nDqH%Sd97?y>N9OhO6F9}$($Ljyp$D7 zfu<-a*^$cn%qTWZ+a|>stxR@CD!Vd`AtI-?NNPr;axycDtP_N1r$fUGJD-y1LES8mg0QngW_Rzrji8KMif(tweCdes05a*G`usq?q`cC7)!2e zSbR%}9n~5OTUHm$lIj}Xxt2&`+vZ!%c;PEHMm;%)wML=k0W+yzE@$&X18`6cTd%{G z-?DGR1KJZGvX6D`itX(NF}v8Ah=9S<&snPh*Uh20@r`V*4R8Yuwn57@;y zEPY?OwA-R=-E2}1E|5Z^HFR;6G*8k{NsV+aSwjPNNT2s%X(B817ao|PhTZKE_m zU3*CSgNdc7_7-V!C`(n>T#>@9ih0o(_56RON-vdBIGx(VL)2O?Up0g!V`L-m&yp~| zk;mg(jl2hX8o3c)6KDe=mX06O5=+Cs35)tR3zmXEH1Y&yMayCCV0Jvv#I3mCI5*+4 z!@K||9py=Q=`f#$=bL$wlCd%#OR^vsS2oe&t4C<@S`(jzUp8rrVOY?_!f@3Q?#4l+ z!s$jxz_4br9dVebr-r|=6 zMz}c`BJg=3z4~kU%z(xl+@wyr&5!8Iw6h&o7g6H#?(iQO*8Rji;w>lP_xI@d8=muI zb^3i?&2YB?%sBM|4@X}OGpa8h@PFybVJ}Ge@H@JJ&Po=e#y;X-1Xk2<9*dMTPhq5z z(PN!Iyh;4U6aJ(VN8%LZ6V_YJeaesND}#GOxSIGQR~XK`$3=lVZeAD`KBr@z`i`=q zH@Th(n1Ck?kf<(r!FOxij12~GqVE(7{p(D)5zwiVC7|+?xmkT1z@)=1!4RcGa>|zQ z{5dKJ-R!xzr-f>9&j^bcZfzy6s&Lq^!@NjXC4=-vqL*R14jYEF!<;-(R$;Jj7~Iy^pS=R#=-KI zv?1a$Y7@j|(8h-=M4KJ1U~O=arI;Enu8j;=xNOCZg)oBV>-j<`UoEClt$Za!`_5@G zYvmwAXV$9=>)nOLbz$*cSYj7u?aY??!sk|cX1-DFQFo4pi;RZ!nz1m%APzIlFDK!l zvG59WpfnD$m<U>p4S1jkVwJ1E>>Vw; z#sme~0~7o@r6&K`g8kf(v&juT>6;bfhB6ZK-7t~FK{u3>=rJBfl9)Ok+$464r`wf; z{~iw$NE8-n4j&akJmpJYNQbNkmM5JQA)6FqFivCqO=l z!xN}g(lMkQ22xMwmBXk+?L)LpRDMMkRkPY(5VZ-%8q~oVTq~TE^Qt|dgx{BH-vIhhOt@Fz#sJwDn0RNwUU^mT1)29Wn rX5ZRLf3A~0HMqk*E`T-rHJ$WJg3~)T{$rPg4*gSIuil&lRo(svw%N_x delta 3073 zcmZWrdstM*72mlt!cun81(k0NsIP8JTi#T!>`fY_6t0MB ztFuY;*)de7o1Xtk<;^!9zuzDy23X~uCOJ94ns#@|NddNM!*kg&%GLmTYwc9o z7GS@>x=xM{us*!t&8&2$&K}}g;i~s2RgOgESLv}zN$M=+yRqS+TSbOEbS{R@RN7O*ltXD|)OoI4 zpO5-9B{wx#*_0Nc)HsGJH`9hG@1!>19P^bGDFry@*Hch`Gjpi2CoPm%mF|=zWrJfL zdPXa6rf(N{jLx(uE{A161`$eCMs&zlv3p!iv1E=`KFi3*^?3#O`juk+7c$d{T{)7O z5n|W$)E7$aNhc?Db7{46;En2mBf+niDD|Tww)@S7Dp15_GhNI{j|YF zNMc+2@_%r%%OjX!MOzR_Zfk$$k_9HWNT#;^zwYgVbAKf>)YCPjZx}@0A|~~Nm1IeX zAC7M!n>E<8iCi`M)l=KaE1KH8GvF|C59to`JKX&<>C?l;8l2bMK^7;$o|QQ7OV>$@ zmYWHA`soTBOSfXcKlxCq@w)-x;{| z)Bu*V(ok66A!VuSk4V2Y5u0l7k>-Vvcy--H$!Jx=8)m4z|CQ>zSV|srW*-e!w|eQ? zi6jw*cF+`(47nZD468fnaBz3fQ1}@~TM!W|yuydhbKyfS#KRLPkOcUygT@g%L>{FM zG6oKHQY$PyNlmcgD9wYp$7wu#a+J=86US)0GIos_O43;ntm(wTsVKpvPPzy_=oEtn z$m=8qSbK~X!gU^570Tkk(1pIeT}a(svk|X{oKm`~DOusMn)s8>%?1L4r54mm}u30xn| z+`KA}z@5{0+{F%Ng5Nx#5wPG4-A@wLh>vItUQso*+iz!{rL6>R|A@K!E4ZWwBcCv8 zk!nv5Z6utBtCi>IIX{H7Yt*LfyU1QDWMS&+3-rPdboKea(Q8`RrcdceNz4HABxY0( z_tCrB(D6(3KN`I7Ic0t?^{X#vs21>A5HrGq0=!3;a)};7FH@5`_X<6x1z{Rl613f? zZhqYH@a+xEeai!ypjO?a9s=*`SvX+YMrdszq3Xk1^zWKD=^=_=eS=pqwT_Hbqrax_ z`A5_*Z}ZGWBzIEL>9)o(F{AqM4!tvg19F_?RT86S-=!zCkqI%lQOm!nLSW$y%B$Od z1r1Q}0Mk744ekXGXEWh24o>NrMP2%kzAJb*wChXtTvRJ8Y#V{v(->K4Wvd|f3NNOjB6DkS zl#SJB@I^aYs==^imaoAo2g}yr?y>Bq27i~z?rCsuI&*3;G?U%eVB|QqUW0pn%r+2g zJo_VYzxehSK*vc;EpY-*?b{DA^`f7!Dh;+z48Y7BURLgKU=q8cjo+KhzSQ9DeDT5GDT%J)B%-A_Lq$Jv>P0hg28&MO3=(YwJ$VmtQqe%1M%fN87O*M! zN_q=e`Lq0w!&doXu=vo4Ik(C>{XiBqh{X(Iv4fa-5VH(o)`6_4)wsCMz3?fITirdK zohR6`*Ue-T^*ovRJ~nOBs|D=Ov{1@nq}dBuEQ5$(m`N1d!7 zSoH0`=;2Tii&j4SMNEY3oT1a%{r&uN+?xDWB#bU(nb_k-;1_IUAuB^uTgWQV94=(# zXok;bkD;lY%?i=%nvGX08U8t&%|TO8Bm!P8VrJa;!6KH2=3Wt-jwZjDjYrd5ELeLn z#wCHFM3~1**feCXm9R`KRCfuwI3T)|m7tMJaaji(E@h=?Ol7!`16*Zd>_8bVWQE=` zHUUl89F~K|Ifp%p=D9g67tPT*_)e@4T+YT38|0L;X%_KW+QBQ|oQ~D>_*#7O+q~fZ zYQ)2ia-1k0`pVfvG|?6Kypo}`f<1ycy18+{W^SzTHa9jn&P_aAslcl!zF@_jV;mNSnCOB?NYqHY?-#@_{yF#D^M-T(o9a z;qWfA0zBb5DAAO`W^M?+VBH>(MJKtY9q_z17T&5igeXp%jnxfsOuZ4jVjPgOYoofk zD$!&*X*Qlqsgum$R3}8QF;!bmiAJMXCHKtLbqh14d z^jfMcT1}P&D2ukzr^VwjBoVyY6gqk)jF3e7sMg7-*c{8qBpMXxPg`~p70g?<6COlq zJ@~9qkSp=%h*B9ktoK1OY-0lm3tyb!SxfyET!u#&oiEjYEK*})4uRMz|OuvF`3 z#OQ{fcof$-j5yNhLOj?skC=5Hk)~b9Ab1DYsK-0Dz)bTVRH@bknsG4{4Z6QYVl>t| z$d-+@X2PdSk?^&Rqu$GhnDgt(Fr&dXJEL9gU5q9=ZZbODJBtYj4% zB!7iGMLrQ!pzGa-c{+NFTG(JVL60-yzn2%-g!%y06QFDX${wH`0qS;ua{aHQ?#P;2 zvGTY@q~*3(1b^9XdwLj)QsEF(RIY^Nc&Q5&t-kAQrkx5bwH< zA`&-yHG?}3aoAmmIOi@v%;_sd9Oz>!fApmzCij=d%dh$vkH6*+JRH8}Z-33hV1KON teW_S>+e74n~-2DdhkF delta 955 zcmY*WT}V@5814+0rbi3YTs4aV!L!OAgv{w?^RGflX)|>tmD?~+Zb#jYQ_Hl%{Auah zdup4CWeRoCz&PEAh7?G4p%>j$5S3RFbR&sWlJ$O@n!9q{gD;*mS z2TGkMacCfQQ3H=vMG&vrNvTn#LAL5O{EWyEr|6c$FrN_vlDcT9&)B1s)>w?DCczPF zHrXz7Mk8miCYzcJraD^(iZk|t zkCTbCa*|@0kS$wIXg*eaA1z<0XA?G5#WS8&Y$*Qe3@m0Agpx|1kmyq9OB_1*8=elI zR8imzw?KB*KFEzIhsvz|kfM^qsOmiAtE(wS^r@F(;EPrTkF;u0uG>Ma3y|v$if>CN zVyOi1sguPQSHdVNL3~;3CRA#PBV^|EQuJqRM<@j>+YV6-aQrTqwMRh#pNI~}m!m^! zpLxB4#9>#%5J(g@VjBW!nw8;-cZAsR>x5Pzk!7H&aTYI2vCkt$H~qq^=;jf`v1SkA zsg`BL<5v;I^lOVe}j{43{t&8${D0wK}rZx4}z3uv*I0*)wNvJ1sf-xbH1nW%hFuR zFw#n;z$!%E^&upZwA}4)s2dyByDws%3AYCEkNXT_iRUch6Hf&qI*=+6C{hy1F_$vpeq0F1kVzY3{B> zFxA2tIH9&6nJE+)Lk<{7ghcgZFM?zgz4Ty(JtR~Q^`Di(eVK2*|HgkfXMG`SeIaYE z-A_W}c3vwa8&icAUCRupg6|3$@t2Sb$s#hD%-^Nu^n?_}s|x*9eFLgaX8g{gJ&G^l z4+%o3ClyqEeYzY0jx(HrKXB0fMP060lO+qs)t+8u_I*MY|J&ExnN;ysZsW~2QrBB+ zW%)aLrB>o{k;!aFrmi{hFFaFB-uKRvO2tW@1l!1w;CXUe$>X&%au)X;4sGIXs4t7^!Gl4q2u8GDI0dXiK`PZ`N*KKv7sj8+&I<0}Oq5yw=O(KKcO zkc^IT%J5^t&R|Pgvp_T)Q~h?tt!E#`K%zfMR+* zj{Pe^aI^d&6&@hj^ke4kFf7?D>>za@i*)T8oCAsO8-k``7EH*ooYZ}#ZaE=Or`ckf zJx{Y2X||MRFVpPRb{o)aQZUrr83~y`haitnt=6IAYWX8DpUrl4kZdi@GT61ByaKsnGeAb2@iUJ3F0^wU1CD&219G ziH7gsh}J-wrC=b8I$$6X5_VTNf)oVZ6xc;K3FU=7@3ErYoZtDq&-46wUe4KAD%@Bq zT=ej^Qi+T53d<_~h$|eEWiFg1GZ|a0S`mwI;Xo|NauFBH-Qq+gByn;yt?mxWEH{`I zqQEfZEAJ%Aw7pa<_A8R)lUXArtyYll*$T42J95t8HXQ5zmhIZQDez{7X*|D<*1ZrD z#D5l>TQ%Z#YC~g_r1?hU9$J5pu2U~eNGD5JUzCdmC9Xa+lvdpn(j`(Q$^{4N>&Z+} zC7Bhk6*%!dH0L1W;z6=4dMqg;k_L24NKIwjpq~pxgNht6BK}O~4#~Ur6JPu+sfnM< zW#TsYD<*Iv#y+b$_&8gdZ#st9}n#m){LbP#9U=IVn^J6`DqGxP3nN7 zAZpVcprM`Ugf29-6V@&C{=$M2AEF-Wf<+V7t9#(Fi8pIiVQ^}nd*C*nc|EX+Xz!)a zTfA@@FakTk?Sx| z`91)XltK_vlv@HWN;5q}P^CR$!J*wv;{2KjJ+yvYhFK&{Kc(*r!HU&PFVYNxsC~Qx zO}J_8Ft|tPVM<688(+=%)+ymho-OCut2}$1XDfO3CeK#?x0q@Th{`};RMCG9Lz&4~ ztv8LU*+$_-5#4DV<=rT>8b6dUU}YH1I|g>LJnt|Ifog`S!v;1Et$0U$2YVCHj@F+5 lH{y8$E+T#I+BVk@YPh4PWB^bY%D8lVzOV&s3qByGtD?-@A-B?_s{n{&wDxNJ@0wX z*L6+PbxqSVF&4Agv;-r||5_XEYTjmbvPar=>~hIkwxD<^>(FXhYit{v7%K<%>pW9Z zlif~h<0f}~oznD;Dd(Abd*M|l4(T!b>pFA7*S7LW7u!A%e5lkS3b(5s6~Zt6*eKJZJ&eLqaX zqWo(@NgQ8$8;MF;Au3~nw7V2LL$qKauEhqenw5AnWbIlr5@6bZquOA=w>Ct@Acz0x z!qjBZwLP*_n<>C3SqUx4e1;pDh~VQ0c%>WTVB~f;mQWHw3g5UBbRebn2Qb_*t|kUWBkTb7OqCT>_d zP0a0$a?$L`qCO*UZ9+dSJmg0Puh@a>#M7GbAC*R)$=vS8E26&TWKd(i--%tsm+!)3 zg7V!06!RX;1{FV?@)}#G=vZ#^X#QX?3dtc-mANg5p(thXKDY&5ZAGWZA}nIdPR8@t zHfWW;{nQxp;vh~7{IDHI1kOB!w*-Fa!C`@wZ{xVYhhCf@6syeSju(-n{M3PE;Pd>b z5S^>y5BCp12y?8;%KZ1oJkEwImWA8g=@2wYnbL{+ z5IuJS?}X@rljsQ1-%kx&`BN|A_+URK@s5koC|{hxieM0@)Lee`DWa6hvyhM>#={b+ z&V~i*U|6*3R9G~Ufe)U;T)M`r^QdSMKMS9A9{OB{1Mgr3CSpsV#b56NJ9Ys3aBJg9?K6J(y2$rbkV9)B_8t;wxB5 zaQF&VWUFszOA0-jA^Lb+a;q$DN+Wq9CnCZqnfRz)+Qh`?_oAG@+lvC7`r5t`K`Y1e zWxdGazGFzyjHGA-w2g^Z2jO%8Wu)!}FdYUyp^pkO@R~k)YX;uihgAgHeyW*_{ir7R zq@PMR@c03GZF;_V02!3NS%87J4^W7a|2lwFwLj8LYEru_MNXn>?nSHI$m5k^_o30x s+=D@G6rV*mgE delta 1805 zcmY*ZYiyHM7~WGhR@+j>U>gP3fpN7LE)(NmvX%{)LyCdGHZ~&6!N%p2w(e43+{Q&F z)jA93gM-?P!6p!fFxqXOL=z!mq9za(6^)DV%LGuSCYl&c@I7CBu6>YA{z=&YYRZm2xRDYC({OFKpHV7v8xPWu7<_NgjSeOR8x`=&i zUk>cipE~Y_VG$PPF9+t0;j3?8oKjYV%JdlREy4CUEnI{vx|mhF0$hVP zzvqV)_L$+?ZcOFwEwJ)$wjhV^2w@68D`c~f1s9!YtYtx*hYM(b#PZ#Rm_AySq3ZAhmmW$_;P1zz5Z zPLV}e%$A-oa@{`YmHz$I81mu(x&^-9j>7`y9K;&}KMmlJz{)pqOyK<>juVPi=5XJ5 zWGX*&U@7>5Fe*gns`&jd%*t>GS_nFhui676|8Exbe0l_9m4d@q6!$nfM?BsLvXu`R zX2(2(N3cFA<^>pd!2)C{r;bv&>blCPV`z(0_6}O(H1|DNz@G|HHHnKG2&0G(%QSuu z!k7#}GnHwb*c7LykK?U4ef|VG;`Eo3BUb((h%tOoZCr!k)v$vcCJHt~}PNwr$_jj9PDXV42RL`Tz9~`q`vu|x}i%x`}z@hBw z#a)d_oGGAI7*J0XP!ANK^XxfKw_)ek&ZC6Dc!Ant=XEjYzko_ox;|78)b?Q^K~JBW z@JAoqq?{MAg5c0aET5vjp;xl$(G1fk&?4`Zr41&M$Dd3|u}T&`DngrB_`(Rv34#$6 z8r0WzT?DO|#Fs{p$3sVvtxcrpqqL2MuZ%%=6lJ9DL@^5v{&+tXUYngS9z-ssZxrC*?Sm9z<3A4~N9~VvjhfUhOPYMD=1!W* zZQQ7gxDSqg=pKr38+Rq#*7S$&ni!{l7P(pF diff --git a/latest/.doctrees/methoddocs/runner.doctree b/latest/.doctrees/methoddocs/runner.doctree index dddfd42d0f2865b3f8878ce457bb3ee9b488b6bf..21b156bb2b86ab55c7bfa85cd61fd5a795d17fca 100644 GIT binary patch delta 1369 zcmY+CZA_C_6vulHAW%wMAYcu&g-59b5IbF4bOHsZEKsDBzF-X743yBPw4D|b<6_X% zxwthGy|~L39XipOWl^_gyGu062eSpYWM)}3W^T(8W3o4goAJXobmu;;Ec^6({^#|c zbDp`q>bbq@3!mG_M%sFPEuF9z(;Rz%4mqaCGm7PJo0<-UI_O2Y7?Mt5VzGUskp5ub zOy9M~>7hnFt#&w5KQ_KvPn(VzAX!GQoG#0oOy-25gTY;NJXlUErVUj|eIz(K92*>r z4a8TEjfO_zlS$1$EE3rs9gMHuITod#1}k#pUx-RYPX-OCRYQ-7Yum5U>zi)Nm3b;v zd+RNs?jMuQi|RM+S=q9v=C9q8rA776XueWR$%|$Ge1Ps6ZqF6DhbC+2m5`a*WwSEu zK&YSkah~Qy8a~og{+pU8dM)a_h>1v^p-9ouU+%xSrvgVUS!>oGvP-!9Cu#|EZxlMdY z{2`|1;uf?9cpvda5g7Rm1LP87=HD-aF+p!Ryn|%O4YcyAmNyw8ARI?ca7u7pB^(j_ zvI<@k3@nGkftR|jv>~l={^O__`dgU$4#{TcACMe=uLb7RI&sa;0_7;3d3ce}I>4TV zds^s%7GhydTfmB`(Jk;tp$I*wL>|O{A<_*VjGOHSCxW;Y4iT?Z-wEJLMNX{=g3h#BcC&9~d$JEdh!1J~*=S EU+ST=#sB~S delta 1397 zcmZ9KYfPI}7{_~_jZq4;g@sWBIy!BIjSa@2g$>wXE-0{3N=re-fV8B2OW!iulDTDL zrl6Urx1H)?#t1quXh>L6-~@ z-Xn>49$R*kyrM+haL=`H^vUqxsDC8l56R&KZFt?Fjb{ypg24gV6RsGI%5>aYNQ?CKK0{DN}jxpV&{2 z_*ybV?u&`icr(2cu&F%*5pTpF^wMSD$FwnMq(kz-H1C*Kj?g8anQG*sl_lh6zN9n~ zsoj|R2;Cdd(uSZBebG|*edr&c5WJ86?9)-PuJYl-nBPao0={^c!7bDs*eqTF z;|0_rPbr-*$|m}FP)GZI(NeW+TwOk0k_(cq(ELW)9BZKKVvWi1n4YW(Iv(4SET25T znV4DAG`{hl@75%H-np@fn3L8E|GY*_!mi-GZt_Y#Lkcv3X(mcdST4Gs2|4)WPH zE0|cF9%l1If>eX$mC{nPI9d2@J>;k3BD4nh0P$rG6!WVFNGHV1e<*;cptBI(Kr&=K zExD}a4aMLVfme)hRZ3ttd>X0b*N0Edn@zk!1~$Og1t_bo}x*cv#r;wpF|E39^Z|ZwDLNd}0TT zt%c_zB#SMCNFLu^3GKqhVT=rIGyh`eJ&q{P_w9myQR2;Nuo8B@44h(dZZ=a5Iqdr! z$mTOv&=R3@`GO7nE5|)`@chd0yWQ}@%JFFZnp@Ba@s!K(?haK_1G*3s4khnf2N<#2Z3h-JF`<;8w z9g8@3EaK=I9V^7I5DNJN1qGw0b$jmRrA-O^sxe6$Qs=6!Y4!7+O^H0ilbAMqTSJX! zhr7Dk?QG8Udg|(%{lk$?cSA#!tGYRJm)FH#H74`*#<=+SDSSdd7)p)olp@) zt-La?SSvC;>QCo~OeuV}IfZTHRRsp_w#4(H{0LrXa_}7UTvk3|)tPlJ zn$P7$hL6Z1#uN2gSMa~gu`@=LY@U!mpZ8if$wf`p+xc6TCfaBgI!>_Y8UA5MFmpON zW^rA4(eRVj?ags z@zn42JXl0s%{Re3bebTJX>b|w&;;fEOpOLpO^_HFBe`AUZB}yeITI|T13hVi)wG;o zHevxJq1_DWlt>!>UIA(N3K?**1rqQ`C8T16h2&{7N%BUbtBu8Ctpyfhv#@0}!dyH- zAuJa!TVU4)aUYZ~sRVf!ly3zS)2sXS2TM1h)GhS1QR2mBoXrt&-Box z^zZSfD><0e1`F`474}j2U5${8efjVS@e&){pjOCTCR$lfT)IOFpx_CcaryLGxpVOzkUjuWPps}iBJJbc~ zH?{C^khavpBSD(5bKHvha)`nsElh`F18|2rRu3BjK}bt8@KghYsY5RMbNKQK+L?xF z1CFht!=U}5)Ps!>!i0`h-)w@CAdP8;cY^e+2Wo<}>>=0~r0=vq3&Yo~G@>J3xCgu2 zU<shsklZYvrukL+Lhk zbU*>i!uLC1W2boZN0jz3`F_deBg(;P>aA(&?P==WY3kTCb$puoV5;&CN7dH5w>{`_ ztB>u0GmP$o(h1ALL@^G(qQ@hhU}Z+U*a>=;jmdlI_8V~3Ui!_s*ti$U?-uR)WVt@s ztWWmpldbw>r#@=*!d@C2JsP?opP;pi{-7Se2*A8V9iclyeI9?8U%6tS z*XlZb(&?Cf8iI;W`SzWsW9|1V5k~Uf86x@r>>;6(_CEtLGXAwG_7?(N+OJQsUz%bs h)lTLq(k__X*gMTJY5y!}SAW_E?K+mLZbkSf^k3hV$&&y8 delta 2350 zcmZWpdu)?c6z@G@>$Yx_Auu*rdFiqUtYs8h=+>?s@5-C84X84=GWNmRjkS!zaPLP) zk-;q<{6m9=M2r)NOZe0*AnH^^iHZqgAQ(d?5JZg$L1xr*zpw5Q|M`B8d+#~-+6P|*9W?#0=eDODc-4qth>udLRvJK*(tc1OZvM|c5$<*wQY z-&vD3BOFudE%)q=geQy`_v|h6RQoG^-r7ib67Ob{ScI>wne;?BvCLOhRq8EQ!bbRD zZ5n^wlGZzO;diWb!5EEZnd5rN{gcImHB!!yD(MMG<{=e0^|>@}NCn%DOO_$k7P%oA zhSXax7D%Qc_3oWUUTj?!FCra|WQCpltj!!(Uh4PwE2}*Gmi2wE&)4&%j#V+9Jsz*0 zU$8#S@8wV7XKX9^ro3^wZY8Z)x`~#q;8ShMJR@IEzSw~9-Q+LfKiSiHzx4_3${))U z?KQOC%{SRfgoo~amdqd9r!WII+A{fVYY|OJ zPFzqO$5>9Uy#@tb+np-l*IIWBzCOT=z4gJfsrXJNr1a(;VXxx4I%br;+034V#$zl+ zK5u1(T9rOk!1hJynU(Bfg6cLEvW}>m<{p}GvYZ{$sS{RKGp!bF+04l6gNe8%$mYu* z)iG}dRu@tN$1ye;R9c11w1yd!ZDZLTW|rfAW`CtHgB4HI{acKgzN}n8vNPVOaM6#sw!cQ3< zHsKq&FpJLjN-jK0K?x=zIw2ihd60!iZIFt8FNNv&wvahO_7uZ3Ot6u>nx~E?qBqFK zVTFw%8PpKj)i4G7X%aKx0~_pKE4p6#lCmouFI^W*^r$o-nCNur55Yu}Ng5-4M2AaB zf{E^y(uoDaWBl}1BUA|*f-oCz*x?}F41ylp^5GM~QgE{a?ouUlgRntVvX*#LHDq8+ z0qhsN03H(TT`WNMEdeXTAAGP;lv#w0)u5Mamw}cEnj#-u4jz@_2^Y-f#*Sp!x)L@< zhsiq=0MX-jU zznr#4N4^QCdT49YN+6C2nu4^oWDK`Lx?H*$mPgI4+sWKoMltO3*+lv77BH(L@?1A; zA35pSHkdA7dyZ~h4M%%QMluueL>r{Z728ISh?w%tQrH#^x4H~685S3-2N&&tfpS=g z)7*4!Mh{G8f{v5j+o3W_zpsEpQCe3CFGXqU&i`CA7D5vC)G;0Y)&Vo*-*&-zbrRCj zZ2Y3MR>*-C<12+!5R7eZe4!ybXoJ#>qNr|Rh3sUvA= z4}oY4c`yj^!n2iup6A9S$;SOKoy`*c>H?)%T}b+6wgHft)lsZ33eK=AD!bugod@nrj_sK^O zz%@qiS!#eqabh#>h-Ai|2C%bvc)tOR%z_z>%0pezNLOgW>P9GhT9g}7wi{B44JoyT zlu|=Vr6DTxUL!Sy8O=?QPq4R%&fbidRnRv>At`?|Jq|NoYKFxG$t}u)EiK?8^=1of zAQ)^>)~#*@J?*Kgm4eN~)2*S#vtp)uZu#Vu<4oYOf^iE}LXD1~xU{@zt2tMwFTxNJVMDN~!xgp3S*cSo^ zL0Y}$}#$8>IL0P*5Snw3VROQcfJWHe55xXNczGO2hVW19zq)hJo&W#< diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree index a8fb27090d65d9ebb8743b745ad23a2e61e1a5d6..9005c130c84c9a6453a283ff765820fb4d504250 100644 GIT binary patch delta 2480 zcmY*aZBUfg72bP9c7bJe0RzZq$Y`)Cf@3sl6oFlcS+ueupkXl@Kz##?$cLhF(2T*5 zSp)H|9J4`D0qt}qt(~3rty7b98mFx$q3Iu6jhSRJlXS*ZXJHqXr0v*q@4marpFPiW z&pG#e>^b-SbRzcCiP)l+Ta zdG^6n-ddQN!a>)c4xkbSI-E+Utfot>4LmxrwuNax-c)4&zZBPm8yMfbSY z^P=Ka#s+6cbKd?gw<~NOupMlwp6yWRtOM?)+ahA>A%zxdT&+pGN;+P5as_|cJ(9EAjvwCfs<(nk>DH;GI zijRTObcsG$0N*9CDN(BW&o#hIY)ZZRBBUDFI0m-BQs%>=3P?20Q_RbCI-9PeO_>%a znYf_>lA@F4F{W2Qs?q$|WGdv8^7temPBQRr1(?_*_SxYnd{hA|DT>79b|^-r5|Z&~ zEj*2XwnHv%+Ddef6S8r^R-zB>L_au8+BXG#N6=M0kdEIFWmBPhvMRxb264~z(~yRP zm9V;2?2wX8*~|S=mI@?hTv;QK*c+uxAh9z_r9fgPm0bdfsZyK*i9Jz{5bAJ6wbMqs zkGgY}Ni5g~zomjca#C?oRd9pw%_{hj>LSh022R34+-N6VevK?v+MTF@BW!$NJ4}&T zPzv?o4p_@@?`fzM9jL~54w>piEyObc&Fb7bcuj+@o!|~ZB)CL%?24%F?1uL=RdY9( z`1PB4>c{m^u6d?6!Z8hgum?_RmhqinI%j-;jz7bx7;Pe8{B$ivT%F@yT(C^$lgs#_#gB(!wz{zw1~tpz+oE3S)b4^E8vN!I9Auck z4HnBONw1_)8S8_U_}8j%w48pJ!vs%IOWqaLSNBm$G}#px)lc)Wm?nb>XjV75p-F?c z&OiZME~efFa^!7H&buv64!g}DC*7u(V{VIKtA*1m;Y3P0Um-EtZ{t#qR_N#|r1Bt^!P)6cUL-a6A}R zB>INo1rnbP(+d+s!w9S+Q943962!MgU2hzh#FO|SqPFWFt1pM}BxYO*drv%}e#W4AZz46DR2#0q_vZfteJW%M delta 2475 zcmY*adr*|u72kV6c7+Aq1q9?Fn($LS{dCKJ=lbey)vhV-wr+RmhpsclVlHw$G+)7GAQcUk41J-^?1 z+;h+Q&bfOh5PK&Odt=bRODZfZpZ^K+y*Wnbvqr;_rp^Pcjg77QJJz+^ZMLR%o?Vd4 zmmW*iy5=3UH8vgRZ3Sukaaa0ESF*jMslCO1u(7FQU7P*j{zDy|4egz7mwtciks}SZ zMtOpp-{?vM*CJeaf-Uko3%+8l)6p7DdC}dve~#__x=jg0Sly59N-)CgKm3(48DU*L zL&{8q^|=3__#*7B@02K05%$x+pHch~_D;Kle_2$n73cQ3S8--41y>FCn=1Lo#Vx$B zIE(F;%u^D_7nLpGM~WBn*UK~bc!_0xzr275dt@r-@0g6dpg1e8UtWZ?E~|`utt?SS zer{UG$4lEN@&!Inn#g^oI?^xU7s?hhAHQu{!DjQul3yAhDIXH~qq1^xu+0P+JgLm^ zRC;Sv3K_n9$dVJ>{jxrha@IM@?b=S+H}QoPx~P7|&!4aOGn?i&y4QJkyl^;?JN9kk z?_0NfpQ}$~vxGlazs&pBeV-+>fOP!Au463VojQs_xQ?d?G1e6q!-C!$-N#b!KRPgY zH{<_)fSbEmuG*Z(?&|UUATy{tx3e5=2=}EOv|5?5A3F}}SEQt-3|mf|m}VHLh8Xp0T9arrKykE)5jeS)k#M42xXxXA$-_(x$^ zYRJB%2F&<9;dyfa(s8&3wphd(DcN*;xkAcXfy9_ATLluUqm&CI)<&rjNUV&~AdpxW z#U_wg73Cx$yDPerw%&c(y-JzJyxs6FM)y-cqW8cpfed(e5B!4)Bhxnq&%+9=sD@0; z-7Bm8nT_zdy>OBR2J2v&+=5c5k6wa&hJWdS8qtDUoam*KCTtL|1}qTI1UKT>t;DnH z!5ZRf?>^vR6TvmAwE+%=P4`}bp|Hu;4e|Wu?Hu)^MyL#%Gn=7141dxBj<9FKQHa0r zEX%^nF-)r-KL{^}4e!4u4VmhKL!g9plyT+Y2pH8{hv8cc>rT+s>2vKtOE(x)x_UYj z(5TX_?IDP#Iw4i{w85^h>2bTbu=FC+nJ}bloC^mKOvSZzY_a;;F>!h6x}gh}GfcEm zLK=u#e6?-1SIbU95)*t0>VMCcsz*;jk>p0So`W3x8$9b z)KawrVMtL9M#C2Qm>V3ho4ELn>U9Uikx})YhX&!a%}sOguotxG53*SNXcXqD6;2oy zKKH*1r-a<^qKZj=+6!+mJTO2t(9k}E6Me7|<2huh%lcsf6VRX*e;-ybTx}sIn&&Fa zZXjhAIWYl^>JGPPpM-ZVKrUM^X59>O(9KLvxj9abxLGIX+pLwtZH|$XO`d*Si%?8s z_$oq8xA>3gS60uL{{ixpex-5_Yn;QH=dc5Fm@O>wkM-MUq%gEA8RUTw2bL>8FVb+VCdS zt`UuJ$_kva4Nlnwr)+{#_P{Ay;G}@}-h@i|$EU=`V!;Tc@%o;{I_2zEjb;_4Hw{BI zJ%bn$4~FUc2eI%X)R4Gv5lkfRU8LCz;>t^4Ced+;<~xYLyd>imkI?6u#4RIGNaDl@ zl#}@R2)zcA_*IA%U8cB6>Select version... + @@ -135,7 +136,7 @@

run

Override the default network and provider. (see ape networks list for options)

Options:
-

:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::test | :local:test | ethereum::test | ethereum:local:test | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | :local | ethereum:local | ethereum

+

:mainnet:geth | ethereum:mainnet:geth | :mainnet | ethereum:mainnet | :goerli:geth | ethereum:goerli:geth | :goerli | ethereum:goerli | :sepolia:geth | ethereum:sepolia:geth | :sepolia | ethereum:sepolia | ::geth | :local:geth | ethereum::geth | ethereum:local:geth | ::test | :local:test | ethereum::test | ethereum:local:test | :local | ethereum:local | ethereum

diff --git a/latest/genindex.html b/latest/genindex.html index 2d40f06d..5ccb79eb 100644 --- a/latest/genindex.html +++ b/latest/genindex.html @@ -47,6 +47,7 @@ + diff --git a/latest/index.html b/latest/index.html index e37bdc2e..cb119434 100644 --- a/latest/index.html +++ b/latest/index.html @@ -49,6 +49,7 @@ + diff --git a/latest/methoddocs/application.html b/latest/methoddocs/application.html index 59dc7ae4..8eda5b82 100644 --- a/latest/methoddocs/application.html +++ b/latest/methoddocs/application.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/exceptions.html b/latest/methoddocs/exceptions.html index 96236e5f..3caa0116 100644 --- a/latest/methoddocs/exceptions.html +++ b/latest/methoddocs/exceptions.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/middlewares.html b/latest/methoddocs/middlewares.html index de51e2bc..d283d876 100644 --- a/latest/methoddocs/middlewares.html +++ b/latest/methoddocs/middlewares.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/runner.html b/latest/methoddocs/runner.html index 505feb14..b5141e1c 100644 --- a/latest/methoddocs/runner.html +++ b/latest/methoddocs/runner.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/subscriptions.html b/latest/methoddocs/subscriptions.html index 0dcaaeaf..4ba3c598 100644 --- a/latest/methoddocs/subscriptions.html +++ b/latest/methoddocs/subscriptions.html @@ -50,6 +50,7 @@ + diff --git a/latest/methoddocs/utils.html b/latest/methoddocs/utils.html index 4fe73caa..31ef206d 100644 --- a/latest/methoddocs/utils.html +++ b/latest/methoddocs/utils.html @@ -49,6 +49,7 @@ + diff --git a/latest/py-modindex.html b/latest/py-modindex.html index 67413fcf..e675d648 100644 --- a/latest/py-modindex.html +++ b/latest/py-modindex.html @@ -50,6 +50,7 @@ + diff --git a/latest/search.html b/latest/search.html index cd1b14e6..c2abd406 100644 --- a/latest/search.html +++ b/latest/search.html @@ -50,6 +50,7 @@ + diff --git a/latest/searchindex.js b/latest/searchindex.js index 0c0459a6..af0e1dc6 100644 --- a/latest/searchindex.js +++ b/latest/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["commands/run", "index", "methoddocs/application", "methoddocs/exceptions", "methoddocs/middlewares", "methoddocs/runner", "methoddocs/subscriptions", "methoddocs/utils", "userguides/development", "userguides/quickstart"], "filenames": ["commands/run.rst", "index.md", "methoddocs/application.md", "methoddocs/exceptions.md", "methoddocs/middlewares.md", "methoddocs/runner.md", "methoddocs/subscriptions.md", "methoddocs/utils.md", "userguides/development.md", "userguides/quickstart.md"], "titles": ["run", "Silverback Docs", "silverback.application", "silverback.exceptions", "silverback.middlewares", "silverback.runner", "silverback.subscriptions", "silverback.utils", "Developing a Silverback Application", "Quick Start"], "terms": {"silverback": [0, 9], "applic": [0, 1, 3, 5, 9], "client": [0, 4, 5, 8], "option": [0, 2, 8], "path": 0, "v": 0, "verbos": 0, "lvl": 0, "One": 0, "error": [0, 2, 8], "warn": 0, "success": 0, "info": 0, "debug": 0, "network": [0, 5, 8, 9], "overrid": [0, 2], "default": [0, 2, 8], "provid": [0, 5], "see": [0, 9], "ap": [0, 8, 9], "list": 0, "mainnet": [0, 8, 9], "geth": 0, "ethereum": [0, 8], "goerli": 0, "sepolia": [0, 8], "test": 0, "local": [0, 8], "account": [0, 8], "runner": [0, 1, 8, 9], "an": [0, 2, 3, 6, 7, 9], "import": [0, 2, 8], "str": [0, 2, 3], "format": 0, "modul": [0, 2, 4, 5, 6], "customrunn": 0, "x": 0, "max": 0, "except": [0, 1, 4], "max_except": [0, 5], "argument": 0, "requir": [0, 8], "quick": 1, "start": [1, 2, 8], "develop": 1, "run": [1, 5, 9], "middlewar": 1, "subscript": 1, "util": 1, "The": [2, 4, 5, 6, 8, 9], "contain": [2, 3, 4, 5, 6], "high": [2, 8], "level": 2, "implement": [2, 5, 6], "user": [2, 3], "": [2, 4, 8, 9], "meant": 2, "us": [2, 5, 6, 8, 9], "expos": 2, "method": [2, 5, 6, 8], "handler": [2, 8], "other": [2, 8], "function": [2, 4, 8], "class": [2, 4, 5, 6, 8], "silverbackapp": [2, 5, 8], "set": [2, 8], "none": [2, 8], "base": [2, 3, 4, 5, 6], "manageraccessmixin": [2, 4, 5], "singleton": 2, "must": [2, 8], "initi": [2, 8], "prior": 2, "usag": 2, "exampl": [2, 8, 9], "from": [2, 8], "app": [2, 5, 8, 9], "connect": [2, 5, 6, 8], "ha": [2, 8], "been": [2, 8], "can": [2, 8, 9], "call": [2, 4], "broker": [2, 4, 5, 8], "e": 2, "g": 2, "on_": [2, 8], "get_block_handl": 2, "asynctaskiqdecoratedtask": 2, "get": [2, 8], "access": [2, 8], "block": [2, 7, 9], "event": [2, 5, 9], "return": [2, 4, 8], "decor": [2, 8], "task": [2, 4, 5, 8], "one": [2, 7, 8], "creat": [2, 3, 9], "type": [2, 8, 9], "get_event_handl": 2, "event_target": 2, "checksumaddress": 2, "event_nam": 2, "paramet": [2, 4, 8], "addresstyp": 2, "contract": [2, 8, 9], "address": [2, 8], "target": 2, "name": [2, 8], "emit": [2, 8], "get_shutdown_handl": 2, "silverback_shutdown": 2, "get_startup_handl": 2, "silverback_startup": 2, "blockcontain": 2, "contractev": 2, "new_block_timeout": 2, "int": [2, 5], "start_block": [2, 8], "handl": [2, 8], "union": 2, "sourc": 2, "watch": 2, "timeout": 2, "i": [2, 4, 8, 9], "accept": 2, "whatev": 2, "ar": [2, 5, 8, 9], "poll": 2, "number": 2, "process": [2, 4, 5, 8], "latest": [2, 9], "rais": [2, 5, 8], "invalidcontainertypeerror": [2, 3], "If": [2, 5, 8], "configur": [2, 5, 8], "on_shutdown": [2, 8], "callabl": 2, "code": 2, "execut": [2, 4, 5], "worker": [2, 4], "shutdown": [2, 3], "def": [2, 8], "do_something_on_shutdown": 2, "record": [2, 8], "final": [2, 8, 9], "state": [2, 9], "on_startup": [2, 8], "upon": [2, 8], "startup": 2, "restart": 2, "after": [2, 4], "do_something_on_startup": 2, "startup_st": [2, 8], "reprocess": 2, "miss": [2, 8], "on_worker_shutdown": [2, 8], "everi": [2, 8], "updat": [2, 8, 9], "some": [2, 8, 9], "extern": 2, "servic": 2, "perhap": 2, "inform": 2, "on_worker_startup": [2, 8], "provis": [2, 8], "resourc": [2, 8], "add": [2, 4, 8], "thing": [2, 8, 9], "circuitbreak": 3, "messag": [3, 4, 8], "silverbackexcept": 3, "custom": 3, "trigger": [3, 5, 8], "duplicatehandlererror": 3, "handler_typ": 3, "halt": [3, 5], "importfromstringerror": 3, "ani": [3, 7, 8], "nowebsocketavailableerror": 3, "apeexcept": 3, "runtim": 3, "fault": 3, "intend": 4, "improv": 4, "usabl": 4, "whole": 4, "integr": 4, "platform": 4, "well": [4, 8, 9], "silverbackmiddlewar": 4, "arg": [4, 5], "kwarg": [4, 5], "taskiqmiddlewar": 4, "async": [4, 5], "on_error": 4, "taskiqmessag": 4, "result": [4, 8], "taskiqresult": 4, "baseexcept": 4, "thi": [4, 8, 9], "when": 4, "found": 4, "incom": 4, "valu": [4, 6, 7], "post_execut": 4, "hook": [4, 8], "complet": [4, 8], "side": 4, "It": [4, 8], "current": 4, "post_sav": 4, "post": 4, "save": 4, "result_backend": 4, "pre_execut": 4, "befor": [4, 8], "which": [4, 8], "mean": 4, "pars": 4, "taskiq": [4, 8], "modifi": 4, "pre_send": 4, "send": 4, "right": 4, "sent": 4, "varieti": 5, "differ": 5, "scenario": 5, "baserunn": 5, "3": [5, 9], "abc": 5, "assembl": 5, "Will": 5, "listen": [5, 9], "against": [5, 9], "context": [5, 8], "them": 5, "kick": 5, "over": 5, "pollingrunn": 5, "singl": 5, "live": [5, 9], "basic": 5, "memori": [5, 8], "queue": [5, 6, 8], "websocketrunn": [5, 8], "websocket": [5, 6], "rpc": 6, "node": 6, "via": [6, 8], "eth_subscrib": 6, "subscriptiontyp": 6, "enum": 6, "enumer": 6, "async_wrap_it": 7, "iter": 7, "asynciter": 7, "wrap": 7, "asynchron": [7, 8], "hexbytes_dict": 7, "data": [7, 8, 9], "dict": 7, "convert": 7, "hex": 7, "string": 7, "flat": 7, "dictionari": 7, "hexbyt": 7, "In": 8, "guid": 8, "we": 8, "go": 8, "show": 8, "you": [8, 9], "more": [8, 9], "detail": 8, "how": [8, 9], "build": 8, "should": [8, 9], "have": 8, "python": [8, 9], "project": [8, 9], "instal": 8, "pip": 8, "easi": 8, "do": 8, "so": [8, 9], "through": 8, "up": [8, 9], "each": 8, "time": 8, "encount": 8, "specif": 8, "make": 8, "bot": [8, 9], "order": 8, "perform": 8, "autom": [8, 9], "necessari": 8, "chain": [8, 9], "interact": 8, "howev": 8, "won": 8, "t": 8, "veri": 8, "where": 8, "ad": 8, "let": [8, 9], "u": 8, "specifi": 8, "our": 8, "To": [8, 9], "follow": 8, "handle_new_block": 8, "insid": 8, "defin": 8, "logic": 8, "want": 8, "detect": 8, "serializ": 8, "structur": 8, "store": 8, "databas": 8, "trackabl": 8, "metric": 8, "dure": 8, "captur": 8, "failur": 8, "similarli": 8, "token": 8, "here": 8, "transfer": 8, "handle_token_transfer_ev": 8, "again": 8, "heavier": 8, "load": 8, "like": 8, "handle_on_worker_startup": 8, "db": 8, "etc": 8, "handle_on_worker_shutdown": 8, "cleanup": 8, "close": 8, "cleanli": 8, "come": 8, "comput": 8, "note": 8, "ensur": 8, "multipl": 8, "properli": 8, "telegram": [8, 9], "api": 8, "sql": 8, "nosql": 8, "someth": 8, "els": 8, "0": 8, "2": 8, "These": 8, "move": 8, "clariti": 8, "variabl": 8, "also": 8, "made": 8, "avail": 8, "quantiti": 8, "maintain": 8, "its": 8, "own": [8, 9], "instanc": 8, "annot": 8, "depend": 8, "taskiqdepend": 8, "block_handl": 8, "onc": 8, "mai": [8, 9], "histor": 8, "sinc": 8, "wa": 8, "action": 8, "handle_on_startup": 8, "process_histori": 8, "last_block_seen": 8, "last_block_process": 8, "handle_on_shutdown": 8, "chang": [8, 9], "behavior": 8, "signatur": 8, "now": 8, "onli": 8, "program": 8, "realli": 8, "abl": 8, "valid": 8, "doe": 8, "what": 8, "expect": 8, "includ": [8, 9], "cli": 8, "command": 8, "take": 8, "care": 8, "proper": 8, "signer": 8, "testnet": 8, "my_bot": 8, "acct": 8, "enabl": [8, 9], "mode": 8, "might": [8, 9], "lead": 8, "transact": 8, "sender": 8, "would": 8, "done": 8, "had": 8, "sign": 8, "anyth": 8, "given": 8, "rememb": 8, "lose": 8, "substat": 8, "amount": 8, "fund": 8, "product": 8, "alwai": 8, "throughli": 8, "defualt": 8, "everyth": 8, "job": 8, "share": 8, "volum": [8, 9], "environ": 8, "higher": 8, "rate": 8, "primari": 8, "compon": 8, "manner": 8, "For": 8, "work": 8, "capabl": 8, "taskiq_redi": 8, "could": 8, "export": 8, "silverback_broker_class": 8, "listqueuebrok": 8, "silverback_broker_uri": 8, "redi": 8, "127": 8, "1": 8, "6379": 8, "alchemi": [8, 9], "And": 8, "subprocess": 8, "w": 8, "all": 8, "todo": 8, "backtest": 8, "packag": [8, 9], "deploy": 8, "deploi": 9, "your": 9, "respond": 9, "librari": 9, "leverag": 9, "framework": 9, "ecosystem": 9, "plugin": 9, "simpl": 9, "yet": 9, "sophist": 9, "excel": 9, "case": 9, "involv": 9, "continu": 9, "monitor": 9, "newli": 9, "confirm": 9, "log": 9, "new": 9, "pool": 9, "creation": 9, "deposit": 9, "liquid": 9, "measur": 9, "trade": 9, "activ": 9, "popular": 9, "larg": 9, "swap": 9, "group": 9, "read": 9, "userguid": 9, "learn": 9, "python3": 9, "version": 9, "8": 9, "greater": 9, "dev": 9, "reli": 9, "heavili": 9, "worth": 9, "familar": 9, "yourself": 9, "releas": 9, "clone": 9, "repositori": 9, "most": 9, "date": 9, "git": 9, "http": 9, "github": 9, "com": 9, "apeworx": 9, "cd": 9, "setup": 9, "py": 9, "checkout": 9, "sdk": 9, "pwd": 9, "home": 9, "haramb": 9, "tokenlist": 9, "consid": 9, "beta": 9, "break": 9, "occur": 9, "comment": 9, "question": 9, "critic": 9, "pull": 9, "request": 9, "welcom": 9}, "objects": {"silverback": [[2, 0, 0, "-", "application"], [3, 0, 0, "-", "exceptions"], [4, 0, 0, "-", "middlewares"], [5, 0, 0, "-", "runner"], [6, 0, 0, "-", "subscriptions"], [7, 0, 0, "-", "utils"]], "silverback.application": [[2, 1, 1, "", "SilverbackApp"]], "silverback.application.SilverbackApp": [[2, 2, 1, "", "get_block_handler"], [2, 2, 1, "", "get_event_handler"], [2, 2, 1, "", "get_shutdown_handler"], [2, 2, 1, "", "get_startup_handler"], [2, 2, 1, "", "on_"], [2, 2, 1, "", "on_shutdown"], [2, 2, 1, "", "on_startup"], [2, 2, 1, "", "on_worker_shutdown"], [2, 2, 1, "", "on_worker_startup"]], "silverback.exceptions": [[3, 3, 1, "", "CircuitBreaker"], [3, 3, 1, "", "DuplicateHandlerError"], [3, 3, 1, "", "Halt"], [3, 3, 1, "", "ImportFromStringError"], [3, 3, 1, "", "InvalidContainerTypeError"], [3, 3, 1, "", "NoWebsocketAvailableError"], [3, 3, 1, "", "SilverbackException"]], "silverback.middlewares": [[4, 1, 1, "", "SilverbackMiddleware"]], "silverback.middlewares.SilverbackMiddleware": [[4, 2, 1, "", "on_error"], [4, 2, 1, "", "post_execute"], [4, 2, 1, "", "post_save"], [4, 2, 1, "", "pre_execute"], [4, 2, 1, "", "pre_send"]], "silverback.runner": [[5, 1, 1, "", "BaseRunner"], [5, 1, 1, "", "PollingRunner"], [5, 1, 1, "", "WebsocketRunner"]], "silverback.runner.BaseRunner": [[5, 2, 1, "", "run"]], "silverback.runner.WebsocketRunner": [[5, 2, 1, "", "run"]], "silverback.subscriptions": [[6, 1, 1, "", "SubscriptionType"]], "silverback.utils": [[7, 4, 1, "", "async_wrap_iter"], [7, 4, 1, "", "hexbytes_dict"]], "run": [[0, 5, 1, "cmdoption-run-account", "--account"], [0, 5, 1, "cmdoption-run-x", "--max-exceptions"], [0, 5, 1, "cmdoption-run-network", "--network"], [0, 5, 1, "cmdoption-run-runner", "--runner"], [0, 5, 1, "cmdoption-run-v", "--verbosity"], [0, 5, 1, "cmdoption-run-v", "-v"], [0, 5, 1, "cmdoption-run-x", "-x"], [0, 5, 1, "cmdoption-run-arg-PATH", "PATH"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["std", "cmdoption", "program option"]}, "titleterms": {"run": [0, 8], "silverback": [1, 2, 3, 4, 5, 6, 7, 8], "doc": 1, "user": 1, "guid": 1, "cli": 1, "refer": 1, "python": 1, "applic": [2, 8], "except": 3, "middlewar": 4, "runner": 5, "subscript": 6, "util": 7, "develop": [8, 9], "prerequisit": 8, "creat": 8, "an": 8, "new": 8, "block": 8, "event": 8, "log": 8, "startup": 8, "shutdown": 8, "worker": 8, "state": 8, "your": 8, "distribut": 8, "execut": 8, "test": 8, "deploi": 8, "platform": 8, "quick": 9, "start": 9, "document": 9, "depend": 9, "instal": 9, "via": 9, "pip": 9, "setuptool": 9, "usag": 9, "docker": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "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": 57}, "alltitles": {"run": [[0, "run"], [0, "run"]], "Silverback Docs": [[1, "silverback-docs"]], "User Guides": [[1, null]], "CLI Reference": [[1, null]], "Python Reference": [[1, null]], "silverback.application": [[2, "silverback-application"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverback.middlewares": [[4, "silverback-middlewares"]], "silverback.runner": [[5, "silverback-runner"]], "silverback.subscriptions": [[6, "silverback-subscriptions"]], "silverback.utils": [[7, "module-silverback.utils"]], "Developing a Silverback Application": [[8, "developing-a-silverback-application"]], "Prerequisites": [[8, "prerequisites"]], "Creating an Application": [[8, "creating-an-application"]], "New Block Events": [[8, "new-block-events"]], "New Event Logs": [[8, "new-event-logs"]], "Startup and Shutdown": [[8, "startup-and-shutdown"]], "Worker Events": [[8, "worker-events"]], "Worker State": [[8, "worker-state"]], "Application Events": [[8, "application-events"]], "Running your Application": [[8, "running-your-application"]], "Distributed Execution": [[8, "distributed-execution"]], "Testing your Application": [[8, "testing-your-application"]], "Deploying to the Silverback Platform": [[8, "deploying-to-the-silverback-platform"]], "Quick Start": [[9, "quick-start"]], "Documentation": [[9, "documentation"]], "Dependencies": [[9, "dependencies"]], "Installation": [[9, "installation"]], "via pip": [[9, "via-pip"]], "via setuptools": [[9, "via-setuptools"]], "Quick Usage": [[9, "quick-usage"]], "Docker Usage": [[9, "docker-usage"]], "Development": [[9, "development"]]}, "indexentries": {"--account": [[0, "cmdoption-run-account"]], "--max-exceptions": [[0, "cmdoption-run-x"]], "--network": [[0, "cmdoption-run-network"]], "--runner": [[0, "cmdoption-run-runner"]], "--verbosity": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-v": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-x": [[0, "cmdoption-run-x"]], "path": [[0, "cmdoption-run-arg-PATH"]], "run command line option": [[0, "cmdoption-run-0"], [0, "cmdoption-run-account"], [0, "cmdoption-run-arg-PATH"], [0, "cmdoption-run-network"], [0, "cmdoption-run-runner"], [0, "cmdoption-run-v"], [0, "cmdoption-run-x"]], "silverbackapp (class in silverback.application)": [[2, "silverback.application.SilverbackApp"]], "get_block_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_block_handler"]], "get_event_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_event_handler"]], "get_shutdown_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_shutdown_handler"]], "get_startup_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_startup_handler"]], "module": [[2, "module-silverback.application"], [3, "module-silverback.exceptions"], [4, "module-silverback.middlewares"], [5, "module-silverback.runner"], [6, "module-silverback.subscriptions"], [7, "module-silverback.utils"]], "on_() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_"]], "on_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_shutdown"]], "on_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_startup"]], "on_worker_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_shutdown"]], "on_worker_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_startup"]], "silverback.application": [[2, "module-silverback.application"]], "circuitbreaker": [[3, "silverback.exceptions.CircuitBreaker"]], "duplicatehandlererror": [[3, "silverback.exceptions.DuplicateHandlerError"]], "halt": [[3, "silverback.exceptions.Halt"]], "importfromstringerror": [[3, "silverback.exceptions.ImportFromStringError"]], "invalidcontainertypeerror": [[3, "silverback.exceptions.InvalidContainerTypeError"]], "nowebsocketavailableerror": [[3, "silverback.exceptions.NoWebsocketAvailableError"]], "silverbackexception": [[3, "silverback.exceptions.SilverbackException"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverbackmiddleware (class in silverback.middlewares)": [[4, "silverback.middlewares.SilverbackMiddleware"]], "on_error() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.on_error"]], "post_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_execute"]], "post_save() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_save"]], "pre_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_execute"]], "pre_send() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_send"]], "silverback.middlewares": [[4, "module-silverback.middlewares"]], "baserunner (class in silverback.runner)": [[5, "silverback.runner.BaseRunner"]], "pollingrunner (class in silverback.runner)": [[5, "silverback.runner.PollingRunner"]], "websocketrunner (class in silverback.runner)": [[5, "silverback.runner.WebsocketRunner"]], "run() (silverback.runner.baserunner method)": [[5, "silverback.runner.BaseRunner.run"]], "run() (silverback.runner.websocketrunner method)": [[5, "silverback.runner.WebsocketRunner.run"]], "silverback.runner": [[5, "module-silverback.runner"]], "subscriptiontype (class in silverback.subscriptions)": [[6, "silverback.subscriptions.SubscriptionType"]], "silverback.subscriptions": [[6, "module-silverback.subscriptions"]], "async_wrap_iter() (in module silverback.utils)": [[7, "silverback.utils.async_wrap_iter"]], "hexbytes_dict() (in module silverback.utils)": [[7, "silverback.utils.hexbytes_dict"]], "silverback.utils": [[7, "module-silverback.utils"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["commands/run", "index", "methoddocs/application", "methoddocs/exceptions", "methoddocs/middlewares", "methoddocs/runner", "methoddocs/subscriptions", "methoddocs/utils", "userguides/development", "userguides/quickstart"], "filenames": ["commands/run.rst", "index.md", "methoddocs/application.md", "methoddocs/exceptions.md", "methoddocs/middlewares.md", "methoddocs/runner.md", "methoddocs/subscriptions.md", "methoddocs/utils.md", "userguides/development.md", "userguides/quickstart.md"], "titles": ["run", "Silverback Docs", "silverback.application", "silverback.exceptions", "silverback.middlewares", "silverback.runner", "silverback.subscriptions", "silverback.utils", "Developing a Silverback Application", "Quick Start"], "terms": {"silverback": [0, 9], "applic": [0, 1, 3, 5, 9], "client": [0, 4, 5, 8], "option": [0, 2, 8], "path": 0, "v": 0, "verbos": 0, "lvl": 0, "One": 0, "error": [0, 2, 8], "warn": 0, "success": 0, "info": 0, "debug": 0, "network": [0, 5, 8, 9], "overrid": [0, 2], "default": [0, 2, 8], "provid": [0, 5], "see": [0, 9], "ap": [0, 8, 9], "list": 0, "mainnet": [0, 8, 9], "geth": 0, "ethereum": [0, 8], "goerli": 0, "sepolia": [0, 8], "local": [0, 8], "test": 0, "account": [0, 8], "runner": [0, 1, 8, 9], "an": [0, 2, 3, 6, 7, 9], "import": [0, 2, 8], "str": [0, 2, 3], "format": 0, "modul": [0, 2, 4, 5, 6], "customrunn": 0, "x": 0, "max": 0, "except": [0, 1, 4], "max_except": [0, 5], "argument": 0, "requir": [0, 8], "quick": 1, "start": [1, 2, 8], "develop": 1, "run": [1, 5, 9], "middlewar": 1, "subscript": 1, "util": 1, "The": [2, 4, 5, 6, 8, 9], "contain": [2, 3, 4, 5, 6], "high": [2, 8], "level": 2, "implement": [2, 5, 6], "user": [2, 3], "": [2, 4, 8, 9], "meant": 2, "us": [2, 5, 6, 8, 9], "expos": 2, "method": [2, 5, 6, 8], "handler": [2, 8], "other": [2, 8], "function": [2, 4, 8], "class": [2, 4, 5, 6, 8], "silverbackapp": [2, 5, 8], "set": [2, 8], "none": [2, 8], "base": [2, 3, 4, 5, 6], "manageraccessmixin": [2, 4, 5], "singleton": 2, "must": [2, 8], "initi": [2, 8], "prior": 2, "usag": 2, "exampl": [2, 8, 9], "from": [2, 8], "app": [2, 5, 8, 9], "connect": [2, 5, 6, 8], "ha": [2, 8], "been": [2, 8], "can": [2, 8, 9], "call": [2, 4], "broker": [2, 4, 5, 8], "e": 2, "g": 2, "on_": [2, 8], "get_block_handl": 2, "asynctaskiqdecoratedtask": 2, "get": [2, 8], "access": [2, 8], "block": [2, 7, 9], "event": [2, 5, 9], "return": [2, 4, 8], "decor": [2, 8], "task": [2, 4, 5, 8], "one": [2, 7, 8], "creat": [2, 3, 9], "type": [2, 8, 9], "get_event_handl": 2, "event_target": 2, "checksumaddress": 2, "event_nam": 2, "paramet": [2, 4, 8], "addresstyp": 2, "contract": [2, 8, 9], "address": [2, 8], "target": 2, "name": [2, 8], "emit": [2, 8], "get_shutdown_handl": 2, "silverback_shutdown": 2, "get_startup_handl": 2, "silverback_startup": 2, "blockcontain": 2, "contractev": 2, "new_block_timeout": 2, "int": [2, 5], "start_block": [2, 8], "handl": [2, 8], "union": 2, "sourc": 2, "watch": 2, "timeout": 2, "i": [2, 4, 8, 9], "accept": 2, "whatev": 2, "ar": [2, 5, 8, 9], "poll": 2, "number": 2, "process": [2, 4, 5, 8], "latest": [2, 9], "rais": [2, 5, 8], "invalidcontainertypeerror": [2, 3], "If": [2, 5, 8], "configur": [2, 5, 8], "on_shutdown": [2, 8], "callabl": 2, "code": 2, "execut": [2, 4, 5], "worker": [2, 4], "shutdown": [2, 3], "def": [2, 8], "do_something_on_shutdown": 2, "record": [2, 8], "final": [2, 8, 9], "state": [2, 9], "on_startup": [2, 8], "upon": [2, 8], "startup": 2, "restart": 2, "after": [2, 4], "do_something_on_startup": 2, "startup_st": [2, 8], "reprocess": 2, "miss": [2, 8], "on_worker_shutdown": [2, 8], "everi": [2, 8], "updat": [2, 8, 9], "some": [2, 8, 9], "extern": 2, "servic": 2, "perhap": 2, "inform": 2, "on_worker_startup": [2, 8], "provis": [2, 8], "resourc": [2, 8], "add": [2, 4, 8], "thing": [2, 8, 9], "circuitbreak": 3, "messag": [3, 4, 8], "silverbackexcept": 3, "custom": 3, "trigger": [3, 5, 8], "duplicatehandlererror": 3, "handler_typ": 3, "halt": [3, 5], "importfromstringerror": 3, "ani": [3, 7, 8], "nowebsocketavailableerror": 3, "apeexcept": 3, "runtim": 3, "fault": 3, "intend": 4, "improv": 4, "usabl": 4, "whole": 4, "integr": 4, "platform": 4, "well": [4, 8, 9], "silverbackmiddlewar": 4, "arg": [4, 5], "kwarg": [4, 5], "taskiqmiddlewar": 4, "async": [4, 5], "on_error": 4, "taskiqmessag": 4, "result": [4, 8], "taskiqresult": 4, "baseexcept": 4, "thi": [4, 8, 9], "when": 4, "found": 4, "incom": 4, "valu": [4, 6, 7], "post_execut": 4, "hook": [4, 8], "complet": [4, 8], "side": 4, "It": [4, 8], "current": 4, "post_sav": 4, "post": 4, "save": 4, "result_backend": 4, "pre_execut": 4, "befor": [4, 8], "which": [4, 8], "mean": 4, "pars": 4, "taskiq": [4, 8], "modifi": 4, "pre_send": 4, "send": 4, "right": 4, "sent": 4, "varieti": 5, "differ": 5, "scenario": 5, "baserunn": 5, "3": [5, 9], "abc": 5, "assembl": 5, "Will": 5, "listen": [5, 9], "against": [5, 9], "context": [5, 8], "them": 5, "kick": 5, "over": 5, "pollingrunn": 5, "singl": 5, "live": [5, 9], "basic": 5, "memori": [5, 8], "queue": [5, 6, 8], "websocketrunn": [5, 8], "websocket": [5, 6], "rpc": 6, "node": 6, "via": [6, 8], "eth_subscrib": 6, "subscriptiontyp": 6, "enum": 6, "enumer": 6, "async_wrap_it": 7, "iter": 7, "asynciter": 7, "wrap": 7, "asynchron": [7, 8], "hexbytes_dict": 7, "data": [7, 8, 9], "dict": 7, "convert": 7, "hex": 7, "string": 7, "flat": 7, "dictionari": 7, "hexbyt": 7, "In": 8, "guid": 8, "we": 8, "go": 8, "show": 8, "you": [8, 9], "more": [8, 9], "detail": 8, "how": [8, 9], "build": 8, "should": [8, 9], "have": 8, "python": [8, 9], "project": [8, 9], "instal": 8, "pip": 8, "easi": 8, "do": 8, "so": [8, 9], "through": 8, "up": [8, 9], "each": 8, "time": 8, "encount": 8, "specif": 8, "make": 8, "bot": [8, 9], "order": 8, "perform": 8, "autom": [8, 9], "necessari": 8, "chain": [8, 9], "interact": 8, "howev": 8, "won": 8, "t": 8, "veri": 8, "where": 8, "ad": 8, "let": [8, 9], "u": 8, "specifi": 8, "our": 8, "To": [8, 9], "follow": 8, "handle_new_block": 8, "insid": 8, "defin": 8, "logic": 8, "want": 8, "detect": 8, "serializ": 8, "structur": 8, "store": 8, "databas": 8, "trackabl": 8, "metric": 8, "dure": 8, "captur": 8, "failur": 8, "similarli": 8, "token": 8, "here": 8, "transfer": 8, "handle_token_transfer_ev": 8, "again": 8, "heavier": 8, "load": 8, "like": 8, "handle_on_worker_startup": 8, "db": 8, "etc": 8, "handle_on_worker_shutdown": 8, "cleanup": 8, "close": 8, "cleanli": 8, "come": 8, "comput": 8, "note": 8, "ensur": 8, "multipl": 8, "properli": 8, "telegram": [8, 9], "api": 8, "sql": 8, "nosql": 8, "someth": 8, "els": 8, "0": 8, "2": 8, "These": 8, "move": 8, "clariti": 8, "variabl": 8, "also": 8, "made": 8, "avail": 8, "quantiti": 8, "maintain": 8, "its": 8, "own": [8, 9], "instanc": 8, "annot": 8, "depend": 8, "taskiqdepend": 8, "block_handl": 8, "onc": 8, "mai": [8, 9], "histor": 8, "sinc": 8, "wa": 8, "action": 8, "handle_on_startup": 8, "process_histori": 8, "last_block_seen": 8, "last_block_process": 8, "handle_on_shutdown": 8, "chang": [8, 9], "behavior": 8, "signatur": 8, "now": 8, "onli": 8, "program": 8, "realli": 8, "abl": 8, "valid": 8, "doe": 8, "what": 8, "expect": 8, "includ": [8, 9], "cli": 8, "command": 8, "take": 8, "care": 8, "proper": 8, "signer": 8, "testnet": 8, "my_bot": 8, "acct": 8, "enabl": [8, 9], "mode": 8, "might": [8, 9], "lead": 8, "transact": 8, "sender": 8, "would": 8, "done": 8, "had": 8, "sign": 8, "anyth": 8, "given": 8, "rememb": 8, "lose": 8, "substat": 8, "amount": 8, "fund": 8, "product": 8, "alwai": 8, "throughli": 8, "defualt": 8, "everyth": 8, "job": 8, "share": 8, "volum": [8, 9], "environ": 8, "higher": 8, "rate": 8, "primari": 8, "compon": 8, "manner": 8, "For": 8, "work": 8, "capabl": 8, "taskiq_redi": 8, "could": 8, "export": 8, "silverback_broker_class": 8, "listqueuebrok": 8, "silverback_broker_uri": 8, "redi": 8, "127": 8, "1": 8, "6379": 8, "alchemi": [8, 9], "And": 8, "subprocess": 8, "w": 8, "all": 8, "todo": 8, "backtest": 8, "packag": [8, 9], "deploy": 8, "deploi": 9, "your": 9, "respond": 9, "librari": 9, "leverag": 9, "framework": 9, "ecosystem": 9, "plugin": 9, "simpl": 9, "yet": 9, "sophist": 9, "excel": 9, "case": 9, "involv": 9, "continu": 9, "monitor": 9, "newli": 9, "confirm": 9, "log": 9, "new": 9, "pool": 9, "creation": 9, "deposit": 9, "liquid": 9, "measur": 9, "trade": 9, "activ": 9, "popular": 9, "larg": 9, "swap": 9, "group": 9, "read": 9, "userguid": 9, "learn": 9, "python3": 9, "version": 9, "8": 9, "greater": 9, "dev": 9, "reli": 9, "heavili": 9, "worth": 9, "familar": 9, "yourself": 9, "releas": 9, "clone": 9, "repositori": 9, "most": 9, "date": 9, "git": 9, "http": 9, "github": 9, "com": 9, "apeworx": 9, "cd": 9, "setup": 9, "py": 9, "checkout": 9, "sdk": 9, "pwd": 9, "home": 9, "haramb": 9, "tokenlist": 9, "consid": 9, "beta": 9, "break": 9, "occur": 9, "comment": 9, "question": 9, "critic": 9, "pull": 9, "request": 9, "welcom": 9}, "objects": {"silverback": [[2, 0, 0, "-", "application"], [3, 0, 0, "-", "exceptions"], [4, 0, 0, "-", "middlewares"], [5, 0, 0, "-", "runner"], [6, 0, 0, "-", "subscriptions"], [7, 0, 0, "-", "utils"]], "silverback.application": [[2, 1, 1, "", "SilverbackApp"]], "silverback.application.SilverbackApp": [[2, 2, 1, "", "get_block_handler"], [2, 2, 1, "", "get_event_handler"], [2, 2, 1, "", "get_shutdown_handler"], [2, 2, 1, "", "get_startup_handler"], [2, 2, 1, "", "on_"], [2, 2, 1, "", "on_shutdown"], [2, 2, 1, "", "on_startup"], [2, 2, 1, "", "on_worker_shutdown"], [2, 2, 1, "", "on_worker_startup"]], "silverback.exceptions": [[3, 3, 1, "", "CircuitBreaker"], [3, 3, 1, "", "DuplicateHandlerError"], [3, 3, 1, "", "Halt"], [3, 3, 1, "", "ImportFromStringError"], [3, 3, 1, "", "InvalidContainerTypeError"], [3, 3, 1, "", "NoWebsocketAvailableError"], [3, 3, 1, "", "SilverbackException"]], "silverback.middlewares": [[4, 1, 1, "", "SilverbackMiddleware"]], "silverback.middlewares.SilverbackMiddleware": [[4, 2, 1, "", "on_error"], [4, 2, 1, "", "post_execute"], [4, 2, 1, "", "post_save"], [4, 2, 1, "", "pre_execute"], [4, 2, 1, "", "pre_send"]], "silverback.runner": [[5, 1, 1, "", "BaseRunner"], [5, 1, 1, "", "PollingRunner"], [5, 1, 1, "", "WebsocketRunner"]], "silverback.runner.BaseRunner": [[5, 2, 1, "", "run"]], "silverback.runner.WebsocketRunner": [[5, 2, 1, "", "run"]], "silverback.subscriptions": [[6, 1, 1, "", "SubscriptionType"]], "silverback.utils": [[7, 4, 1, "", "async_wrap_iter"], [7, 4, 1, "", "hexbytes_dict"]], "run": [[0, 5, 1, "cmdoption-run-account", "--account"], [0, 5, 1, "cmdoption-run-x", "--max-exceptions"], [0, 5, 1, "cmdoption-run-network", "--network"], [0, 5, 1, "cmdoption-run-runner", "--runner"], [0, 5, 1, "cmdoption-run-v", "--verbosity"], [0, 5, 1, "cmdoption-run-v", "-v"], [0, 5, 1, "cmdoption-run-x", "-x"], [0, 5, 1, "cmdoption-run-arg-PATH", "PATH"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:exception", "4": "py:function", "5": "std:cmdoption"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "exception", "Python exception"], "4": ["py", "function", "Python function"], "5": ["std", "cmdoption", "program option"]}, "titleterms": {"run": [0, 8], "silverback": [1, 2, 3, 4, 5, 6, 7, 8], "doc": 1, "user": 1, "guid": 1, "cli": 1, "refer": 1, "python": 1, "applic": [2, 8], "except": 3, "middlewar": 4, "runner": 5, "subscript": 6, "util": 7, "develop": [8, 9], "prerequisit": 8, "creat": 8, "an": 8, "new": 8, "block": 8, "event": 8, "log": 8, "startup": 8, "shutdown": 8, "worker": 8, "state": 8, "your": 8, "distribut": 8, "execut": 8, "test": 8, "deploi": 8, "platform": 8, "quick": 9, "start": 9, "document": 9, "depend": 9, "instal": 9, "via": 9, "pip": 9, "setuptool": 9, "usag": 9, "docker": 9}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "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": 57}, "alltitles": {"run": [[0, "run"], [0, "run"]], "Silverback Docs": [[1, "silverback-docs"]], "User Guides": [[1, null]], "CLI Reference": [[1, null]], "Python Reference": [[1, null]], "silverback.application": [[2, "silverback-application"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverback.middlewares": [[4, "silverback-middlewares"]], "silverback.runner": [[5, "silverback-runner"]], "silverback.subscriptions": [[6, "silverback-subscriptions"]], "silverback.utils": [[7, "module-silverback.utils"]], "Developing a Silverback Application": [[8, "developing-a-silverback-application"]], "Prerequisites": [[8, "prerequisites"]], "Creating an Application": [[8, "creating-an-application"]], "New Block Events": [[8, "new-block-events"]], "New Event Logs": [[8, "new-event-logs"]], "Startup and Shutdown": [[8, "startup-and-shutdown"]], "Worker Events": [[8, "worker-events"]], "Worker State": [[8, "worker-state"]], "Application Events": [[8, "application-events"]], "Running your Application": [[8, "running-your-application"]], "Distributed Execution": [[8, "distributed-execution"]], "Testing your Application": [[8, "testing-your-application"]], "Deploying to the Silverback Platform": [[8, "deploying-to-the-silverback-platform"]], "Quick Start": [[9, "quick-start"]], "Documentation": [[9, "documentation"]], "Dependencies": [[9, "dependencies"]], "Installation": [[9, "installation"]], "via pip": [[9, "via-pip"]], "via setuptools": [[9, "via-setuptools"]], "Quick Usage": [[9, "quick-usage"]], "Docker Usage": [[9, "docker-usage"]], "Development": [[9, "development"]]}, "indexentries": {"--account": [[0, "cmdoption-run-account"]], "--max-exceptions": [[0, "cmdoption-run-x"]], "--network": [[0, "cmdoption-run-network"]], "--runner": [[0, "cmdoption-run-runner"]], "--verbosity": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-v": [[0, "cmdoption-run-0"], [0, "cmdoption-run-v"]], "-x": [[0, "cmdoption-run-x"]], "path": [[0, "cmdoption-run-arg-PATH"]], "run command line option": [[0, "cmdoption-run-0"], [0, "cmdoption-run-account"], [0, "cmdoption-run-arg-PATH"], [0, "cmdoption-run-network"], [0, "cmdoption-run-runner"], [0, "cmdoption-run-v"], [0, "cmdoption-run-x"]], "silverbackapp (class in silverback.application)": [[2, "silverback.application.SilverbackApp"]], "get_block_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_block_handler"]], "get_event_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_event_handler"]], "get_shutdown_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_shutdown_handler"]], "get_startup_handler() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.get_startup_handler"]], "module": [[2, "module-silverback.application"], [3, "module-silverback.exceptions"], [4, "module-silverback.middlewares"], [5, "module-silverback.runner"], [6, "module-silverback.subscriptions"], [7, "module-silverback.utils"]], "on_() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_"]], "on_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_shutdown"]], "on_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_startup"]], "on_worker_shutdown() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_shutdown"]], "on_worker_startup() (silverback.application.silverbackapp method)": [[2, "silverback.application.SilverbackApp.on_worker_startup"]], "silverback.application": [[2, "module-silverback.application"]], "circuitbreaker": [[3, "silverback.exceptions.CircuitBreaker"]], "duplicatehandlererror": [[3, "silverback.exceptions.DuplicateHandlerError"]], "halt": [[3, "silverback.exceptions.Halt"]], "importfromstringerror": [[3, "silverback.exceptions.ImportFromStringError"]], "invalidcontainertypeerror": [[3, "silverback.exceptions.InvalidContainerTypeError"]], "nowebsocketavailableerror": [[3, "silverback.exceptions.NoWebsocketAvailableError"]], "silverbackexception": [[3, "silverback.exceptions.SilverbackException"]], "silverback.exceptions": [[3, "module-silverback.exceptions"]], "silverbackmiddleware (class in silverback.middlewares)": [[4, "silverback.middlewares.SilverbackMiddleware"]], "on_error() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.on_error"]], "post_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_execute"]], "post_save() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.post_save"]], "pre_execute() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_execute"]], "pre_send() (silverback.middlewares.silverbackmiddleware method)": [[4, "silverback.middlewares.SilverbackMiddleware.pre_send"]], "silverback.middlewares": [[4, "module-silverback.middlewares"]], "baserunner (class in silverback.runner)": [[5, "silverback.runner.BaseRunner"]], "pollingrunner (class in silverback.runner)": [[5, "silverback.runner.PollingRunner"]], "websocketrunner (class in silverback.runner)": [[5, "silverback.runner.WebsocketRunner"]], "run() (silverback.runner.baserunner method)": [[5, "silverback.runner.BaseRunner.run"]], "run() (silverback.runner.websocketrunner method)": [[5, "silverback.runner.WebsocketRunner.run"]], "silverback.runner": [[5, "module-silverback.runner"]], "subscriptiontype (class in silverback.subscriptions)": [[6, "silverback.subscriptions.SubscriptionType"]], "silverback.subscriptions": [[6, "module-silverback.subscriptions"]], "async_wrap_iter() (in module silverback.utils)": [[7, "silverback.utils.async_wrap_iter"]], "hexbytes_dict() (in module silverback.utils)": [[7, "silverback.utils.hexbytes_dict"]], "silverback.utils": [[7, "module-silverback.utils"]]}}) \ No newline at end of file diff --git a/latest/userguides/development.html b/latest/userguides/development.html index 184dad73..8cfcea74 100644 --- a/latest/userguides/development.html +++ b/latest/userguides/development.html @@ -50,6 +50,7 @@ + diff --git a/latest/userguides/quickstart.html b/latest/userguides/quickstart.html index fd041ffe..84135302 100644 --- a/latest/userguides/quickstart.html +++ b/latest/userguides/quickstart.html @@ -50,6 +50,7 @@ +