From af0551877a3619014009c2386bf477b02cd730cf Mon Sep 17 00:00:00 2001
From: ofek <ofek@users.noreply.github.com>
Date: Fri, 5 Apr 2024 21:42:34 +0000
Subject: [PATCH] Properly support applications (#1370)
 f8c19275a4b370b9958d895239d5bf917b1fd524

---
 .../images/social/how-to/publish/auth.png     | Bin 52360 -> 38429 bytes
 dev/history/hatch/index.html                  |   2 +-
 dev/search/search_index.json                  |   2 +-
 3 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/dev/assets/images/social/how-to/publish/auth.png b/dev/assets/images/social/how-to/publish/auth.png
index bf150f2e3a45eedf78bd857bc71afe544e770de7..fe37a49598bf809681b953f9fc81278f59447b7c 100644
GIT binary patch
literal 38429
zcmeEu_dA>4AGc1e8lMi@s!<hH6dgwGmZG7yB(}C{7qx3d+A3OF+L*QXNJQ*Cx>QkH
zjKrvsBC&~(h&;D``uRTp!1Lpi>vFj-7x#VcbKd9uexKLy#!z3IgN>Jsg@uI!eDAI?
z3(MhB7M6p4$BqI&F}NLM#ljLl3%+~D^jYfSxW5k{Zv6Y2qkmODit13;p3vaAGX9;z
zPGdgpLEzjGb&unR558hK{_3BDLdR8}A0JP8G#1o0?iCApf~J-e85(A0aBb-M(a9bK
zMWn;>&oS$F!+7nMAgq1Af^Fbo;DNv=DXt2m^zS8$%qx}?|6b;6JwNjAm5K1DgMY4`
z7oB`?;Lp{k!DGOf_dgF@4x9aZbxro*)qk&&cn|RWdv*Wa|G(Y;pSwS?@c%qeRNcl8
zR0_g_!WXaxF-6sGUEg!+scW)sgTjBF_f-7iC)%ilL5xvG`a@i`%G$0Lqf`ddXD8Sc
zRC+n)9kzN&&|_t=VFQ^`5%uRUlF|uFrk-~qb)s&V8poCNPqWvh9w{%h;(-)qHyVb7
zyeKE|mzyyjSFm<2pB0NTc*}RdbDfKHQ838RQjI-{{Qy*n`|J#sYLjN=X1Tr>Y#lV*
zFGo7LfA3$WvwrasbMsn62X`Z*Wql%XF`?5uM1Ah<o2Bd@NzLVofmbf()*RHRmof3^
zv-xkEX;_uqu+Nu-IpDpBeAd#An$8$GAt521`}a*BJ<0|?XLxzV5eS3=A7^|*0;;g^
zUO+%VM`!229)n)xF{x_r=%|Z~=2OiSj^MgSvp}BV5x}mFd|-Pgkk|Voq}(j2pKhx0
zcbhjF$02Sz)0?3Vc=h;r9;h32ZLROe2VvR3O{aGPDi*?8Zw;-itZ*SQZ6=h_nYABF
zelR$ESKHma#BXsV3x|fm;C!mVW_1b+9bG#al`{yh?FjMunKP~aDjEmw9LF%uWWM|7
z-~93XDA94nkT$^;pI)wGY=4gU^p=eG@B3XJZ)#UKbQ#~h`|2u>E-nIOel@{m3U|G2
zYj{k6mlrklHNthI^kMx%e#-3Hvr6wdeK-XNqmj_qO6P&g@d>kH_Eb@wQHGl4cTQ8Q
z;hWstYV~*p&vl`{`O8<lV-g#e#x(w(Wed$%8LcSz-JOQ+lxn#D;lqb=v#aG6u3QUB
zsy|Rg4oSFPs!Gt7sj)HAy<tf%FE4LlCPr<@(xWLaF7Avy|3qQ&*9+WyLz-zp*7@_C
zcA%4w)7~B{#oue0m`c8-s2@t#78n1Lm3gs2M<-RM>&npgjPgxljhJGbjVZZSo~eAt
zS_#+0t3fRhvbg1u04mD<f>}7*g~eS~{%KI5zfyQIGzV9vk*WR?4zVB&PUVQ;D`hP+
zq;C~6#KNkgUGLAmx@di^03FT|34L6fq0?!l_^i<IL}CGX!-Esm_{D8IbwBQ&R~s3n
zV+Y4q=6|JQiGB?rutqq0p9*y>=VtdU4Y?G|=g5NOc(XQEW6?{hsx~!aUQzC~Q%4!w
zGckc=OwHz3F15mo)aTVDfjU_y$8mMT+>viDOk5of4fy9lRe92th`kls9<R#P{GsMw
z7aIaa!%+Ulg;L5AMjnXNVnkDmZrA3D)m%3T<tn`*f{4K2w=!=xygax>nvlIa_mhNT
z!r`~EyRHqX`YY-MqXUWyTdwqWcczGE4FN+MR<dFQM!0^@Jv_d#%}XR^jEJB4^HK@^
zv%Qa&Cb#^#&k}WzffQ0+n;^n!puoVR6h(U0#tQA?w&Cw_sd8DLZBLeQMpk=Fmds@!
zY$ikKnDz45D*ILsAT)GTj!s-vWBzbxk;5My*s95%zZYQ>{KzzI3Ze%^Yr<^a=UymT
z9KSl;yu5Bxzl3kD`hrfr%CnGaZoRph7CPItIyC`)SWo^wfC_`jQs#M34IYagm7RZv
z2sJfIDByQRVBK8PjXaG?)HO6HgC+*fec77HioPyY)v_8z^_L%eIF)aOciWq;Of*q|
zFeb$ssP=8I&4_?ME=W{u(J#c;Q#*N%_x93`m0I+T%ctdUk34rFq)NrexpfUCztfJl
zHEd8{_)<|{r2Xg~j;af@pHB&ksC=fWg{eLg#!YjW5`tH(zUR5BgTbr1KQ5M1scFb+
z*5~6d_-LXihnKqbV;Ryb8)BNOC~}yWbZCF*nZC0Q?tOSccZgO88@T_~@za$)3&z&|
z<G$-_MSP7oLnnxdT^4T5jf9`*rBW1@DhD=yr+AQh5PKCsMlv-rDjrX<>HBTZRoHlS
z814P3@tpd|bM0l`T;OZ)>KrNcpWF``*=RQjaX(T5YXbRGkGK92)=|oso$z2qkQ3xW
zlxFhvx*We1!ewya%(yi&xAq)D?;JmDDOmf4?&hX$3fis0>}vhOFx-XW*p6avT3eRN
zb37v<q-qGW?Khdx`VMvVUZ@+VP^b~S@FxU6B56O<mox>iJ>7O1>~$KyQG?}^MKx)0
zyfe}vHEZ>-?!UN`ide&(^U9Dsajlj(V;9>hENNbDDnITOBM>y}&LN;&i^9lD93LWX
z#~*ul*h24ktwUFG-gUe0^9uzTLyZ9&ao#>ra=XtOXzU0>p_5%VJC0*w*ovV@A1iL$
zbu}piEE_hrgAK(Dt}TEzOsJ^4x@`=-{%l102i8P#b@WOPp|^1;zBevhXRF!bzuIeu
zu)^{;c%!Sx=LF5rkBaj*zqZzs%OLn|lZ42qw2q%rxU-Y_^DP;}oG4`dPzdM#OR%_o
zo$+)Y{@x<KQy@RPR?B@sAltQItAELx=KB5DVK?iRdjt7;1KY<3WD$G8U%wu84RK%0
zDe)d&_MX9+3B+gv<t1>vU6iukDJ^m9mYGPaIlgu?ByS1ZG;$u#Dqd>Q&ZRrB`L(}N
zi?F0(Xy|Hb_S!ZUtK@Ur6yufw_cnC*ryw@nYqTe&bWBzRfWqtln!}JbH67T4xYBgb
z-oC_wQ1hg-q)Jle+i<7NpNO+ScA94c`ve00?gBPm(eI<-3cJ_KAVYQR<nsktD$|vs
zlCY?15psE_l*ywSn|em|1>d#Svz?QZlW6jw?8k<_YvgUa#!<gUF_ZlHP%hP8e*dwo
z@dkg_;qXLLi=+~F##|r{k;Hl+p?#41=+5@D>+Pm0$a-8!Aiho%+g)wTe4kyFas%zA
zlnm+5CI22Oo6gLTK7!bv(B7dAor)^^9Xs)#1PL(jWJ_#5`*LCZM8MVpZ=R}kPNlqx
zLB>_JOr@1ZlcJ)c!0o9Bk@G3fn;f1K_2{QD-RsYkN&R_I6CrdrmF-`lv_1NY?^CKa
zvNhYCQL<jY;uLh)jN{o(2BFex{DT%@JkZzn9WQ>n<7L}7ExK!e(ld_5vsqI7p=Wrf
z(JY7*nC=H&ZeFVfl9*CWad)*yo)rIm$zpF?Z>KkHf5LdxCcwNzP8xns^9ZYbnT3qw
zW2Dw*wCiSV@k?Xwgfrx1*OI<NT*`*rJV14|fI!=-aq`+jYX=73Kp*02ntoS*`gEJI
zV1Vcsj#19;QDa)M`opipwB;=`u+E!hU-^!e^1hF?EE(LSMfC8S7+W;Bprlk)q2oRf
zk2IB>s3+A!$Gvx5@8?Q^xw)62b#nW2_(@s3W4+ROAyi!a))m2&m=KkwmO!7kPMfuw
zDV+0UT#)ZZmps|Og`Nglnaf6bG<=wP#c{+`OT4TYiWWfZdIl&9z=0Ll8C5Y*-MZ+z
z;A@l<bHpu%1s!j8wLg}N9ryZkpYO7?lpm^gP%Nr7`^Rd2PXL76DAH{~So8~D-#@i{
zD$31nyq%JulAFDIsC=|IIq3Us3hB(~yyuA_kn3ms<MDvGw7_34SV8A6$e9hSea4mb
zaD*B8Ryh~4q04lxqHz}7U-n0VZ(&Ft3G*{~JhpmS?Q$jO!D8qQd#ebGDab>kFq=TT
zl!W4+g{bMsV;ci)Oy#E0k`!A*BUj63g;+1rd97pn6LPDrcAOhuK3xL@m1qhMg?8jH
zYAJbV5E`2f$y^y)!o3&L@STKHWqGY|^1-DJDajcZ&_7Ts%6k0nPE{6^AHp$LL_{=G
z<lOqVst|*{?b01;r5d3zTy9ausn8n%Pl7RS(z|dp&u$Wl^3S*Yk*b=lS4&Ox5ksSX
zhRl16<#ZvOYP~;3<+$?xa55PqRcqLeo(Z9-R#crMC+>MJXZg;y46X0FoYmPh)!XD@
z>_C)svy)S824QK-#nMEL^yqPI*0}rd%^u~P`FSS=iO9`?j>%4<xLaSwA$_11mUt6Y
z)bwq>WEMYV{Jh0q)6<s`gdvY`SeCoErKmJ{r#Ww@E~Lpk^s%anS&vLOF}yzz7D;k%
zx<S0>FH118B_oE%ZKR;3+p>uHb22kjdmYHi9;<d=eu27p$F+NuH{MPJt*B^Z#SxZD
zwv0BCezRA;g+2sAMN?CA;iF^vhjDk9(cXb2!WJ}&sod*x*bI|fB94ygS%A8!qEuDB
zZZ-r(Jo9b-l8x6mG-G$j=X+c<uxKX1Po6LOp`ji>Olec3(|y#X^ZEPbD|+okxrJn8
z)Y>oxM#aT>;yOhJxXuR2zERm9_@`j6=qHBj1|FtxTPur_@rWB$GoMakM$@y;PS~P0
z7u9#Rw`I21(BMNdez&uio9Xg28X0?`xYlLC5G6IiXF0hwps%DiZ0(;05|iDz$vwNM
z_}P(PGE4zTxim?0(xg%&zWQc?U;np0&yHKh*{g=Onp(F=%0o5L;NhsqG{s~HYW@eQ
zZ7hiV9EC-|36FrpFo<T3W=)QpsGLhtmTT^Q_^vI88r$U6kfN#}xIgMlx41L;&SX-7
zNR;N@0sh%zZ{raUQg?TAL}Dx>On6YW*C1F#y>X0<yh+Gb_{@ts$9Kj?&SCD2YnS1h
zeG$B>jeFpprjLin+gNhSA@pym9>4yGA$LOCOdm1Pwq&K5uHWFd)Supkbzc3Zrh{r=
zIw_exs6xi5P8JlW;!hW_9>K@Qoip}$CIS}v+zd3}%$c1Ka58Mzrty-7U~v5~y?ZZs
zS(=AW#)tjSG=r}4aHOoC)w@ML{VsKni-V6IMB(#6*KgL}vktV)ZWdln#JRvM9MXSF
zj*ZP5s@pbT-J70fpUQqoL3?)_QJ2A_AxuNPFS+E~H;^wmA$Qm&2s4otM&S^CQWTTS
zi}$D)^_ffa*FmnA*N~m?>(HH(pU(kX+}O}8s{zq~>JthOM3mVEZ4qGvhYIt!5rtYP
zp+<EqXO^*3RXt3^Ay#^AnRV8A@9v*l@eA5qZhWl5=y$+&|G`zR2{J!DQ#km@zHE?D
zt#+j{rGBf)3b{E>;@43?66OuRuplCqTU^4Wl;NcgZ|Ae_fIUg)xC`eEBO)VDKrAdQ
zR`|>~x?&-=EWX(gnASneozSDsyW4BX+)$;-#BWZZiigJ@O6+$LuFDq2vOcAji4S&^
zg5zL@B^V_ynHBV*{r15<ouCbVgM%?su8CJe%^+6OgBY%o-Y`esfmcRlq;rB-Qo6Dm
zcfFQIZ8Kl;Zaju>wyMHgWb_>MmvW~<vj_hiOcuqj`jLM0ox)5!H9f(TCoWP|*qZU@
zC2tc*aX!(;{yiq<=IO>Uvqjo-wOTQ2W%Mi9Leq^zk9c6i;@zu8Q3s1?;ambHlh?l3
zWn5q@jaKU>?36chRPG<kM067hFZyH4xv;Rii@jPIT$KWyx!%nn=pWST*O|)o6g0#l
z*sR9dt3IE7W#9pUJ0+IVA2eB%TU>5->DnjQ*P|j=ROQSznny~4RvHZCCxa_M=aUbS
zM}{e3=2~;#)_><TcVGz~E!N~AjEU*)6^bC`-sucT<zexE!L3`Z{9R(k_`cvHN4Ldp
zeG;1FjjcyCKg-!$TZ;k8dSo>FAjALupynL=`|$#=*VB%Zi>RBg@HHM830O0XW)#es
zL92?4WXFka>`5RHOvOX!<P6J8jV@02rbZnzFuvp=G5RWReB$pP!zXRflK7*4akGM2
z>Kt~Ez5&xgUgjX@&`Z)Ki*Aer%*1Nawi{%TxkegF3zJx@%+mMx6CdK^;+%HYxoMt#
z;uwo29YT$psnJ8C=`CmqcC3WWKG$4^N+MG-5G_K2f*B~+!QI8B_g})pIfwGfyx(4s
z*9SVjj-H<3zDj$Yc{xJwPM=rOH~#&-_S_^6Yn$|>n)GlmoS#ma^Ka?vf7h`2%{2oW
z2CFEb4k0FMbGuhNglp0fdjZx@Kkv}mT%~{f9xEvOYWJ8~hwNMuPn`YGHZz25J>g6B
zSaz+}L7gsYL<Ka)#Ke4mdtMma(P4(OGPs$1fcsw%F*Q5<exMC<)>8@cz6M4{G@1m2
zi6po9R5V+!#afkgyuo`k2j&XY1w|GQ)z4Kc&b?Iyj)_oUr3(=mW=+(!%j3*%2dxnd
z4vPwhcSFVIIa7=$^-LHiyg6T;N!xB&ueDBA2}(H1$yZodc;zd%nQV>y<Hz&#m6pU#
zVt-zu4Sv?p^=H!cWHm&ySB!fC0V0L&stL&OkvSe)`=?uF0SjPgTY(ClCrpiOE*5!Z
zZxslnmqhiP|3xwPTj}Z_+?eRyUW=`I@cAIdtW3SeM#V;V?>q>RqN$SrEvS{D?R`P9
zh)GG=th6xG6@5vjqp?~Ci|r;?#v5Qj#ZTi2rl(bV5X58JgqhC`C2cm-o~U8pKHDv$
z=uL#|YTMYPcdOE$09B47eN{V5Ys)RY;H>B?p;!AW#&R1tH$rTZO}K4<9uj<l>5s`;
z)j`_q%<04@C{_W0iHN8ud96)wxPmz+jZo7i-YS*qe|;{co7XuJ#8_?~fLO(${U-tn
z`kuBg`MGu`NCr-Yos}W~90g{r+GdYDS=pj|KjHZ`urb&(Jweja2q!4KVGoQZ?A0sN
zBhEXcO6)3rm3)7ZV13Wlup)dl?R;ITNaWjNgPlF8dAi;Fh1wZA-Ms-F9jUZQ7y$%k
z<r3HjTI4X+nP82Wl+Qne+HDm*Oo`R+A4Ev0&dD?}Khwpfq)H%?L?6W}za<L*!0=91
zg@;QuuBtQ07=K?-apIQ}gq{&XC9_xiw}ex-2TE!U%WOobqfc+m_h}$aO`n#&>A8}8
z!TVnX>S?5|-rjw8|1d?7R||B5lA%tfSys!gU0C*|L*ys67NoeZMoPvb&Gf=ZU2&9~
zl4QHMYuEaDgxIA*ubC;~uzFf~7Ol<FbrT1(T}TBAi@EtnU^?=po43_ZoZTy&p1!nm
zB&^d9ZyIL1D!P*<2jR&ed7B*RZiKXUPQ>4|N6Wcc6-`e+Qs9fee8h}j$uABRe<uGt
zT)a>HFSHJ1A3baFBCqnT-UkskqR;3czq7AcVa8v?S*h%NQFkNwn(DUHHV*}qd+WHk
zkx$vS{gM_e`eJ_m+|CF_XOXYOGpC*e<oFW7knKCV30EOtaM_oy>cC82MR#cr+02~r
znaC+`1r0GS7Rw#UpuhLp3ocT2ubBv-s#vQ~#jz1w0@45|gfz7X{?_a1q`)rpH}yJh
zc$$Xn1;l?QU<Gpu1k<uwm<uo*zG<!70#2j&?cmALrw<-ntg7DG87lM2vb2a@M1m;y
z-o}Bf;S2vPO|}>`_`3~M!Pxtzd$0r1+%+x(*#w_94!g(WJ2}x4YNlZsyLZwf`xUV(
z=Wb|kbr*n<s<fvzRd6k+F#CxUu^>p?94>&rQuTjfws+?^GPjA<3j|iF*K}DH(Xg+A
za%K35IO-rB3|6e?0s^V86S|;`q}^;h&OoG9plRE@=-}=WuRID3a;D7+SWp>~7CV&q
z!0qnir1&$E;K+BJ{fwG-0|rqZg9<lUi&h5;;wd9{>%971{Xac2`ZS9MK$?%|JAVAQ
zCgZc3)Z1$aMgqwq5nbHf7CEH(FR1!StXr)x6y&_}V(}<}K__lhId+ZLlk+`&m$^=O
zI!z~$G<JvF{BbVS#3Mv;saPo$kIa_`CFaW4%gh1v&#7scbG3#HU}-4n$vWfc#?X$y
zXO*c%1lKC>x6Ot;f@<LY$-OQAuT$}$o$cKlGsw23;u-@dmA{ls>h!^bh>}nE$*0eW
zb8|VrF18#cjQJD3xj@V;W36d3hz?ULQr~Cx8h1qgU9Lu>Z2jX|^>af&GcmXs3@>{S
z(ai9S;Y}%Vna_MCxwk0p%SOFIr4A6g(W(aVvKLLGvnoWux(QMnij|7#t;TJo+LdDe
zTaq^MQck{(_yMA7mN$o@q>X{9jCGsiZ7QSg?j5_0LCVkIrrpUKBHtqBn_6shGcT&C
z(EA^~`$$1SF-ibHq|~0WSm;$EiN4x>iMYF9)eeCZHChe~fWTo#>U0bYu-sO%Jdf+f
z+f-OzndjgBZ@!n!o<oeLj9o1Dj%RoPaX^`HJ&X2_nRg*Dc7uId!$K)b+As;_pSE+h
zloC}&V8d?)`G(5cC)2RQ@>b&_;7LjSp;rn_Q+=C{HanfCQMYQ%H78qa7>bATAx8{6
zniw_^Gol+e^x;FI_*<SRh^p$IjhcHUU&i;8KMDAG>__2?P$)WP%)MYs;0H8O|DkAb
zcl%7e^Lnj2zDZtJtSEr(SgGsn$y-OZ2~`1>;lC%g%8qVD4bYjjW}Mnz*Y1W5U_3%b
z@>-h9w8-)WPG7c9(%L4|p~h4x8jX-gn~hbw@?e)(zRjwOEY2!hU+C5C9^|*EbShhJ
zCUa_N9E&+(rn+?-Z2I8i|ElWrRUR}zRv>fz)$qmr{l8Oc8?|fh>7Ad{%L(^GVzGMC
zP0i{RQhPPwocDWOrBh8DpAr3nD&fN?8CxG$WOra5sJS0!eY^NKK$b}pL1bx*+FvRn
zzAKl&fy+ffM6q_*TE9O!?W<^33`k6r{@U2sxRDbJTA1(4L4s^sR!;}aJ87Bz<qkDP
z-{M}R3C>q|R6CFVHXWDoe<h_rO@tgY80?RyQ&t6=2ez!WeI`=(Xq|!%oo&#j5{H2y
z_NJX>3piy-ipU+OgQQW(c|ptdhK@ZS^IsgI4Jvxf>GKa(c-Su4Qa>In7&ojM7i})c
z?KnPa8?c0^r!Kp4pIRKZ1MBL>f)ozUq->h??fy-(&ri{9#8Oml(`%YAgPY1KyMr}>
z(*`GG3lWW%W61dj;4^~~VmkavuXq(#mYd9JjExhrOu98ve6B5!G__D}fjFOB<6<3|
z9yq0qu}U;1Zx7o9=m=}GyR7ooSb3MYx6rBUaop|GXRj<IvUECBIW5F6aqF#uVp4K<
z4zY5Yw(K?G8vH$c0SvgCo7Kd`L<GF|!ZTbz!h-W}JNO>tyX@JVt@IX`rIH~&^Xp)I
ze7rNR{tQM@%4~hDOk7U!9xy(XhSlp`epP_S;8iM*Qv4qAW2zLLnQ2P!7sS=5E%!}x
z(|w-IPK?XP3^di~6)Fx_r)h5vo=_tZG=ospt*=;%f~-oRPYe=4D%<mdl%bR!v_|lg
zCdTq`O~I^RM||4ljBNoV$o1)C+@7n$riq2$hyHT5Dt96m?RSbaaqHP;gxc<%9POAA
z-(~=N(?#yHSySeBbua#<Um&}OW^i`D-svm`g;ifg+;6RGXQOaH{LB-^1Zq<CYm5gr
z;*)LQRbTv7@n$Ou{G5U+JHLFaLq1;w_wR)&1a1*UXtSLduLg+$jQ(|@WK|iXaiv$z
zQ{N9Ea|;WPEscCAZa!47&`rShNy=Ln75>0)82i4C`2ec(?$6CQbk*DqDGn1@O!z0y
z{kRcisZ+u#aD%W!Tm8!Adc^GG$B!Ky9Z1lT2<qy(xrXk4oHwpERRpMPSn(gDc`ffk
z^ePm)69#4mBj~EVaB@h_`_go_82;??{;S--mrU+-mjw36KEBP$*eMz%jjHH4pFa{f
zh06=1&ggk5jsr;c>x*5yI1|Qc35_d>gd9px^gU!r9Z7v0KIa>_&LvGARbyE9C{s}m
zU8%)lv07+<?D9I->hSV7eY3;W17`DcE>WT6D&#=I?A%jRa%_eMF991mK@Vv{#>V2B
zf~Y9ClHcNckhxnk8~bwb%N|hjiT?#romHM<a=j^QO_Q*JW|oZrMZSx4%M!T>={Otc
z^pz3$_Iz<jjzD~?#d)#C(RD5WfiQmX9D8b7;|$+y0jK9@-d<@N6Hy;nM*4M&hPC(Z
zyIlpe;5|PD>-f)*$4<{3Vit0y;7aX*W6Gu{hD9YLux6@qDJAvm!J1mH7IxHBi&>W&
z%$c+vZQ5kP37<I?gC7e%5dMJze|r{t4u*YFR@+hu4L=1_`2?JB7!4${EM3N9LV4V~
zM+HI{##oAi*^aM3DChdNw!wdrZEyGf(aB{aK1QYY*9U?4Gxmko<jsK=I4-`~Sl_WI
z-~X0I413^x>(Em~AK1J!!FDjpl9@ZAA3Ny%gCF-YZFjLFGS5|7FrRfL)ieMaQyJoo
z+M_S<!1ua1`E@$cE`mIZ*ik#W>z7~4RZyXyKPCGUJ0*Jjzfuy59Amzr;C)6X>*q?y
zzCG5%=*r6b5ym%7t*o-$-=tA`2N1*2D$Mti*&2`_e|_TJMWH*KI|{p`;LX#lzPQB6
ztG!jjHt5yWj;uFr2a8veJ|E4{tpxoopZM!Bgd)g^k`JAb%Ml*0cMm?AojH41aPq+@
zL;Z0TKE{=7tQqhkl{?HU{&!L7ujk^at;pQy7iqFJ1W0`@!Jc%|xbEd-crm5kacLYM
z-=eXPjg-Kp;x~1x;sCV$<ygn@5xeZr&8>(FRY3CM!HyKX6%NDEMkR%GZfa3+g?n$x
z=_4*G(QE~}*pTx3t$D=AcW?SV1nY7p+7_Q~ixttOPZvv@HQH<~YuJ}Djh%@<?<IgV
zBUn4J(QH@2$*SepW~(v{+u*gZlG<su{X^ET&!NcN)%h0`8$nFWzq*j;em@^k`aXFY
zEC8@y+{bG5JT+DwXcWZr06%DS_QUK4Z9la2^{s!x=;2~Fa&rRx6k%|6I?BMzww2B_
zZmPT<6uQ^E!43bo9;U8-TK4huhOfR;dSaEHK#d7<vp4pH%M#b|&Eei=YZ>qR2+F(_
zQ~aes%qErEJTNhMfAoo5)5gkK?vnz)aWm3VQhn)q7tY+8TXrE>2f=iaNX1sultZ0F
zFCdifT|fDG-TM}R-TA|}r`qbbr=zNz`YwTySYh?gQ%#Nasurw&H`<cby}KS1{<Y^F
zIyd4&9=s?wPAJS=&GhOhmsR$P(`tL$|9tfYiD%6E_zQk}g_6jQB~J;=Ey!d60u9lI
zkx~YC@Rp_82lmQzc%OwTg3^Ve^88xkK!9?fWUC1{kiS%K5TpM%3Kk%qjdz+#=C`PI
zh{zUJj~fxvIevYLjf2zh+0#tE5I=JaRFY7u8#S~9^xd8d3dzdOKKw8=fgl(x<R9>c
zPq-V6|1BnIJlf5T1f_Io3o=XZL~zbsAwI3{kN(|3^m6^4v=_<FF_dpD)**dmsBSJ@
zG$TXeYxe2y9bRLNR!%_);JM%hXR`jkozHJbQjLN6d31cnPAq_(wJ%(a2bn)MdarW#
zz}9VU*qNel)|U#<R>;|v*M?4mESmnwg|A1lC`Vy!vwWi$6VX<FE&uE&T$(*rSX?eH
zrZYShCm5erW^tshfw=bUtcuV5*CvzADin&NM<C;t5;dbJN3}09cs`M>6iHl>pyFJc
zRJHX&MU~Njv_Vf*peu&$UpbP#`kkydY;1aQf!3gyHVh!^;6BS|Y~F69AfYqs#Us%x
zdK-XBfZD|UPwGYHC(d{2!!v$Ry=j}tyK{Rl)<}5zDc>dd8>{Y9+(bdchkGI1#3d8w
zwTF;6BD(RaHZe~Ds7N3%%*roXD~2zdu)K@$TgIbpR2pRQi3X|+t)lh@Zcpj}uKH{j
z6AfyAR0hB;S*xqjUWa`@#N<TnYSb5A3@X@Kd8Vzp^`O=NW6A5<DL|=E&{(`AF4<vt
z@9v})_T7-?k$*K+qStF0)OXAYkoOJR`!DupUNR*H5!)T_xvI3U6=531$a(1%6c5o{
z9h3zU{oJ2{&$BkigSr@$BY{it1*SGOSwNW-yIvOCyfdu^(V&sMw(sQ!a@^7&dcwKa
zdUsJvd9G?E-L_KkAPzoi?w1@^TtKkVUdRrs-+SC|!Y{iQ3WhKKXv02%zt8xQR$mzS
zg5a_1HxS592(+r_QJL5k8KbNZj5EBWFyPxP`IyIMY6Mbk0KkF4>sRPM0yV#}7gbo_
zaW4<C*r~1GYQDQ>?Kp&A@r!pQBp1YgY}P^g3~(fp^Uj7yM73Uu_-f#>%Q)Yay5VXK
zXEXur@ZLqW7W@Gd%`lT#2kV?mHJV29O?#a)Qqo3y4OCrZ_O$lU1skyOgL}hTf)#Bu
z(5<N|aj9FmK$eZ?c5^!Yw-tSgZ0|73lavs^(k332i7U$(E9{uB*N#`=>8!qnPIqm?
zv>@RY2k!8rm()sURF(*PemLq2A#0f@9i8Q7#W+0C-VK+)-4b7sZH7EE>6;(O-e?3x
zTO((Suk-^yH?bLlg8Q5NCo|P{_a-bD0V|<BK1=VYXl-K{W3R^F_4iva1ZPGhawp5o
z1!8QPjZbogNKWQ{fV6S{3^ER5(nE`(f*fiLk997W;Cqj)bt3!sxe<H5U445Ia|nUK
zcQW!de?G8{*kaCK6%2Y1+s!reAAHchXhDzbH%=%DDloGS{(g>QVE~f#`GB~T<Z$(@
z2F=+&Qf@`3FPh;jE{!ep4bFJjV)Ue-9jUCdw~(<<v>|;gV)SXwJwgDw13>IiilA<k
z;$`}3pqn-0l~uRb4jyi5GZhC4dqp*E`M?Flwe!ZhHjo5hJW-m6VA_H40J<ziHQe_?
zNWaH2+&C(+1bXk@do6as+|u3$7>1ZR>((-Cq>G8P8!?A0r8z6b@BBCyAl`B2q|)8b
z4^;+**6#1@Xb%O1)S#`(%}`&e?AFVxUA|7!L6Gkvz%xz?z3AwWC?4u=6DTaJn7|}+
zu}en%tt+vwE3)r(wlv>&hlMS-_(fml!XnhY3OX_4tT!qpcivYos^(&XIK^5D?}qI4
z@m{BR;46r}c`MjdTbK3KW?I+SO-iDFbDw;t93b{WeHhpi5)8_W&X*k6lI`hO@)H-j
zY=ziviK=``@ng^{TD=-n%IQZsAC;jSWq_7y>?W7oIU9bDuKF&E)umGyvnrbtXR%Q8
zfUqwsyM`eJdW^geguI`VdeGKp3ND(m5n~GMTd`ZkK~+l%+VU>L;Vt689)fF+*<z4S
zHrCtX;Lk8$G!DwT?%viDRJrYGl%>=DqdyrFRQ0={314d0qAcLtyX|;}2RDgsdvV&%
zt?~Gutn4IxV<4e(3H81u!&;c`8{4^nqJEuTD|DPQW4Npvs(3L*1J{~6?Wt=<Kt{yu
z>?NR9U5093(7Lca?^|d3xE-V8TQV{L`qt;c9Bap|?X+r4h=qHNiM7(*g;6DGsHxL?
zsU$h8n91Pumk0S!S0oGroU8fvI5joH$!)FZ#t`MN5uClPXS@6A^%_jwDX>|M6Q~Fn
zl1+_i2YF_{Q6?sIS$!|0SzMyM|9dNy<b?ME8*7@US7Yh1a+2_SBAU*M$<_B8<QjAB
zaL^-l?H#I(`bZyw$be7#`J6N7c{0}{z4*J@2lgs+@V*x{(lc~lctx9X{p|HB^!@|b
z{sJLCHX9>lat&ZRBgI~IR)ORwVzOL)#`GnP3(9heSMNC*@D|53Tjumne?{hQ<Z}*S
z=iVmL=jtldL-`aDc*7=2s~5k{o~b~ME>gRx{@X%XO1II|=NeLpy2!XeF|CK6_r$MC
z#ebd5TA6FXR91ei|An;NT+G-5c!%b!zP1VvM5NYRC4;b`+nS6m?a@algIt?3$11ix
z>RXUAY5qk$<;xpnu0})!<(r!7@Kmv~n<XP|TG7D7fyM@jJ9`iLNLa(?mW1sBE6=<W
z{sx$*Zk&izCgFv2LW6vVx|^IW8bb;ao{Z!yHXa1XPx4O%M+td(*ktg=yYiS~*rQ2_
zCR*LEZ-3QyPmxdSI^u$S0AOlkSp#2A&kXc^GqB68<~*7|9!RU+IKwyZw8}S^u6lP8
zgGY_Md}JN++bK=WH)+h>u}aSSGW+1Jy`_&#!3}oa-kcnPMu%#?5LK_b5NG-rqPaio
zs{+6s&sW6Q3;-%N5ioVqJ67P?wmHC4kUp?_#NsTdEM*!+=XquK)VTw9x!2~Y<zcXl
zxbd`<tkguQL@RF6xzk1Hxwr2J%oPe?R*y^5o0qIq=qo$;W@&3+3hp5fGWhGKe|}Je
z-xX|<^C)Y!uG8y|%yyZ37scM!g?OgDpj~l>k1xADR@Aj4PK-2+&A7@FHB@4a_GsSG
z3abm6^-B2hduH;NcjW0dzQ4=^=*9qyR1k0Q!@UNr9TS32Y1DJn<11uJndN-?bkR5R
zc%R*HPXe}SDllOM>Sh9<G&jEwskICMlnCVuVbaBHvV_(ZfAcXjApVnGvu%?#cGo`(
zw1AP%7|uJJVeQ78G1${IP^KWiM+=||GU~D7V~Y8infF4&dyHJ5Z@y%hfh->vxX@LI
zA{~JwcF3YNnk6D5y>aJit2VCW8v1GdCXJck(nlNTRVr;LQTC2g4;4QoT0_Y3C2(D7
zDKu5$5*UhRd{jiH39ChDoc<m&4Cs<dvNR$(94guYz2?To$mcI#)YH7X6#(*z_tvsl
zm^Rmw)tzr|{+@Mzfy#mg&^qJvy6@5aXzE0eK?@C6XVDUZsrO$gX<;mRB;TC7%CQ`u
zsU)pn%@aj@RYF|5mmxV(I68CmhXdN?j;~C??UsNw;rO_Ca`p)a@;Gz1uG@RJ)+x`u
zZpLV7<YRH4Fsp0#ViB*BLsGqnUq6SuTJDiatm(GhWM{#~a}sNPYDd7rjrbC#F%%7<
z+FXY)>ir8hc-wOMx{V4(R$T}~Zfb>C=<>iagY|L6sEpU_F}*ZJh+SKBd`5;X#L0J8
zn`lR!2dMSoW;i`=gsKCGMLv9X<kGtS>Yx3L_&oNm`|rztbZuwOoXHK?Q0)g~9|eGL
z$m!eblYukuhJA_gu=z>bZE~c!u)%g<MH?k?HldSPQq54aEinX}*FDM>rmSZmU@L2}
zm!ta=C>ydXhz&|NJ%iL<z(i$dPoo%9ux3-G#`R}$^d3t{{hltkpLjE(2sQ`kB*b|a
zU4!o$R>_5l*as4G@<_;}!l0EV?byqD#!sI<#gw8{;q)yWFnZJX6&0WToCN+ua}Rgu
zRzTu1E`j$ojUX`@8B;;TZW$XJ+v74bpCNO{1z^4Vny3@#*Y8=n_{M8S>1Fb=Cg_^w
zSWwgIm~iAVF4xi~oC|JeuDc)jGIn<U2*r-(e)Rs`fw!;aGnpH5$zbkjh?}ohgPgl-
zLwMD$8R-{PKpVaXH@HM7Bh#4!-jQ$LZi-hb+5mJ7sOSnJW6JgGt^Xk3gFxj1+Pf=P
z?u8!ZK(;>m(E7;8%q;24*RSYs_6eT>JsmK(uT#3Exc6d2ICZJNnDGqp*&;x>-<c7#
z@MWV%#;5q}Q~_0O*NWRcD%*n&!!W`!RM6R2Ch*GF3R4{3Ekk6T8%`3rr5L4B<`s@T
zC2ZJ6-(t5K_i+$dL{pnsd<6+W0Z-L_sr+wDJEH^<aE{hH0Oj<+ZQ0!!D#MB_w2Nj8
z0vlr!&ulimmzjZ7)RNT|+~VsPtcIUQ<~nB7w@l!UkiCCBK-n<o5Zt%u0_GZa=p~80
zJzwtN&03JN6ZUYLd>K}p_nh2zJJJnbuV#rfy_qhKEj09Wu9Iq5G}d4!*$kIh+n1RE
zQf1S)7F(bZP7aomiT<xaxgF9i1@7<7(hz}gl|;i4ixt4qkg+W#qZN*1VhnUXydoU!
zZB@(HEXs5Gs#%=|QYI7Op_d`|d39|cAyQWLJCYutU9}`4p=LaRSdIfx7Ea|v8K~(2
zB*er<oRYQ0+JF!Tud*2c3nk>boG#Th4i0WSb?Ov5#Fk(B;>FvZo}K`Z4tqFZbFi4_
zuiN9c(wv_XB(BC5Df4Xgm&Iq?+7zw~%V01lQxSrIo>nYyc{~i6`+D_htJbS4m%nM3
zoxBqnbqsp{S?MM9LxUs9VRd05_*w}FveKV<M{?V*Y*+{i^((P~FYz~ROgMTa#uu(e
zsflejY6FrJ0J!c5Vq9*YF`7%dW-V8hp)6I9N|}S<E0r|z?CtBBdvsi#_nac^bg{x5
z#N=hMly&_T6%}jy)}rv3u<L&}My0oAKoHRn##wMd`B`ahy+o-Cr^ws4ZwJfmb*tcX
zza@MXnq)`c;<wlv@PnAf=^`I}3Ei9@8@RCeb(*8yt8P5<P4wXN18`aLBHH(JK!wkw
zio8qj^Lo*!$p&f7{mGsPp(23aQ)D)7aG&AJM>K9}*LmMOLnEJ!r`Oc2$0c65I${g!
znioZn0XUy;`btt&LqD#C$>O^_HX7xKU6`Jp27v|UKJYYg{_W45sO#Q-x=2O8#ln%1
zk-$*2-J~E>0R*}$tQ|cF=<d;J0}DPb%socn^c&I5ad}(WTaSB$ohe%#-2Y&kXpb1n
zeawLr=APkxO$m=q&1r@sWghO{qb$UO)YNP-gw<Fmb|P2O(qH`AwR`)zB0yDPDVr5Y
zb+@K`3gs$%#JmjQ8@mLk<xYI3zVEsOF_meYeh}hWx0U;Q{<H1mJmd7UMbC4^Un1XO
zQVY<v?^)1!e~k&f-Q2{LL=eZhYnd*VcHCyZVHRy0YimY8R;c$`xP->xA3U#;R?#*O
z0AQ&o=~Q7f4(0mWCRajQ&A>K<5xPemJt%3>sDov0z!eYz^t1n*D{K=8GCgY>T(-+#
zh%ioFwD##c5*ZoUOOYSD5|wMi|Mkq-->WXIpWg-DcwA*6>xQp%ncGbGum#Xe>l>UG
z>W{wtTg5Wd0JuIDL;<)5=s9AS;g@9FAmwxv_ZH9sJTB`X7PqWBk4JYXWFF<1&k2DC
znYz^w;4<E{yY>zauI>F*UW(Sd*PfQTHxVy)r7D;}(N#lMrfv5>-p~|mWTyY_ZnDr`
z?}$r-<-TW`v{-V%*UDQ0sT=C#<P<CFMBS<drh}W<in=2Geq6p5Jgo8GdCX}}hiyOv
z{N~LYq)P<U*9|T4O)+G$Y!&6$ldhN?pChZ(FO#eNByD)Io>>T5n2zd3;S(}!3tM(6
zwzQ2-rm?<$Nxoi6$yw$uQY)HofdV4!Yx%VW;e`^|Mja1kEo_E%x7`7QP~6EjE+}7*
z^4S{oM!9+DyeD>D2R;zn#Q4Xj9#mcYAI4ZiC@M#GuoPL=xZ}3?PhcAPb)NlP<2FmQ
z_WQ^qX^{)G0JbOZG?UJpHpaLG`em(0>WF|V9Q8hcxX+w%CY^^lbs8x7_Gz9a<)^qC
zQ<uldm}-}MKoF?zZEG-Ss5+Y0Qo0r)B0}3`aiq*w^>Plc(q#}RmlWWYaQ2+4TBG*A
zwB2nbs70z!Oo11q*?qhocm5uDf=fhMwNbHp1yE%4NAoLfenzI%`vn>t5tNVfnEQMm
zY@7)2v;#_DP0d!tnc_NpnJZS6xqFl2{EctqU#Mm|Ah*#TPqZll=9MO#Wt-~m?k><S
zkd$HG5oW;A@xXxt;^N}S3P31YH}zk!z?a#5WnF4+CiP~80$BtbT~voH$qH|afVHV-
zG54q~yh?t>6SfK25~4l{F<s(deBuXDaI%73wvLXDEIrk=>fwwWfDR&LAOHC0YfM4&
zryrA(wrPsKC>|)k;A31Brg=kt?%VR6J9pv_B*e0yMa&8H|7uDy7dkot^4ha(t$g%J
z)s{Su18z9qfj%-~2HY<~F*&UOE9cNo^lD%55hpqkd+YjyBj$IbJo-?$l+DkqE3TXK
zeMk%Uy`t03lY_2<zV{zI$ON^U>p#aK|4TP*sYD=gudc3Y5#(e<p>`XO!2OwbLN@`S
zxAWKN$C&$4##;JW9pYBV+?t7<yOYvZCCuHqNnUw(tEw6NjR!8vb}m4#fdnZ?uo=uN
zJDvLv?o8@5zXTxj$6c-kql%j2*)DjuizLn`Si1Ldk^NjYUUZ;@8^%jobzx*R=1vU|
z!q7QS4EMDvEi=Ey=g(QdExUZZH~u%uXvp5HurP?5tIK<$+xv~#SOb^oZ^!Xo7j^fd
zZ`WB#HSPRPNmlT7$Z1P|f-{4(nY}i%IMpNd=dimpQifYmS66pg+K~H(a@A}J-`?Jy
zpJeXU0745>8za=PEyCI{Js^J=?%w56oS^!hh~iUsE*nfouy;j3j{WgAI<=*816ixL
zw^xxW&+{liIo(BqOQ5AG>zb&tvK1iOX%3++h^7TC*V$lL%!aGF&gq<2_`cwygDi#~
zEKa!lUr7J<O9UhNI3uR)T*G0MFgZ$?3DDO;GF0Itj+VEZIZffVfD)23{GUJmz}^x_
za}`$lvGbE4>nS6Rtal$ui)3FG4Y9Y7jJY3}7oBtgD>wXk$x6F~3{fsMo?N~avoJ`P
zTYMW%K<?S@o}I1yna#?_NjP3^s9stv<Jtb*{|ech+ODegGy&EOBew?mDN{I|jQ+8H
z`RBTp2|gJUNlwbn?f`GPsqO(qmHNMx2o63d0tWnK5JDpdHk!*ldeSdgDJQm}MhlYg
z@e4LJm2V&Y{z<lbz^C!w)CC8Jg1~ikbx4w++_NW^a5SgD<kogiTeG{97nPRe{Q9A8
zrL?p(7WJu|9u@$1Kd1c{)m%y%w>kd+@T*-wHKKI87!&%-?vGz*eYn<n0Rw4;B>w#Q
z6NQB{zBDNcCWrq8cJbG3nfJi`KqKd}gvPFS5ZH?If4;$`K1>)zmAmNdbG_ymRj<Q$
z<#&{w`2H%)D(#}5n}LnBw88<O9J*TGGyvkgjHaoQ6b<0sk8pXIFU3Pi61qs^eI7RY
z`8lZ2lZXHH8Fp<4uO@avAYnwkXAl$XtoRREuik~-?mBP$(cT>c_`<+QgyBorQXe2S
z{<~Ju&z(ktcR^qv#k$EfDu&ov<DeX2unA5P<vyWsUu$%kpIe_FkUEjMnZ54s(z!&#
z|1UFA1^_}gZjUwwc;mLdql$QWZ;TjbLcD`C2)uZk3TcY7&iw4V(`n2OAS);+m?O{d
zO;ohcz3~5U3Fi)Kh#x9`cR`+)m+e_&{Y&)e^EzgeJC?#fUD}1h+ZG8m2KM&$$lPD0
z0^!kNp8pNn8z3}5U<p`B+`vNI;L~SBHwtjT5*!%&dW@ivRQ2%dQE<HX`yEE(DbW8Y
z>LsgZKOca30GWyFc)c$r+_0@#?#8Rq61R6p%qO7svenouZ(cXM+%$Q{zA_IacFFHv
z&fJ&(j-Hum8{T)XfEuGf3;R;M!PPOCEbi<hoP1nq3AX7tMn6{^-Rvz#RMx`d@+vD$
zf$59~g|z`Dw4?v)^s|iO?{qk3z=s|j!L3co%bY2#i#Rnj*ssBEnLU2JGf^6*sTo!b
zZ2<7>Kwox1qW%|8f06VG5Dx(gEGNJj!*Nt!@4UL%WSvWh^@bvc8@diF)y3~1`#r_4
z4K;RYM(anLz{tFU=k(t>zIFU?1l91tQ%7(=FmUOjwTB_HR9T)sBX7Rg`J=j?W;D4+
zJ9j>OUhfwq5!f^s%Nl*;8G^G{=-lm%HD@v>%ThZ9w%IQ-=R>WBJNOkz)ow-bES~K3
z2{nis-2UJRc;(FQyzq-psEbRs$(6luv+AjNeX72{rT@t#7Ajyb{e6nC<FhnQ%iov7
z?|V$xI5|t$9s&JME-mz9GW{*PNHN(=_zu*Y>-v*!Ia&A)F%f{l%IQZXF1aTSw@vK>
zL!ZPhU;1glH7R>9ls;@js`2Q#rk9eG=_<8U)W)p51DL3)Ls<Kyo(djdd7uxV_4A*)
zsqu-41%Rs7q-NYNCAVX>gYf=4;U6?G>vC1=DA}*Yk&$e0+NdKkm-9^pz*>^sqJFpj
zqt0?G?C=ph<;!VdGCP0t*$Ye9IYGgq36(Dv1$Iub+87p=YtjuKrPB@F??FxL9TMV_
zlJT=}Sre1rpHTtn$+p8)lPPYZH@@|zWTJ#9OSYvCUU+$X0r!vZb<^LU)a--kBV)dH
zh^~(lqvS2LJRc5jQ0)9!;K1!XwDdwz_whS6Rg{gYg+0R2c@op|QVn6d|I4ia&;3_(
zPeX>}RW{kquTFgp1b~1)QgD~xV-KzGAZs!RkMxUAb5y+L6uc@SF#srsg^RqFC2X~8
zVQpCfhA(hG0pGyocW>l<ewMy4ie#s{W&sZsX&6VD7x>Hg+)s?Y!+RrhO8i2q#h=$y
zQ)4=b_^9b3Hw)BMu%WD6I_vI7zRVE#>GfqjS}%)ffbVt4@Bt+8G^QR%*MUq1HU49O
zDZp0MZ#L&n_&J?FY}WN;an<Yy>-h_ZT&pZ(+#ac)pd4cn7ZC~n(bMCwT{{rCktnkJ
zl75Wk`Bs+eiY{^PwIQGb6bP98;2@}O2D{+#vN*h1UIQ|;76TAa(R_UfwOvExpx6Q*
zpi(EP2uOyqpg(pcja6QB`TiJ~)1xdo>g)it`zm}}&fB0jeSg+^RY!t%aTq3`Oy1W&
zdbBY7aLwPvu_RQo%M-%dTw#E!M~lZ3OUqa0ZFt67Oixi`@%`rLW4_A)cS4u?fa0HQ
zWLAg`=ZbXiFSAxUQshYObyz;hvYTBvGMYQX7M1MBr>{Sz&B9VCSeABKEPv)MK&w#4
z3o=4zMSViAfYQq0rWS(e!ltalt%qF;F(2T1qf9{O>N@kC1DTs1>K@<K*3#{rX@C7q
z(9L8yp*wOZdF^dIsbfYB$c^MO?SgPvx<C$K32Ag^j!(;|>`Z^>A#**r>pIcWPTwH<
z)C1O&MUS&eTeETtfley>L&;QCVI9wYnVKdp*3pX_wnAfDXvQZ`o`e9!)yiew^(MQ>
zljsf!k41cyuE*|12CxgP9mT~%a)DUcF?xY}o2(eTnl#YXb|FNAg=Ioq%-4CU+()DB
zu|uLuSNKmJ(n-AVvM>t^{wzQ|&^TKR0AeX9mO4KjB@KD_Fbg(i1kW<HqmyX$3j1l!
zSc9EQP_;NhFyL-?B-@e0B8BwlWYUv}p*t4+_v?L+Ljk9;s896!2e$77I_^GYvFLX7
zSTcp`e}uWI2*ji#D5CN44HmU9Cy)Kmbh3T<H3-$S8U)}MK*CqF4j^J7P$<;H2{+RF
zg|;O)S@L^WZ>PD;jU&w1_j)<DwA7GGb^E<nd4)Zd0}5~%9S+`u0apQ19D4KP=>6Ez
z3@7fhEHa>*4W|BT)jDEDnjF;<V!jJ&bMh{&cwx-o%}UWf3#``1|GjYT7Xf5m`MCX&
z^|Pt4j;=1ZYsDxs`MYY3&wE@y#2guyk%46ucy=2Q4!;N79>C+STucfZ#`AhVkUfOP
zWe<q@I3;+$<KxXK{l}L0J5j!Khb1%rPz0NAm$j~potL&A;DF8j_RkSkJjCL6f7a$D
zj19t+NvAz8_ijR$elB|RXTyj#cly+&=IKnVCqs+PvTpXIV*DrJ+G$GuB{$Ex%#-t9
z!Sp!FEpo)kBYQu8-XBLW8H!JTJqN^gfm{ui0N_JX=D|d<pwF`lp2>TCt;InhF{Ue9
zY(~jxB9Wd#3}!J*jAW~6HhXGld-c}Hko6s<@9@Jcx9J0Abn|uZyH50aHRqo6amAUp
z=70=)4mkA6fb~w4kZ5Bg!(9q-rTO_#n<YRt9-~St<P=l|WW6wW#3Z_KyU({;lWceF
z;Z3KKsZhvVin{Zq{eC3V{;ufTflN=tdq74|UVdXA=_FMX+)aRZ$~}ESePm<}qad2_
z;o+-&r?fk;jrjpXznmZ<O^#&rMIu({lj5Bh2UK})UaB_l85O>Mcf9_vJXzsS+kERX
zD7z+HKg4LN4`=}e;hP`w_0v%Mc)M|DcPNfe<9Ldzelbx0RJKO!0=GsTfpE%yo_Y9>
zioK29efIoaS7G4(v2DKZu}wP}-_Lhh;r=C=*8o3~?9;IoocF3*`RK0CuTKZM(v)D{
zzkl|TaA-1n8tFs@2@jhr{gQvwTyGR=n*=d3$_m){y?{cO^q1Rrf*{a*j*pu!U#g#O
zg0uBS9xK)F{Rx(=aQQWOoF70FEM~|4v}>m2g&M;jc@=kh0GGQI7(l+8x|LRx_r1>+
z&A|aVFXH7l9^kn3`I)}1>>_a>z@!eiROa!nSez}B2IJ=DZePBTt*WsCZ8^yWGz#;S
zn-N2;pk>jELaMg`D|^k4I^i$7GQoy%P>dS>(%c`v=C7pZzw{N|Ha+6KePXxV83k-!
zTTXksJNpg<+U7zIaOYtf4jUp8@l~jZ!69;0Oso$$$6#XA_RIjkDH0Ubn*Yk(5#^fE
zIcvw|vhE!*^zfrkccQOBON>@mQ*J>?<HdIJmMuIn+uTGcV0^F5et|ZgAt#gP%2B@;
zX;VL&x@=R^1GtHg4Da>MlAHE+Z~3n9PW#eVcnTKU&&opyeq<cncVe+bZ#nej{=XoY
zvt<-@!@G9IcDBuAeQxIh|AfFe=9{6&H`XgxK1tcyqB}arJEV(yKm0r;vLf9(l%`-&
zxBQxoO(J<SDOsc7)$Oz)QFWD58gX&wvR_|Q1Kc%NuJuaA5OVr&B(AS_#)ssZ0SSWU
ztQ{@q(Fuj>n^$bjM4mwUP()Ok+!1sQiAwt*{WSV6zZ?huxx4||-9o_S)Y^9Vip)2u
zh@2Y)X-QvkiGusi=Uee*N-(s%gUejH70xJZ?Bf4v@2$V0-rDzZEL0>cP|2eRNDI=f
z2uOFA64K2u)PM;`Qc3B~0frcAC=~(e9EL_DhXIBfVyMra^M0P^`v-h~J*?%@g)pz!
z`>yN0?rT>~wZwRLKu&hyPf)(F=2j(D?=7lpDLGEnKidwR<T9=h)@k!U9LSMA?BN)n
ztZYi4GaYb@qzS3P5}iC2zELnnK7nFYGKDU6t-Ge2p{%kQ!ED~MrhpGz_xa>J1kO=h
zBgD7%vxjB?AXdqCk#F&i-Xq}lF6)NJHOgA1)Vy|@{r>J2N@QPqnuo4PGx{+>gF<(|
z?EC5{n^D$%z}wr@mixw!&^)|ED-no%&gq~qQNdwoT4Tp8+*GGP9AUOBAR{a6%gHI~
z_I`Az3pfby3Hs~TGnHf69l%gcvY>6)`3v0ec={A>IHzU64$OMej4x5dWg-`}3$#fi
zCKME0!7N~e9&iV;Tu*{Zzg@=%7d)K=dDABzItSu&d?<~9ULBzpOtSrbe=sb}-51g`
zcB6uVy0X^6{_WBoMjMQR9dtNpSb~%1XKkMdb*MUZ==!o~_nbt)YrA?gW?qY=EU1iz
z!S?B~0oDnG_P*2!<=BpPQO0KzJe8BB;FI9ip>k9#w@bbH*TASt4)3Iw&{?QF(Z?eh
zq_*(gBj5Yqt25>;rsW}X<Dcjy9~cBR*Z4<MQ6RY=4U~a#Xd!>2h$V|5-6Cuo@%L~O
zal0W-<eK(G6_BBLoi?Lfpt+LC{E6!F<SBIu*e41hM@2xH0?5830_@6QrDG9G^gjJ=
za9BG4X4&$i@R^<Sf6(Gtb1gl_rSWHUB#DaacQVhxSc~_VI(g90a9u)MEvJg?l;HQy
zqFkj~tu%qW9QKGXeH-~R1oJ*I?mA26{R<BuH4>^Zdj+>0=Z1t}HNP`Gce+fAmaDfU
zE|EQE2?xw6PKj5k6rQm_*TIWP9QmTHt&JpKLYgA!blpdP704mUtpKe7qm!fkM1<So
znZr!ad&n_x_Z$Y=+Fxp%$Fps_6G$==U44CJ6L!^yTxC1h)vvqUmo5t6y#wUmpr2nj
zQsClipT+Gti7<na<i(V-9lHS0`>E5e=!J?c;#$gk^>uc&*Gq9xsKa6zuoet5qpz#%
zx5s=*VbRZW9W#4YRn>MrYv8)2d7zJI+7o#A@$qW#{K#DZ7K3*pl<D??^zPl7TU2*~
z#YT$b&)x5k#t3LrPy4G|MzY+)EbIVhuu{fwge$q1MmX4Eh>I~9VVsu2iZhCs2U*1Q
zC7~70opS71YPx?m_sWNkf>GdVZ}h9Cy}c;9L-Aegz5MQeT-ji&m90Yv=T+-$M%3=q
z25M!^mFVhGY!Tp8Q0bLY`)o^ZK$26hrMWN^NI8hlc|q21=hi3gjw~*7VBvTgtR)_=
z;~Ip!Y}}}Ej;x1Atfax8=1>-b500!9G~j;XQcvoRD=5^Hz)pp5I^~$aH6OzIq-ARe
zwZZ>k+1X|04P1hPL%6y39l`6p`(VK&yjMQ&t&QjOrihXTq$U7&JMwdP_UBFJFpay2
zIzC<7eL|4;^`4Jp@K5;+sf{P0dDxiTkE%^H<+)wxD_6@WWI;u6<jRye+yNDv^D-`_
zOOut<hQ<8wp2cGdLCQ-hecYBSumz+=PSq*K>2ES&2byXr2YNc02uF8BR_zTOs?u9z
zI=C3xqa%h-YN@p3<aQd@K+eD7)*pdxibjmqnAi7u_Qj$%pAHgxdrxR@Ey7mtr5>!-
z!d5SkGro2OGRJ|IRUdM|%q?mQ(*$XcOE`q5_P!pB=wuRhwMn%IT<3t*ij^vqc~x%h
zRAJk>0~qL0E4<*wtL%J6kyn{^yIN{+-FThk6MCvS2nE>y^BC+sE#}a>4I*RCXINDE
zWR&Y@Q)1E9P1oaTaVjnCM5Dud5w~I)s;HLWObMUW><`pipg=VA^{oTqD718R`Q_!0
z4~fLC`K?EfA8Q%l_;Eb|?*mBlBhb#cbm<Zo50Bo{r*ESe#k1q$<Uub{+sDTs4OVUB
zOhJv$0vbHDX^#z}-i*<~Tn8jTN%5_}KmSus(^<E@-$zsKQRXiXT_)q<z~$d&Sf6I7
zZ<cNy;k^I3CB4QP_%BUaAv0h%LNjA;f|^<hJ*=&S;OG*^1Qj0327T!CnB^1pT4&Dn
zH_bQv*Xup}cgG=wzQdu^ckkCwn<dYI_(8^NS?J3*(dm9Rb*_z2<M7_R;TiLwpqR4e
z+)$og?H_tH;DbcX(MmA?4_IuX2)twpz2F60KN^o`nb`b{e0}ro@0`$6x6l4QH0asW
z>NN3i`hil_@*rscb;#O4CH(xQiw7&Bq8a%>8i+7rDN<BYg58g~LE73A3@N?Z!aucQ
zxVm=YGn&l(Nc6xeQ!so7Xf<&Q+RDmbeDD+b(+xGkfkU@`Thr(Oit0zjU4s`kmVmw$
z*IRIS<{MU{@CJSHmSWpI`twzeCpTylk9F9p0M@{FsxOL&&JZZdu?V&+$ddWN=xh+4
zUI(?W0?7C-j<zhNY_&AeLbl?Jl94(k-T&oR@(j9hHEAa!;Q3DvR<1~IE||C+6m7I5
z3neDS-ZBx2xI%%%eQ6-a<p(5U=%a&+8-Toy1k?ZnbWw6EwkRknao-C@i?e_D7D{@)
zKn6kapUIaQ9IxK#QI11Q7vHg*oG8Y)@DmBtm|+?!U9Fcp1|LOieyoVKwIAS4IYyCP
zpPyNPD7l_CE&BY62P^G8(MrdZN&T`vKlI{n=N08XR=3SF22F^<Y$;1xTR++0K7i|;
z#Zl0OtIO<>9gbaCw59>A<QG0IT8Eb*pMzfpqU|hO$_;$u?42$eslW6-_#NFXSPXL$
z`j#vr@YJobA>2}8GHdg(EEU57CL1HR9KmN&{#ai!b|=}pF(X60Us~cB$N)vX`srIX
zbZMxEd1-hsGZ#2&BuwQ^a$@og_qEc*t8<zUY9OIZN#j(8d#>os)vvEE<m`T1zd)$_
zPHPshe`OfI;cx=J4Qz1mt^7yg0{nuDC#;HoK=fI^jNtKyr9V!^AY>BOtXaL6S-DeS
zg+A(}{h^@<FawbN(%xP@xh+AWC&oQAE|IAmH#t3ffn*tNPx<YueS?~c={GE1#W+c|
z8^c^y<6`KUo+Wq+M4m#BI<}M(EWr8KlP5SKup10Vwf?@4h}Kubq|I9#Ps_VF<ke8S
z^0<D_X5!~X`TH<0pf@n1<xBS)pEEoCq)z==%>1;wts5l5ZT!CHy0Uj}j-Z}%Yldp{
z&+F12XIjRk933q#|18<}3Ki}j+#}E5*beL}UkwR5G_5}^R8e*6&#G`ws!$HFQxh=&
z1%LOi`-AHK^8tM&e90meF8I=eF|z3c+>Faa=+bo-hD`A0CQuA6d@>?((Alw;(uOP?
zA3ks81wIH{zf_sdEBL)pJE&R2JlGadvk}61FvjD5+?)k+Hy2!)z5Ce<bJ+RdhmUWO
zZb>en{ra=_`3!+oXY-Z261Dth31!{=n%hJvU@X`+OpQT`Do$^E>8N4%dqDthYJcH<
z>j>-MQJz*}NteBQUtx^I`HsDpT?f>}{$Oapv<!P!7DL%%C3hj*t_G2KBtL<wTI7JZ
zDaW?|bO0)L)ioI^`}k>5g4>P?dr>6{zpCoLnv^IiI>yH{V(66*aUBx&VOw?>Uu~TT
zD3=3yBH;5-T-(w`<Z7ui-ooT+`Az*@=YMBIEPf+r=QRh=<g!oMoAXUfpHx>hcrD~t
zSd%oe4^k4cmp&Jb$agg;^b<9nTGWEH*`W=^3fY(p$dtQGO<Sz0gztkoFSa6r#TEzz
zO?HL0KL6#vJm^zP>Pvb`bByzP2YFk!uXPbxhrCN?WAfx36u5YbKO+$OAg-)_xtpym
zZ!P3#ACWBh!+PPfz5KaR(!TZ_D7RX_K}r$LJN>#kxf3%G`g5;>Bub%m06PQIC9gvI
z>?&RunvcluOEsgEPXw|Xf0Qb84_7;$Xs=5eW&X&f0EGwbO&de2#FwNT@@mc>o2q+f
z_bKmbL2X+*J<mj5gUeBsE{oguEV+ymJ^WBL_&!}9jUqEw&Ogfmj;kN2L-3r+$r1uj
z&jQ^H-}hsBIGJo~8Mqbu_#a_(gJ*K}aX9L82_;<vva^$U*ZMU^2#Nb5yZCXdqGS0^
z2K+{GHD0ei`bX=r_u{3Qv$xB>w6w0JCc%0@=E+dS<V$5GK-%nd^*+cK5Uyh4JeWp+
zC!gCf;h~%Mvksp2##b5`^H%bbb{APs6j}G1d$E%AjxAQxU&s@GTh#HGgQssDAZVh=
z;7wi)(*DcyHcdMom0ev<v$sITJJHN-ND^BDf-b9DM<HD7U1MMI!0^E}cO1v}XOy#&
z1<T%N?WpPy=d7d;m(?dwIX-!M?O$%X%*Mmdf@(B@NY-kz>E*l0la6DVj|eX)2RC4c
zAxDd)ZQO#piI`eYKkcb-IK=p@bq-@@S#&xM<W4qb?uX2-w6`5_3r->Wb}}f+P-6#=
z;Zu#CCs;JE32N276lOf02c{e~cbX><o!0XZJnw}CcV8A1af~Nf;{H=SEXK@@A*Zzn
zD3}H9Orj%a3V>7;KDg3Q1g?Owc<pTTyD&=tLT*$L#?AjiNAAs*rDn~>ufbt{m(i@<
z3A7Wbq-*3g#RsOAfH$@}3O~A=9)JMOGx8oY+!pRM3-A4e;RGx%l)&YLL{Ph_-@D_s
z^7SKulBHy#1vz&jOtr$01zd%EN9MY?IkWV3kHpDNlQ|^BP<UOfZy4lG2KC>=D1iLM
zbAIlN{V6WaY}b`ZavG*AM%s41`olx|p%C1AZaruB#j>OVhHIZ9eZk^L?{yF?nj9qK
zEOG-_EK8@3JzFu@iB4ZgM`xyH|KnEqW>EclFXwRMC=re(V11!7s3CZ;d`F5Hd)fCB
z#gJ*`_|_khA4>3jlW=*5>I?B9-gx>FvNPQsyz04AnUFK1hsxasETii*h>|Cb#aN*7
z=Dl;$9dG&acy>Q;*+(=m;-5@_Y$TejTQw)NjqBmqQKwC~YO0BT|K@jV>U=sbzm|Qs
z4?GE7$_s<djmPaGyq3e8O<KdGK;nIRt`)PII^g?;mhKN+IkK?`QG^`HQ_3($teN4@
ztb+f_)9ODv;gH9O!^}eIjPK(n6^i^%($YerI=eWBl``;80!u#}=svMYhxl`}c1Rsz
zdM7e;Rv<@A0o%KnU{_J^Naj!X2_a8`vflTn?d(@)o4GMs0ig2ZZ_yO+jsR4#ADk%q
zIpFfQMYU`>^!pU{e(o@UDOA}SezxitG*a~je2EoXZ-CzCy=0YdSN<^_dLPHrPqkMg
z%FfpTmxAE3r{hyK+%KCkB<uMamw9#!g~EHjzrB^1VmOogmr4v!Ln^+ubQc~Mwrz#3
zF1mGdVcwdjA!t9=hDnVeV=uN8n&*HzK7I%xY*Sg<|BdkXx#lqXDW;oyint?NBZ3`c
zNyuklKBc|4fys5MwxbId0+M=J)?kNj6>k^k^S7uDezapNw!Vx%&kRsV=ILih2PdCW
z7}(>weMepHED;lC9n}oC?yMuG118Tt%qa@n>W?JOjJ>WC)QqWF??M;MG7i*Nq39)C
zCq7(keX48in+Dp$q~@i?m8*N`Us(bnQ4Y=rzXfFPGAiB$VGe*FcO}SOI<SHwl$*W*
zG`D?)GtgU&#-2e71NQREJX}7G0BfXT@`~tSh1r%9ZS0@$Z&_&1l|ldD+H+a>M5KCt
z*(>ySW&#`f`0;MQ)K0UbNjVPa)||u$$#)<j!oy$G=411Yj%rU-qDpziewE2cM^MR|
z13)Ke+seobc1k#PZRO^Rx@)y2Ji<WAHpl?Ut^1m82lR9F+xQ?LRcF%ly@9P5h$S(U
zi6ni0{6qKM<hsCdJ7#v!T{|xWp?-l#e@!m2RAy>H)F5WHB+%hS|3>@Fw;JS{nY9}w
zle*b>g|uYvZ|Ox(zs8`*lJLO*pshLf?n-ZIVcm~SfuQDs8JLjw%ecAwKNVYhl7XpF
zYIdcM2tUsvzc885jsvQZVzk#^`h8#7{GR7T4gc}&;*=tXSB4P#X<VR}7ndNh9fPTz
z3myWSs}tk8mT?lJe=lSL<NfU$qf*RB(^b`}+J`x^7g#cuGFrRWA~ZfUbBk+!RA`q^
zvyQTfzw5{{Kn+hadC4U<jKgsEXay8>=fvZZnLjXF3tg--%4MF8nBL)yBsnH`u9ws$
zir(1UHgyjcl=y+f0?4qFUF#}qF>XfZ&j$(x>6J8_23iICg&c}gX*_mzSzveUT4)7u
z6TQrmFMyNc<4}$1U+d+~0L~mP#h$d%YcFbIb<@8}b<LT_Tgv^{L7-!YYWJf-Kf_==
z<VfeeyvLvj%3ElUh=c~8UcHpn;XLjd7*&}Ilt&u`c0M4c&HmYB1?SI~DE6e<IE&*!
zfGrg`P+kAhqvJA}lmiN)CYjgm3sD!19`~#;{9Kz7T)b=KS1yy6r-8TtbkRs!RPx-+
z*)DC0M+}ZY=Wpdh+47d}#KP$n0Q5k0zQ){?9}$p|+o~XeWBS0d7=uI(i4&AmqDl}&
z%M9xL^f8#Xns$XQ5O}<OYw-k@dcA`y2*k$HNHX|2z}L~`@OkXr1AOnIH+@FkQK&68
z<a|lig$J~tG#=!ckG(KIf*$;BGkW7y5Rg+fxJJl-iwilr@v{0>vkx2;X~1eU5vJx6
z<k;OUCLu?oh`Fqo&2->&ymKr5+I`M_7*&gZnUzJxJt1cbE-OTHzJ#2T>8^wC_AE;x
z1A~ljPxc}fMOc-wNF<o@(2+W$&}BAJtiPD>rF)e06JfPz6Z?RtZ`<)jdyjM74l?b{
zJ)XvB;O0+Q=mxw`PeodHf^2O?Ew7ts**ibV7UgaRW}WGG<E8M+B^$sxx<<i`bk!YR
z`uPiZ(<K*i`mz2abmMC^_HXY5*4ge_eR;Q+Q}OY_s*Z`{3>h4({RXO{C4~BKM_gH|
z&Ut#{r`3FHy}m58iFZvM&?{DV!83?~em>#K=Kf&amx_?6tJIaaNt%B9EN1km`280E
zt#s(vm@;T!pAbD`Z&Y@^CL_}*?##cY?#pWF`Z9iWR4B+MmATIPWy4i}O?GP8`F=m;
zqKbi{`-&HMBoW%ArHPvTwkqJEX4X)6UciJcL^q`=jVG<|yzzQyN2+n$tEzmTA^Zl@
zGhei#lwk9!y%%|w$op74g9{A^&$pD`=tu9}qy*u4HkaZ`YO<N@yxYyUAwq1=A5U(=
zNfmBN3h`EIP1d&O{Jyqsam}jrZn}^Y?R}uM)>#6J;Bd6{5IB`6jo$atuFeCXUpr;^
zU^eYNmuXt$1zX!j?6Vy%eo+~kFRjn@H9$7%zZvz`f<IGR7bHY3$DF2@hbbUJReC@^
zF&_OjcLswgE?{OHWt^6Fh!?*9jbhWS+45CHS+4Pp9grP+lK^fv6dNm118@1+|8?pM
z*)<D?K5=U@Wv)lXpF8FSZj*_t2}vClhx-Ev`XJ0x)xdUTJvyeETO2W1L#gU)_Vm?9
zGrs7oEWfwsdiS~2e7|O7?H!UE@&ZAXZ-4_)+!~>L)n)pUydq_k0r*c(&+Z8n_v8AW
zH64KJ_)g25xK}hEh~!-g(5nSqEYp)@d-}xgoYY27g}YbC9<Va<j<Mn|U78SfDz2FO
z1Hw&zQ>B9CnS0?!e~2R}4!XKHb=Bhb_Z62vWWH_)3RHWOwWst%HD!GQEaWEjIRh$?
zrW%HdS-1SE5eB(W(JhIU*8aU}h~Z1mdrB&l)%(zcm1)0D-VugWo+w6Mf!i-35uzPV
zYq{(^qg(y^J~u3?KS!{(0i*oc_r2G1`WqPw$rnhl&lgr;fWkdls+d=AuG9Hpj_T;n
zNhd);Y-7i7shM?qAvXF7*}QLBN99_U5S1&=Su?+FD)5;VVf7llM&e!%LZ~AIM`So^
z)mQ?%SSU=o(m|FwvA@RrAmg<WRk>Tgd+RXy-F0qo1q~1+JGQD#g@O2?DKtl!)brG_
z`rEKYk0C8^boRT8XXO~`31(BED&Ko(c6MU$IPJT#^?tKd+I_tIE=ZX@#hkf#T_&E7
z4Su0+I{5hrF&Vt&5;k*`>%;a6bT{NN<|tx$ss`ONdrrxHA(@P^Er1f!3;v}77zWZ=
zxF~u$mxH@*OEQ4bC%5w;NvyB#i$|{nr?XRvfcSSf88_nF*h1CmsSL;N>sw0|`*Lqd
zajLXV*vV0;=}5Vf;w$nlVXRWRLn{EFY*`nwk<NrUc60vwGC*4fk1BTJq2rVp9V@R`
zIBDm)`>F?M0)|A3!=8oSq9_NngZv2G%ayO70_*B|O$`QL-;9n14JXq*Zn_#<8+_ar
z)Vf3A*XkJWdJJ)s=MGS3%E&Z4Ym(<PY_+}^Nq&Pad;}g)2t<WNyi);bimtUgwpOU&
zWQ0i^qypeZUiGH_fmN%$C<kJC`H0iaW%b_C=(4nTpqGV|IZmB3QcT)9ovz}y9Iv+x
zS^A#*q{%DxLdlo+k@`I&v?5~1&Xp#SkqnYa23tb&u(%}iVjz~cI)gs?$WFrE_hrZ7
zu*)fQe0}Mo%CE=`v&<^?Uc{Dx0`<);`8R|r&?BN^v2m7(`*XA4^mLS3Uk};yIi`Zu
zN*DmqnDy3YFkyfaB_JFQ5^+Gat`(LfSSBBPzC^VToB#EZwLZ0CJ(b2PE$u7k`rX)G
zpkGUM$tXq$X7w&+e-YQxTdpMsHcEPsZ{35|6FtxmUcN@1z9~Lg6}xz9j#@46OCAI~
z64ub?K(*zH%gpOF2;0LkLpu$e&B|9)NdCBU`-Rklv3zwI*&i=|kKX3!hJobCTmD=E
z+Hr6lvxjyIsznXT&Wzj!;_!e^V~Y$YzH&&Ovj&^i{ZG$6$C!wqi`BcimUe_mFtY6j
zx3Wp2VC$y9jM|c`_X9UTFwM&W@mpkT8~N!fYH27v1YsLD7*+|=%SnRP;H_$(VQnTc
z8|NVxWfZnp2DSa}p}hWEVE`w^TKIb+AGC7MO3nJo%K~s8;PPpd8VN_WoZLIofy;l%
z!}|^a@Bw^dNU_AuwJylx>b(;SomHX6%(exAtq}YfFlW?J{&0kO;Z^W^_NPDOJ?Sa4
z$qCUTZj>?|pltWwsQ40+@qRjB2if}D%p5!uX<$XxscZ8)oBEZnCd6Y<j0h2z_&`H0
zl#1`%hEwe-4Gq<fqXG(eZ6F^WM7li3Z69B5(S9R^BmnO@@jp2=+>iYTGS<zOCUps)
z4K``Q@@%vYfCemBtSgL!z-n8Zw%VU8Ee$WYj}@;6telZMY&v{VU+wSwZBri%UF$<@
zyuW42k`ghUqB2}~B{Uu8{Xvmhz@QgM7w<~E=Su9h_GQlDOMB<N_)*!SmgR|*L9m~v
zUTlaq18iN&cq1ouN)Xl}hTimeQs6x@OhdEJb)8A#FBOE8wBpsRcJ5W9k2gUCU;m2l
zN4R7vS^W*%jfl6J!bem1XvSEVQlxl{adBFw-zs|gD84c<utWkDc=-g6yFgVliF%?`
zG1wlm*VaM461m*r1YW914Y3@QXhnr%oWS^hxy!QoP>%u*5xp!IsqxjWIi^<W)lJE=
z1NxSaI0c?xOU%P*nS24V@7siGu1DX>#_WS(+vuS9+LsV>)0CFS`aoSB6d)0$KiHK?
z5Ck{}VGuM0Oe*&N20hhLpeGMT`V%L44<(($qPz>eI{pGZSu^X94laqxQ_*;z2K|<n
z;KGeSZ!~9pC8pE+>=bu0O>C8KrDVDV%8ol3ck}dd(V&lZkJMrXR?mfS=N1|(%l%0z
z#dAOa5yC<i;dmT^auP@^e-EhQBLO;dSwa3gC*~09jv63SGs6GuPI_7)K#3^#_wR;g
zRCM_3Oe?Xhjbi5|e|2<>&5kKje;RE$71Rc>mHl8CB~Ucg^U+8O4CFeCUY&fRrrQn~
z_<T<NTF*Z7qn8JN0msYm;9HDPYxpauaOq@f(Vv)vi~(q87bP%8y+dF6YvrTPJwlD!
zF?#nzdXi?0z48NOG3u&Ljw^#L&^qEiHNtB)aW*e?<Qz%C^cunit*RN7&^wCc`lnrh
zkz+HEKYt9{1?>UI<a=)KN2P_ved89XYWw&uh!S$HfQM?sjpwg&BcRY|t?_8HsJjv!
zS{>ka(vL5uQUZ;YlDVC9>8h$ev8Ei-GQ5p@Mw=+Mh<DQs9g_pC=hwbEn<z%hqLs*4
ztPDxyl}2W|pt}#}dSDbBsy@uYCR9|6x(@^_mV=#zrPfGl_`S<<EYIw#jJ=7z^H2L?
z^wmwJy9@Js-lHWsk%NcDbbRWfQg&g+E`nlLg}6xQPjGWBytF}^jpwIfzqClU@yu~8
z2L})*o8mUrGuUv%xdK%d9Qtg{zP$HGo&$)8CYG>u11g5Qc{{J6XxcjuvB#hx`$Q^#
ze8V!w>q(mP{$PvD7#QbnUtV?M+-aV2^Zia@ga{#YWxmmiKQwuj)js3yE5*#~_GcTf
zn3qe3mAe)6DMO%su0<v>zF~I}%BjAdP_(cV@6_LXT(hCrusg%iNeuer7xI%)g<t3C
zVCRhzf1FK2@UUPQ;g6H)B#ObGAS+2<x<rzY&*AS8FVHrNsJK7FF$r7nMiEx3aC-Ld
zFz+*b7KG?SNQw4h+V;882<7%r8rSjkoGFPV83#`Fq94f{ZN*_Mux5O2(GTLLmsj&u
zVaaGEe<FVhNsGH?BaAxt_G)eL)L)6;X@6;ugSR9}>QUqET=u^PnWdLSw~XQSC!tGh
z+`Kt;wvr<knXDo;9|u)VD*^g~|5`N8)Vq4N9X!Jjt0p3L*l(Mf^D^*{{2Ev?Zcs=M
zwnp^VSK8R(^ej(2rRUEX*nE(ezx-Tyj2-yO{u38f-G;?#pa5@rOfSo${G_q+0oOl}
z)vg5Z!QercWv}f~nc4K|ri!kfDe`0N)+vlIJIRn1j$q@l^fJ<Ht^>4>ygWV<Hl@z2
zGNuDG{ySYo_bhiieOXFpQ}Zron7}J5N6!u!#q<i#0(@=Zr{77Z5)mZxE|hT2|DkGm
z`Z+fb9(h@X!)m`dFpovV;{L$c<7Xf~J&*@Hkg+&dzs2{O`>UnVF{W$B9by1a+xnp>
zuK9g6ZRxkS-)?A&^AP-OW^gs09JGmZC0R`Kj^F9-tN-crJ!4MUB}PJ_ox>_mEQ1ft
z!<die$y@g~L4N1IN#kV7^HW8gf3#sIqKTR~QMx+J+A|=)F%NsF>?CTtdd6&A#F|uk
zr>}I}SFctUsbehOZU_arv|P6sxb=KWmZ>Iw%X>;DXZ%yDDUThFK?y{$Y4zauozrH0
z%QLMrogMYLE#KY!TAvjl*K1$>(h3*Fc=Ay{TjST|j16?}J};(^z0CggPr&&gL4?vf
z+e;!vWsiZt>?!OhM;f&ZbuvK;7M2%23qI&(m)`G6V82|>P-BA~y==JhEo&)FEU;t4
zY<g>x0-QNBy;;FZuEZd-WYZK)!c!qo{$UzbQ=h)(O3%d8tv!wD{ht%M5_({7JkHS-
z`L;TCUkm0Ra!<z9;a13wa44|m#bu{q5RfBlc6_CP4py)K9A37l?&o;ihQ8OM(ifz6
zKtfSt;w%UJTYtz{x&t;|^<ErP*eIh9z8j;y&o>NE?U6ONB{oiwOp}h>;A=VTV82ww
zQ3amKyjEPdr5RQ+Lv)W03)4InUb+h)49#VhfyG)L$AtUkfCLF?bxXhwA70j|bL?5%
zUOCa+TipxghWqX@KLSJ_9r@+25Pzk^gS%&LMDU!Xt^mOAfa<HE!(`diYw6m_^}&7B
zA));!Hh-vvCtRNj80NQt_ED_Nr=C>jMxshg0&<XHqg2u>KFu^Aq<r!ny{SWkI5fHJ
z(NbnYnM4T??#>59TEWJMqnQhrK=bQ_NDP%nv;T2jZ?Qs{L7#i!jj~Bt{hCACBEI~d
z#0+-(7c2}6B>U#N-N^$wXGQcPk5zyhwcjnj3(BPw?`Ck;!l+Bv2u7B1C`>q16Lnvs
z7i-fL+}&kHTn=d1JuL`;EMe2Ui65v}(b7oeWffVolEZ6&4D#-MSD(wweG7odG#yMB
zz&5cm=Dr5meP4&PgMwzxD7m<%OzNb}-GY(88MKtVTLJrRvG%g?eoVSW1`r_BJn{eN
zFg)rkAN^Fq4-a_67A1s~L{f&?E76qG9vSiE_zW$84GkyEZ+pX<|H@OACjhrP;Lj6F
zYCN}OWvh<^x6E`s@97CRH^a2>kJT|P-71HyC49;?T1Ca2bUs8D@&T#m4URTYum2FB
zm1z##%PLal#_BYy9)L<H0GsCVHzkckB{nt<+r>Ce-W;O<ngyrHGBcN%gwmU_>MPFV
zG9uyrge$tU%&$~d>9P;LlC>#H-oE=X5i~UoR2M&tvE^ylF2!L%HbTwJHIlF{PIR!-
zNGW?bYLT|K@1_>lLcU97IGaAVI&xpjqvDi;YLCQ@0!8MKPGXp9ngqy`E^vOF0JQ_j
zv|l>z7?O{6%#{}f<K3xN?-VsR{kVN&sbJtGpa6^mI9N|lFDrtTjnw!eQK<lTG#?%)
zF^*?tVSy9(D0N#b=2TQD4M2$th*{hF`(MDtY6}GAc#jY5fVx~R$jL~=GO%myaT}mi
z`=<Jzu?Mop)w({U%8B%ar1{@>|2@_0{{~XX$o@SM?!V`9{d@e~zgF?DRe%5vzWzNF
z^4}9M|1(NQ_V00@|CNpX*DC(CivM3$vEBpFUeL=-um}z^GlgE_{b^OP62ZwN9Aslw
zy{>*Z&H)g@AAVIx_nDHVjeP8;+x*YN!wK)b9zH+^%r0&C$2+4BkdVtg-(FX(G|=>a
zepo-vZ0>vV%+@wh#NP~@AbE0>2S#7P3{t+OP>aIRC*9V8w_i~Eqvv9Bxm}HO<*^Db
zQ#m0_XZQkkP!9rVodh8D-(ehCrBX7jhd%xT*xitwDH$$qsKaR9wFRGm36v@+DE#$_
zqQs=cAiPhiDaX*oP7^=!qv`u6)I5sRo=w=OE3-6(wmAVN6X;A0e;;{fyBuE)fl_w%
z@adZ<dZ3kDEs_8hPoh_l2(_eUCr?6tMvL^R)MTvm(T={^8mZE7xoNSrqu})?2t2D;
zz1Ca(&?g0uAyXE%?)joKs#E|aC&e~hLy@r#(cHluJ2kuET!lL4gC{b<v_Y}UHNZiQ
z@j_w2ABVo(J{4u&q0kJxQx0?XeNrXg(|rdC5hXoLCLLF~<F770eNfB*K+?5*`lrAa
zpv~j#4d&&k-s&2IW4}mcJZzhAPI(BBaS|7wcm3Z9G6js_R}Xx&lle~Tb!-+<tc04B
zCrwok9ll2wq1GBV2sNa;04GWc`8hZKu|B`xT_4}rB4-&Gpf$^{tP4}H0An)V=r(DH
zNrw9&(FC%ol_g{PIeS~sun9u}n!DmvDErk97u!0B@RFW9P&^Y(&-NU5YStWG3e?pG
z-a{!z00Yi{tGX0)ubWpf+-fN`wzy`FQN49bK;d9M8zv{Qlu5)pwK)01kF+F&n8dFK
z1w4bV2*a{VhIRHa0nwuNxurE95O0eCDp2T?-r%~15FeK0293$3)7i6H=<=3!eCTOM
zOKhjj?ES0vubzAG@H*YNDB?H8qj&o7Q7Z&PVRZsm!ssQZQaWu!HpU!5uz=UxnYtbx
z_Gay`aOWE~{mu9z!JZTAn75B_#i+5*Z63j9g14-e7NnN_(qlUh`>LD=fSg82`i-C{
z3?eN()2V=?ux7LvTN^lCB;i${aq1GtZw}ReN4`rFk3bk-`Y1e61D6XvJ189XcRC?n
z#7(oEu`8n%P{H*jwT0<HsP(0{V6sFf>pM77uD6}Bsb%f&)xII6zL76De959^9u5U3
za`B8PZ8cqh^p5yWKhDXZX68dT1&^)mo+jxYt-NgreFRv+78Z_%0qH^JRc<dv;yww4
ztquAddGE>)7ET6_t43YB1|?aJb0=NtGY4A(xWs;CH@-6|o%vcyBP&yk@`rcNn>2(@
z*OyhWKB)GcySqp`va-~GL6u;l_7a(I1Q8E~VZsh-$Oi$$qUO`wASu1#Xc_5Z>7qUB
zgk~>?(20HTVZO*=mY^qUralX}Hqm{Yp(yo0-Ip&EGz4uAho(`t-oXYIW*zlX{Z`!v
zyWtsZj+@^eA08&hrx}(aFt4#087yAnwt}1jdZK2-ns=x_X#w7LF`OZ}Yh!$thDltr
z>g}g2)O!9odWlD7bm56ZRmHn)7%Xv1t7yh=?t!h1KGtv_;U!VV>M|A&nVj*g(?z6V
zHG$<k<~v{Vq{Jj6FQb30U@PYV?Rabd;uZLZgTJVlZkHvSz(-v=U4*}_PIJrk^D)B5
zzLFW2isacEaDAIK1@|f>#r7<={W-3Pt--ds=6F76_oH<6%9p|Iy}cN;qwZ7f(m(!}
z9Zsd?<6;fhx6QPrPmsQIMubQj9ayWf?Xm$}sSd#&5jAw6{l$Ny8fH>2F^sMI#T?|1
zEh5?Pi%MC&)I%b7ID2vMv+^*&;nj80fBqFw)+}Xl;V5(^{Zh)b1$P0fZ6ANh;AF6D
z;p|L&wxrv=LScp~eeLnTl<5a#^`4ZKBb4@jFdXR{+M!384k@ng4PH8VHqu}SW=Y|Y
z1z*4L>zPj=qhBQI_iLV_JYLHx>sUOEY?8J<@4fCFQ2y9$&LGcLucl$<M{6LVy(;!L
z-75S~3^<rkl#5+LuBA~%8?4B{`)D^^@KDjCEgTDUBVwmajLw6_ka5&2MOikQE4tpf
zE!!Fa<}vJ1pAsIHPREtX1>;2~tBha1Q9$q{X9mG0Ffto61u=H`=yNCXyGvfNx9|Qg
zeU~kPMrY_btGx*#>|7J_w5RDki^ci4tTS))K<fW!1S_jhqO+Bh09<7Vff(4nHY~FH
zkO8o%k+B<J{MX$sBc0o}e5MgDpQ5QoO#3Z!fBzL8rs9Ymv)9$rlqH!9`R+CJD%H6E
z?~U8z&N{C=(vAarRsOy<G-Voln+c0xb6a=Y+9}HzG~Az-F=CH}xzx5Qb>F_ll)06Y
z4ZMGDy1z#>XxaFTGc#dtZKT?*{ry7vWb=_<Kmc~3Gr#}uuX579{nweKbe0B1*1}Mb
z0!F4HL(N?du=noLoEyEz1*b=1kEG0{vJy$Fia*&Y9}aje64^}jfhEv0m|wp1x=LA7
zO6XaIz&YY8%P-)1wPC93*F0$$7_&I;M2y5K3v~4q4F$t|e|ea_d{fJu2F+@0YC_s7
zHK)TM2$k+tTagr@^%$`e*RmZeBzvs#H5SIK=B=kD)qJX|GaC93NRAr2!zl7%Z%S<T
zY%f!`c|dsTvv*%t$iVBw)*J3)H@5@}LdSnL-|zZWJTw(5g54B2dOryKh=1Ve6{;1M
zV&EA1C3H%KH{uSf;<2c;>=_khY7A4$-NM8fjrh)oy$w#~YV5Ji7AZwc0TgV?XImjB
zZyjb*Z<|X>Kb<|($^<_~c##Il)c`y!$b3(bqq9_z(w%khwI6rJTQxOLU&Y1nUqQcz
z(hN3s)YLR=Jopg^`K?tHbhKj7LH%)FQE_$akTovmcA06Js`t2?r0H22n!9Uu3%?!a
z53HY48m<GgdN1VnjQ<3`t&6idJW3J<n@M>nIZ|B0d&Hu@w0b#d*}?6oE+9i>XW`_=
zom+*ak~@TB+>ySX8Fy@FZc*Y-$I~Wx;fLa8Ep>d_XY1MK=F_cdO=VB&hb@m!di?+F
zv(hpz!Q-6-3EPrI#ii9<HZiX?s#$h$ld;tt)rGxB)lGz2SJkqF#(K-VMS@_`8mn7S
zfMFOb(zKS%@NA1Hqpv6O%UJ|lW*U>MIMt3j$qUujvqAs~uy>Hz_4hy>YPY95pxP0Z
z;4BgloD|?x>6$vOxwAw$N-V9{$T;`U2IP4B&6K8}fzQp2-(}W3)6QZB{%1%csh3^7
zMW_sYsaw*kKcLcenpa6_6@BZ3B*EL>N^fMhS@E^{80W3L*EZGEXi|or$61fk##*x}
zceiLHw*5g-6sScEzB$d};wv4t4u?uGGqXA1quczq)Q?!kMEh0|<=0s{oOBC*a)M}d
zNuip!vm;xG?2+O9;aH9Bc6+jWTA8D<oGc`wA|KNV;VFIA-&|>kMn?i&cXgt(ZF2Ku
z94kwBV!q{S<4T}QsXmQVvpPe~B9~}OyTeao5Ey7q{8HxMK8<OfOwC~mSbN&@dBHsq
zGfM~Uat7~Z%IRoiz+LA_!JhWnhnME!Y#N-Mb6mV|3_MtJAa5C3pg~SW8T;_W8`*OM
zsBQzlY!SqvPesKM@BP#se)226tC(E+7{e3=&LXQ>=W_pGP?gW|%UR}#UN@~i2zuh|
z|L$QCvcw{3e6KRNVMeCXX8Y$?Iy@7I%^=)VdKNRy=?6e^VN*?-)8dAv6yZ*U0z0U9
ze%yq!2&|f2S2d9(_My2X?|1C}mjxp8#u_B8GwoE65F<ti+s1r~P?0{HkU@`{Fm(i;
z>L(kN^?mNN8QSfZs!DOvR!%!b+0?3Z<CvBYcP$-MPCA>5<X(A{lD=!bkdJm8mSj22
zt=#ta^Gg!){asW80*8HDF=f-yAUIl^uUh~;1lFK*pQgBMrug$q7OFLtKYCG7yH}xo
zUW;)?A3q)x<{~wM{e2R1TuKd648Tai8ISaz${>mVZWTiq9RT)!A3uEqA!lLXU!O26
z>|s38O9U>^q*2B;2DY_#AykDFN#NgG*<#md7G_I&J&)f8p$Mj=UI{N)+4d;0>X*lb
zbJA?eaEx6;>c($Jin+M_&@(hcCEx=}4D97=D|0IM1^>2NG$<;sBYa$`@`A@%t{nR-
zCP=@zLREwGUmLG8T|)M#kkX*WMm6H})cxcDr<jM>Jg5#6ji$L@P?0rc$gCD*QciMb
z19W&<_d-3xncevO>Emkp34uj~F$ip3U1^xX!|h2*aJT~L;oSl^je`~K%34?hVLhuE
z*Gn$r?`0?HuAdtX&0vH`6^dRqdQbj=vv|2k*oi%=T9d_FSOLz<<iG;O>q7g`3E<5q
z>RwEQc|3~&kum2(-CqTm|IanBM^&6{94|HSBo04nF^bRPZ&r4@@zY09+oQCbC^;x3
z4b^n47{(dEd$%Nog%<Qo*H0>p_!}!MSpwINKfXmfdIeTozq!VE3dz;1^Gg3Bzn*c!
zNp!I=fAsLl1MUuj&`#gfPI`$cw0lrLLjjnxSn%VIo0Kwi{Nv6;VQzxn{Vg0$OCvH9
zjne&FL}9}TrE5HA?9*F8hQyx}EJ8HQoRC9QFFTVeTnle;ZWXhvH+FrJTQ0_X;kjQ!
z_mt>NP?>mDtdO0L4jg}t#wj3IAwXExw~qeC5OW&mj#36A8pHv5iC?F0s{8_)ff*0G
zEW1U*CB`dREdzAIg+YSkCL^jW%gi+xHT`j-zE-P9HXhX!^pzV}Kkz1o(e9RQ&yR2`
z#zZYcLQ-Nzy89?b*23diw?S$$*VkCX(vkOUq-fGMZw-RE2WgXMaf<nHd~=M1?|JOY
zK$gumz~|`tDKtHM2fKZ19Wjrkbzz>z;yeplem)-$PE7mdZa(uqR28yWj@$Or@e-Sw
zSR%J`f_t#CLeREbD$Li50X?{YpGTrHDZij^crvp8N|DosA9QtecyV)~i5$FDYoPq_
zzP9${`>VxdwQ0X@xk#qL;finGz}w_K{0PskeCi}Rap9I*6^;yk$gteSwLD1E8>X^0
z%YOM{sv~)DaMi;iR6b$8Z$#?SBM^=B?Zhq1LPrI+KlH`b4>}GPa1RTerQeUqwY6k~
z`fD1dx3HENq%iwirIe-37?S*&icXzQ%nt%yluC<a{9EG!ux;C9=TaA?@uzvVkkuO-
zaI%)F*$H#V$>B%gVz{L6&747hokdzIiNHoR_^53|Ds`PBtVSoMRoK>wpV!pGtd(5p
z5lHsI`--~3Y~D6~glve9o4CMpCNfc-RDkGCJH0uAEDS6S*M7GA{?b0x@NPF4V^Th%
zNw8l|e-N)f(*3&1VRYnTG$Ax9y`#St`{YO4FI1I4*YXGLF5ofV?2s~?<Q6O+q7Z}P
ztw$aInL!b^eMz3ld>H9_Bsyy=p1)tcM-`|K$pNd^N96U?%53u}dyN*}%a}}uI3%Od
zlNa6x2m18nG_*tV`r^iC`%A_P){lLc`7f`YD%JQry13dW;e?zZZ4S~yHDw<Qdm3q~
z)8ERwngd9>lH}aY(9DF!#iUCiDbP%~gYEO@Rb{Bt0*k3q*ku(7@16;Dabj=Udtot7
zGilaiM%{h`x6P>)_$bH)d_>Qdd|d4AF8s5bMn;6Vcz!BnWu-G5j+^I$hzMSYo{0hC
zP}6z10-2EWi?6A$R_Qzsv`-hkyQpY%8Haw9aZ8cJsUYi<EqM!}1K|_|0*GJZ`SXpY
zJTo&1NVTJ1Urw)<YWCk7L$d2A?iC5YOukd=ntpzSdAuIY8#Hs6`NTFI1p92(lWJ>d
zmWGWU7aOM;#yoAnWf}kX%8TH(_KUx29Y&tJ21T9{Ttb-5k-C~vEvhj>UXCo6E<=J&
z63Bwx6qF{QM6YUt32elOT^ILi^-1XYB(<ToTmBA1caMmMPLg80BTOIzpXLNx;urHC
z;roOm=5=~AAC#!N)9;c_2g?V^a|ksBeqf|$<Bw5`lX-$}p?6t-ELsn-)iil_@BY2z
zbWs&?@T~5qK!_zAyj^dprf1SWV1!?8p`edz3LHXwI(iS8Pc^xQd)-@?9c``GgH@zl
z2Ln%X!a}JdOY4VGXS2<d%{fEJ?mr7SYaa=|GHB-TnalVq*&t$`$LhVg<z3W6P*FHl
z^-On83zE`c<Kdg6=+EDjR?Ox$4%KbIB|L0<E-Cv+6d_<MVO?kjMUQ8IR2kIfKw;!a
ztf>Z~)C_W{aS6fX2NFZGi${pBjNJVEu^?HVG~?*BhrLFlc$A0KtB6HV1Q{uL_Z^Tn
zcUs5tLGi<7*KgZ<0EKp>>K_}yam)`#>img6|LhOvN%U^R+K^b{Iw^<sKg3=|1u0r~
zocW<((`Ylh8NLZt5q7z`SIx_7Qj*DZ;w_#kCC4YJvaEls(_~p6&QI-38&l`}Qych_
zpEF=+wl^t(=?s_Iuit~QjkEk37UZU7v>BY=QF^qC<b2zC=fmotUn?8Xvhml8*Dvtt
zKk|XqgoQbQ38|b8=DGooR1gD%4fh6lF>I@9XC|>(Q^)j&#AL!qYmUi9@$XORc<bE0
zT3AYH8(MB8t*@Fs0R>HvSI5f^YJ0nRjU*V41@QzC3KCfv;@Ve1uVN%ewGmv@rn|qt
zBy@vm)jR!%)e+qes6>&zFV@N=oGiFq_NeaIkNv*VaTWj)yG5!yzicX_<+?hZ&iwhG
zzNM4i8T(3?v)djWHZ<L$lJF3Q5>z+1(-4r>_Xw6h4pzUo%t232^XN+DD4m;Isr2;X
z25f?swDW&Azv4X)D)emcW!?*H${B%v+0)^t0Yuakmfy0pQxEvWKUU|3-THphy*<vm
zLm2JF>?QWTcG{9e53l3OE~tlhTSAN*6{)K5L_5JGArG}Ui$Kpt>z$}kk*$@kos#jd
zrP(nOmo6Lcj$L479PaIX9sAmByr6A&b@<+5I=;{IZk{agY2Th0U4T=~1}5g!1NQB*
zoq>Zf3BPc`cz|rO+I>qy`mDf%UQ|#=b+%cLLy&7>8Ml5A61biZz?<C{;q%2#^n~3Q
zX_H3x2tN8dU@$Z%&eA9caLYkS0@;0DfAc5=DV7gFBT)VfR9));TuMEbMiJwVVQ$;1
z@evM@7a-xJX5k)2@vd_>G=w}1#S!np7V&njUc^L6+vby{w_!M@!qi4bnD0c*4x$Ar
zcS}*hVWFIv<auF-E+O;Pypr2Oc6)ME^mp?$XB*5S4N}TltRc1N@eb}NCtsBhBt$}0
zGtv+^6yPanL9q)gAA}<dU+WfnhP2v3H+4mWcz*>Vt|^h<KwG&K)SHYn6(BCG<Y-3M
zY~6|&wgZmawA#Zoy)5-6cZz!H2G_Vr0IDG+r(xg0u&~g1plv?DVf%xHN`J8)@c3Kq
zE&Cl-pf=lcGx+_FE$Lx|R=4b+4qMjNLQW>{%DytfBi6VGl>7S8S7g(q9EM|Rbxe8I
z@Yp>F1_V#<wgn@$pO>(Q9PP!ZeC?STi|q>EqB^980^45iO$o`H-Dx``BPP`=dD14k
zEB0UrInVYCVjSN8H!um1gF__}wKonoctW*_w}1nadVj;nrLfr5JA&M}o;|1aX{$Mn
z>%e6e7JZGN>YIPw)82F*+&EDnc3*2CB;E;fcRm+{V%fWc#RN~4^iJ;Ro7(9=uR{Qf
z*#)=@sfsjD#~GP?-0*#wBXe+22=J-f7)dPw?Q;?d7Fn1X$xO>L57orzzqTCcUuh5a
z?Re+*C<8>x!vLJ0%8fr=F?wzp6Q;7dJ0nY@8ne;lq80AI2{so2)PwO!x@_UKhT)gs
z4LN=Er6STO`%t=;O2dZzJDkAfeuByCS-PQ<BgawD@A=fSg-oi5f$5gnT({=#xWq(d
zV3dms`k>ZS+8xMffjYa)F7*q@Wr$C==Yw*X`ZheXaC9-CZ!~?wb6<vlJpMsHUG*|n
zBq*cc7xQV@8WsU|+DZQqtI6iVo=>gQ6HUuR$&<xzSvu2)-^gJ#g6g)51QoR_3FB*d
z5K~XcY^!OiBGO0U2$h3EY46KcDgaA<cKES+n;-yh%(ln~jxVd<5p@K$Wz2|`o-H)p
zZh7X}^nOS0L}lygy+PI=n#SV#Cff$ZGbbybA7XRE)p;X4`=N&75knbZ;eOxC=afB)
zK|Gkdp?WH40U$agut}x6=a3kH===jMcA6FukKsr!^Hf(auxq3R-Rh#!A7Q`(OBLAO
z0~KBPohWTkC%85Ttc&wroAT<0d`f;INlJTGK*EuV`va~+#@u>^$M?C8RbfcM^Ofg{
zdDdSnGMjkl_|+R8Y8b%PaU#%@jrZ=olar@k+=*9|?)HC__ph5mK8s<GsKGlQ41W<!
zL;!LR*)sR&w|7bx$^CJ^wmhYqY@jLE{=QIf?aJop36v5{+8~-uVvB}6^AA(Gt@)7r
z57P|?PSr0BG`%~|>+kvfg+4Hoq%)+ZdcxY=eCoI|eGDTX9KAI5hIA0}LGYz>bW&EB
znFqZ|!L9|ebH{%cZHMge=4F|3Zb@qF@o}SAw=*&CvT(v#UW<&N38~KE8EL-v4dYbR
z=kaME8I;AmCx7Z(Tm0StZ<)GH;i#uQo>})*?(i@vg|1^3f$Zt>GS>sw`j!LqMpK_e
zMsn!uI-#2{u#wO=P`>$Z`FNMECMyE>26k#5z^o-j%H9Y7XZUvwo^OO;xR3rQ|6rt6
zvz&`-m2g6HiP*8+;r&|+ThI3ZeC%%zo<G#!Z}25=eFOS`|GG>6-^LYX<bO#HA^$lZ
z0Q}tlI-FVmW5W#mM+}whrTzbCQ$qjIWhMLf<Nkej|2g^h+rJy-e^xPZcJ7C|{Dbq0
S!|o)rQ&!M;UiR$eyZ;9{iSI)I

literal 52360
zcmeFZ^;ebq^FDmj-Q6uniF9`fNO!k{q;z+uNC=WjcXy|RpmaAVut^Eo#B=-h9M9*6
z=TG?V<z5T7YjeM1=9-ynt}$9wSq=l06cqpfj2H6K>Hq*=0|2ld$cW%4D&oF|05God
zLRv!8>%-Bir>@5SI^wBNEIcxbFI`<^3>?AroPK%Z9D6%t&A+{3wQ|+>dcHH#$YXI%
zUvAaFg${Le%{S%pK_WjcY$ps}vPEou5aEOHEBX)QZ-pi={H3P}?;Qc0e_qL<xYw63
z*#G|3JraiS-=77z5p|{idF@OQoBsQGvXn)T%)kGD8UO#j@c&Nf|Cz@BzdzWTPyv@z
z(X}~V&{h<RG{_6K-Z}!`+wW2TylkjVgD$H*bFzZMbSE*#a{L$w$eQ-DjIO`>%9`H}
z<YA79-kigC8K;_!Nzv2(@8#;{(@A*ABVbd(A}wVELwbmoKRqWNW*wCmT+~YF+A3tp
zi6Ct*K+lOavLlN9;y&LQEv%fASp9un^$DT?F{19hW?nZ-m$#=+q!r1lGMCj=1L(i&
zv7!EUn5m}rHfHo&e@VG;a9K>slx>!8!^_7Y=bIZw$%?4pEN05%GG{Uhwo4uKntyg7
zkDXnGQuu3GEwh_~fB~96%k5$NQN0udmEfo-<eS@D$x7}1*;xYAaM<|x_>%H+DJ?C6
zva&Mgy>XHcqW+}2ySqTpRskzMkrm7h9<cF)0KPg1zvO;M0>TAPi=*g+#r^kLBed?b
zdLv@@j0zWg1*Nr34y~HZG71W)Ly1(0XWPRTM+>#c=;*K8S4}w@{P~E{rw%V2#F`(=
zDk`M)^+`QW)>f~yG&RFUV_-G4@6bQpqlcH12IO;LbKksfc`D@trO6ZR17iQ#Seuqn
zPDIG~iCR)Unz$lyp(+!H=dmHHZVhm;Hxb(0%qLB&woC*>Nf%&lYL(9|3q8{*pC#t9
zMwd;bjL&lFB0&s=VO0LmLlt-zEcS2%hlE8bZ6QVAs{9c4Aw{g8(Ucz+DHm=%?~J19
z#h3q(mqbg)A5nl&RL1N$uzqrQXvqA>x5AdAy0MMzZMbB4_}Z4kq^>Io?N{0T6~_UI
z@$oWlZrqOD_Z~a@``g1*fdfP)e!(9;kiR1+ET~{2pv>7M#`h$-3t<FIlXl~XO)rya
z&WtkzMX~83Z+qqqU<%bEA`scmQ4f=SKB0F%W{0kXw6P!hpWou6V{(a-NzIrN@K$9a
z0aG?VGv1tKvO9DL?`H6E;akYv(r_<OFk=yM^V+FtehUhf8#`NGdi~*ZDWon(AXM^Q
zi*v7O9OWhw)iVLoEVq#_m4ibNgd0fpYi|3WA<ZxTIE}y5v|)TliU|#LCU@%49SBnU
zD7)DOJ?>w8m5UKA{mmh<_=`yG5|X+I4nBUEfm0^|-<lWQ!>@fRzq3K2g&H$BJLY<4
zw|OpAUpX_?6@pU~a*LGv<ZaWS*|9r+f}3u#2=hCeNA_lKCab7KZ8}l?_}DM;J?UcB
z8`G&jYQA2O?@yA&9kM5emP>v!YyD<~SlEuP7OJJo?ZgrAz=d|==R>YvX_Y^Hw`kU~
z-A0r2`9X2Tit~BIfUlW+2ho>I!VswTk%X4}q;)>^A18&fd|8d-8eWs~H(~&&+1W8!
zv@3c(2)t>7Xw4c!dq%Z4wS3KMiKmNIh8t|Bo$qd3I?hK~ZlEXKYFatL{X&$HPE-5?
z=-mjeI#gLFS+|H|SJ$*+R0zhtt{=XhmT}eUhOs=08;aK%TDDxDH=&GNu2ww4HFkf3
z3lqB+zP;Hl+w*p_|Lki{3$)0LqObgmIqhuAeo?+8*84xE?UP(oifZed+gB?x`LU}C
z*RGLtQuqR$*I_A4uio0-W?A4Jr*=|jyE$alL9yiK#;XH*+<x<;IG4lw+!7GC?NvT9
z3dB3-3~W{mlI=`{(SFvpzh{Pw>U>zERL-@r@zwR{1)GHX%Xvx#qHMD03}mh469Z3z
zt?KyJg^rIkip!b$7!OMsvE96T=8&R}rri{ESmz(V)It*64{pTAvvKU2vLn^4)uwp7
z4XOJiR}d)R{=}He1Q44R+BbRe_l^KS={+ZcL9^rF<-7@2X@k|Nwr9T9t3Ao`D~C9?
zlVeYf2n@0a713Yt)!h$*e*XUXUuU*=dOe+Omf>t1%NlIRc3SwuYRD2-L}0;p-;-rh
z`~vAwrf$r!gM-GF%V5aJZS&r{NcD(xO0w7mCU*m}WMqDOA137-QAFV8`=J{k4q|Ch
z9M(}y=hinw;p@G8%rR+N9LFx^{IRpwi&{~MUCMG2W+IXyD=rgnb(IuQzEACayZCsz
ze`{EO4bk;s_>J%1xXL$*lFSY3s2q(lk!6b4jJMz3C#QHW9bNsot&;1V4~F66A9H(5
zr=*xu#VvuR*NZV(PMuhZBCc4n3FM1&b8p|n$J>hG<tK@cWd_-=b$DlRn8D`w9t%|H
zH=+_SM7nI`3MFyuNtARraE(U$Q2Cl(zWwgeS)zYm-<ikO0juw$>i=+G$`0AGm@!Jz
zvpbSEfk*N<x^$=gh?>~#1?UMh+RS}-5o||H>};X3Wn>X*K*Ml7`DRg3A5!46a=*a-
ziSntGe<xw#ZoKZjCuSG4(q5H7q~*{;{2w>(H=Uvpxpc53|AmYgN(p1kY{<ug>B&kQ
zQ!g8_@%`athKMik6P5R&Joa<Ql)MYS+FPGlEFb%f@A+Dgpd*%OG7I1Toc21bY~I-1
z434<v{N!kqaK~lDDD?3mSfs}1b42B@g&Lmq*X`pKne1c2TCU~SSs!+mtrn{Tt)!|?
zZa&Q)V%+#@h;CU33$bEhI!j5Yb$*8I6VBw9zL>ZAwP~?ylvb+6PDsh~$J7>6l$V1n
ze2vBRHXQ+RzYMA`WPHf#FBHYnzt#rJC!h?J-YL8mObZ@kZ%4;Tc4^tZ%5wh9klr&p
zJ6mv1%(BPMJ#N>Xz%aIy_1prn>;B4M#d|-S-}{{Y8&*g3&=RaPrjgy(vlI}gc1`2L
zCDcn1WQvrc5{{M*e+-l|e{^_UNeb;mQWRokd1_x{*PSYBP5!RErl0D6t5Y+vw__dN
zge2xSG2;Oo-ZsS6ap>W-o;fI?{>dB*MDG!_Zft!CkJ}E}cXoF-HzTPKsVe~AePHbE
zl?Wu;ih~%Nk}~00_Z=>l=neH;wMpVpiWoqPLmO%6a8|3aZV@ya-z+K`kqwQRXljRK
zO2;Ykiq)Hz17bQ#S=eElQXM#yWnuceuzWhvG8)OKg;(E~4of@gKHDru$Wqi@*u}3|
zqg}NG{<(Y0*1aMH@}*ns1G_pJ+}Ijw22zV{xQQwq?dhnc2p>aVNTb(AFw#;VZL<7K
zVY=2Krv^{m5|XM2B;3l*d*AB#_}J^$Zu;2>UE)UbdVrM2?KKCnTNJ5J<swu$As9xR
zkC{0uS;y4p#;`nMsH(FlE?Hr)<=251t1t^W?u(N!fvRlOQn(=5k0+`Ac>g=V<n1YL
zt<8-&BsHBBj8f^C@;!7JrIO~wOJ0iczT9>$moc{HjcCRkz|@<KSz|05o$-i05BD3M
zA}gWAU<?5VF}iN2509&IRfuMhwAad@^$FUg2%>JMG(Bui05u618%a7lyNqLRW!XSP
z@aw3k_MWwB$5>(?v*g6wrTbr;AeHBy;Nfq9(9CGPlAy)0__5fJL$qh%(b?$BS>xe^
z`1|&RPkZ2iFbuMz3V-L>+s<~5QQfR#AG7y|(F}yK%aSd#<vQErXV3C9<@y+%<7Tg;
zeURWPj5#gTozqXtnv_HN!~`SQgwU3KT)cfp!3>GZp=teq^kur0u^o|S2C=OCpBwrj
zQ$4?NnlP+p;7*ELOFTbL7ETj7k>2~1sl2z%|2;7eGs*ROVE5w2=*(&F7YD&WzInQ_
z8IKAIM<&A9-}gez$cO~yHv?y#&uG1G?Va7Rj;|in*3ET37<2lYtEO93cX{I5KYp(F
zLN4I>#??;vIx$wA%t6S!1S_Y-Ni(v#q}M36=g-}!JtpVe@|KNFQ{zV0{`_D`FM}jS
zo0@r#igDUE$dytP_$b<OwPYU>0sV356Pu<7wTesHjNp8aJ}LGne0O)3H#@UA@})R$
znrG?qL|mjFC{KsK^~^Ts7Wru3va@HWSIloQsbg_S$!|DkwRk5G8dtQ5wijkLdeehx
zGC>LrxBtg%O<IcsB+Ta40YIk}KMV82&~mxQ)&&nzl93@sspcGH{$29d3_ekq-_Py(
zwMQnA|IWDj<aE}X!T?cU($@^cEinDv`n8`Msq{q3$emD`3fgxZh*d`k-jR7l`Yb~%
zt<cOzg{aE`yfIn5hR&t7Dk->7*cIoiI8`s-Q5^gY#P>>Zt4IoJsx!6N{^k{ol&!w-
zlA$X!gt6G)Phys<UJS&&plDYl#Gf_L9LV_-FUVD7&R{^CErDF$4q1N~XOq#_ettzh
z*;~%iT#(m6s9xHzTzyf*U}mlkf84rnd<QOY^{S=LlgTQM;V@HQ^z{OVVc`8G5Y!Q8
zqNb6&)-RWR6wU);>_fj5G3m*y*`h#wABVdiHEJx`MxjS=Vsqd3Hg?&Vs`*)aHT5}U
zvD}11)^@g1$bPxwdfZWmeh1W>G^eH7f`ixJJn5@hJjDNA<H=8-!`O>ISgW>fQ!+99
zb#)Sk7RPWkB;Oe;sN9!&rz#*wBC+5@d`b00e`NR3z{mN?aKkx&;hLW-E+zIe8%0@;
zLs(*diO(&Rh(ww{A!<W&U(WU%+_g9MqqHA}gDB?=!iL3ao4dS<%5bUFiN($g5e%_d
zz=6<F@T_9M4TO7?xs6a+r)><IBA=7Q7$#`6AHm#Zo^kS)?H3`$_aZ^k52{$Siv&Gs
z(y5*xY{2}pUIFA}<d3g9f}id`guN4>GQAln#unP*4I4I!JH26$CvPV=uSNe=sHNL@
zmb923#?DE!;_+28?8axKLnaoRfFOQkgh^UfmWGy=G&%XJ*W>;5OH4Lyp13JvlWcd-
zc4^vPBhOU?poCd0;q4uy^PG{^49wf#f?3nCw_o}qjkj2pXsAYUxe#lLymS=t&euW+
z(R!}r(E9`Sv3T$6dhU+<GZ*g6r^MCsWT%&9=wNC>6WgTt$E*{EXGM@vo58weX#I+1
zHktT?mjGb8dd$6puailk@O`hW=e&HfPliiwtD^QfF%CtPs)^@KDM3kjwTy+u$Iqm?
ztFxau3B)fO=2Mfz?FXW8GK9T30cz-g0ze+WV*}<?L{_^qTTAWD4Hy)0=+{Bzk}+kO
z*5ohCd&<P>lE5mXnf0Z(oAmJFV^JL1cU<jRJ{y<iP$B29t;rdj>_EQ6agw}rNtxqN
zDHl)44^76y$l2oB0DI9d?+GHF)A`|$9$}`cM=bfU#VC^2K*dq!97m;;jk8y&(EjA#
z2L@(eW0O2x2{JRwl5`BiGbDno=aWZ2m6X{JWJ2Wf=MR_DVj12xiT_43?V<>rrhpUn
z9=q<G!pk~VjD|FJqZl@Wro19fyj>aSCPmWgtFyc{y3D5Uo<lKz&QKa|>PvT(goQtj
zqX{P-*ATtivd3^fddIH`L2m9ww=`$ZH@)9+Xpm7)d&*{qYmXkFzXJ*olt-#tDVBv=
zA2v5ow=<?WSuJ$j0tdZ<gn|h_I>mKVY9jL@obSI}8-_Cjf&0j_(unpfa!N<k7B}XD
zhvhv@zte3oFaVuixD1~Q6>n|HyhwUs5W)0ttJC%s`{3t~>4h!}K3<2l@O$WW-@IIW
zuC_mtj*ia9V6FX=E9B}nGW8bcP06F>W~^Nq->DT{7@}~U^rjiUzZ@TiGt2zZz$lLp
z3@|Orxba}W2WNxgA$n_z7hu?o1aPnmpyzhJp%K<HVx+aVvFW*j2%SzA87(yW5+zV6
z${0B)J|(XmK=8>%4F5&T+PR15_pm6Jq)_Mp{eHLljV62*gMxc#h4;zJO!!oV@Ph-p
zcRNl}@;iPK%ZyMn9M3<OSO7CBbBq%G$%5FO8iH>8c>C=2%a_9`Cy(C<jVE&P5>G_+
z&AB@`#S?Xmy%C6vy<kMW9<}5fil4j0iCI2g?SNbc46!N4_gbq9*_AgZ_q>NMW>a!>
zvggwk3V$cZKwgD&dL^ZG9n4kFpC{6i=E=VFMF32v?A0_<qwgPA!poKrD;9l_15fy2
zv#SbKp=|S?Hj;g<#aVfcm+ihTq7dU!1%0KH<lv?O*6+Nq$8rs0$sAj7e6Nmrb3}YO
ztfSz^CN(yiMM(W_w>>$&yJv_6Qbu4=VVanj^orC7K4W2J9k{(b%%A?@{G%{kpTh2C
z1_zA&T!n<yXPWQs6WEG|uc3J<TDk+-f1o`IAg(z)A<J{90_h$^amD<rSCl!Sii8Y$
z9jPhrtuh*K=#+AVDeUK~1`{ZRoR@i0YIiLd3>j#t;TEz#_TTI_I>4x#nqq5L-65Kp
znX$>4Kk2c%7vbW<JDjWRU+SLUys7;N+Lp7shQ&pZd(xc{mpRn^C4rOEqn4IdcsLqS
zpDBmw&O4&~s}~Iu{fZ)eG-3aEMA)~GY#YZ48?@>nhDfvR$$1piYG5Nf(X*gdEf$Ya
znVOCc?spxG_PCF#(^_IhuFKCcXA<&8!x9K$JkE{2ZBy{OoYk@JXXrFe?2p9Sp4BlK
z?0B<h@o@Lc>k#s|sZ`G>?U(}uMcgvKUT*pb@d}$6<0M8`E!A|8(0BLF%!4Xl_5VxW
z*aVe>L8EqcQmWV?D6v^+&F8_8RUnX`(mx<O55mo3dv-xJ3;>IZi%|&)L%p5$&)Hgy
z5a<v99n-UxG%IE-1a>`cbe3+T=-b;{_RhiveYUIP)!1}nACxzHAHrkV+mLeu&Uj)(
zwl}={p{M>rXa{n0;;kENO-6pVzeXu1l!@{1;DD0y&rRnz3<ee$tp8dy`?GDG@0X-u
z;a=wVD)SqaSRNbkSROs|!>cyXAz3#3n5yKyvlNCBrztmGURHf{m;Ga|s-WgND>F40
zwyIWE5-Pu1q`<o~Btka*u%e<T;8|dl>r@X7#XshCbz!;|64Cct_a648(@^oE(b^6#
zX&%3ElDcoI&Yuv72`v>;Gcmymmo(D~A|M5O5MbOTx>bFf&GFX<HWbdAU~QhxRb8p(
z)wB=-9A@Krn2<VG=ChyWWG<|o@CG{TQ&vK|1Q<qX;YcJTcMJ&JOKCmw%y@L>NkmWL
z$>KcM{jtb+U-zW38GM~m#d@X!KIwoaO`awp3x0P?j^-?pBY<%L*XzS0HnVXzK4K@O
ziT^!Dm7Y)IU_a6_8Y(I*z&%HVrk{8eDTN&U$M6yPqcy*t->>T-p0xZfY=5$LT%UVW
zEcySOHNHFFcWD`k8%A+-tYaVBVVAXLpMmq`bOVAikg0$kp7eyi_guv;ocF|4?dJHr
zj~*i5JXRt?vmA%B`ILih2E>^3a^jY9bHXL2ZQLGX)X=EOxY2>r{_AqVl_!?Gk}4`H
zKu}TZ==Xq<>*xQSlVK_i5Hwza3WzIx!b)R*5uv;C+)rVW2>}?-#dC5KI(r_FBrjN{
zVKm=(ts&J3Q+>aL%%?*Fo)9{a!6kwSom-E|4m6IAJjo1cu@M8rgK}}loN~kHvYh$~
zTIp1wV{e#zUo*QAAQ)kZ(}yhov<HB~!f+;5R(x)^npFKtL;!?{sUMkfYdQx;e<@N#
zejO_gfSRkkW7#9O(;Y?`(u(A{F8ujBB!?NHNclVefYZ8*QM!jyg@dd=p7W2bP1UyM
znYy<M1IQTKSu4$1<>-&TE`$M(2MSDOb!u0qUN#pAp0>rrfjH9Y0>DP#qpymy7XqOE
zBak2+-KX-iMZwztal1Ef9-EQo-XFuUwi=>h6?QE1UayNbN<FLiNFvyA<BfMfhB3lE
zvz@R{cG@F{fsCfM-L?D#4md|GtMzdpeR$Z%A5Se;pu`EA=r)e$cm~Iun+fNyH7uxQ
z&c}oQ`2q$oXmYIQZ?IFL=j1#}zQu?8>sVEdNZQ(t3=M+*iA_A_y4X1ZHkeDV#IL*8
zfZYLRbkSl`C;$1dBx-^#?-O&TRM(EvJ!_?mYjzLFn2dreG3)09eLII}ns0OYTe}x9
zM#Jy1c3;%P0F6AUOiWDQaSh+2)&0EnNQCKUjqLdkX6!L)xJfC_&&z!~Itvxwo=rg0
zsYQpX`(0ZNV_4Wpqq_rJ5RG%HS~d=<&&G0xYY(Q!PIuty^Ul9_c@hB?%O8TDqKV4N
zXyL7SZ@;jq!^(HOkEFOx;cjR1y4@OcTIyp~^fjBEYZ~uk!i}a$ZPWMb{v7aWFYBM4
zT{4$O3xYUnnq>7nEmt}Drdf{2+TPC>$r++gaT&SBl2UXK`1nZP;=*n2G56<NgzNf1
z6NyFXv021g;8A6+&%$KOhfT=7on6WK);y|W7AaB2Vm(}w7kunH+g~?0n^u|Zb2#6{
zZuJ3xfdfE3bUSZCvA^hLmdoU-Cn~Ar0;%Z>t7BjRZVaae>7Ul&SAY>W8tgm31Ah1Y
zG~B#PRnFd^hgd5m47BWUw6w^d?nMf5oV=Y(5*CI(>24db@hY4ra~AF-P892=oSuZj
z*FLS@ToTfO!Bz3Q7$jS0xgwL63x@-YeXL2)F=k8FZ`~su<fU){fM9oU<n!lR{tnon
zw{LNQpxBjiM$hcmQ6m5LCXfSY@RHrP4DN2{pC1Xmi_A(-7<_y2n8i?2+;l7)8kuVp
zx&32Mx5Jca&C5gd)7yl5J4{Np0Y;OPL8`#wk7Y$T0Ee4A`Efgxmer7htUm>}?X{<>
zE{8cDo{RN*wR5h&#j>ldDr-<$$k9p1BUjq$8wyRzwAJ*xJ3k<(Ph_MFs?aq2ueC&B
zCwno_bMk!<xMBbe{`8b9aQkyQpZUNPwNfsA^rr#w0U0PQw=SDaJ9u}eGc07a*8YM)
zX}7wQ!oo=AXMs`|pt1IHRX>DgLtWb{9v_4zsjZHp9Isst8~3*pd~-tbOEGC%g@PVo
zS)+BsDj)qKAz6XqrsBw8(vd(TwT(kXl~_{3^pOj5Z+904FkFR0Sk<Yc`rGM+2Z-_C
zz<|91+UuETOykC}V1PMVN)I)HgfNt9#sOjslA*K6n3}y>G~x2}eFN{D!w^gJR7X@b
zrlYnQ6;H3lifg=wZ5t9++V|65=z2ikH91fSsl~lAzDEjl5}a)sUssGS5yv{>HwFN&
z)2~ElgN)VG{7gMNE?6((5Ps@^AHAT#h=Bp3MEsT<yRRx}MxIqm1?aI|K~{pgA8sjp
zLSZIFp{!uPXWhz|Q6&c+XesZj^uqs4`8Ru2Bh$I22HA5IoM@em)2m@sllL%<v81~%
zt)|F+PT5_Ku$0IeOAIffcHh#>?(h<zKFtYm#$@kyh6gs3JP?e%?9l>l@0otyrn#|<
zn}iE|#)(3`8W@^k1%j%p`M!PQOyc+BJ#O39U-7v}J-z&)pU%ubLIvbik03o@)KI4Z
zHt)STI0uN5X}TOBSv-P%=hrTNV2Ni0Tk-9i`n%Lr7(lqgoYik;WbMB-BMCadDHnCc
zXU4eQIo&}shy<zhLkZV&9|*5c+KHGab-fVcBsDBZ?8=ot7SXQmG|4g`Y+t_GqvIVV
z`W4ROb-7x3b2}UgZVw0&cVgI!j~$$fO2bwt<}-aPH3xbcbxgv1kJ~6!#Gr)6UcW?y
zAHTI{@OcVaE0HDMv@o@_wQlWvp7z?me`etE<i2_+wS=t)b_Z1^(&8;kP_$IY*~IPr
z$jFGerl#hygRQMC0DuYpF=eRFjr`lnzsUnF5TraG^|qsOMD&UPJyXAf=Q!~9R)ABv
zFLuIirUHI<a^@o~ax}Qj(x}ClfkEJQTiRQx>E#iy3dwteDdkCV!}K%?lCTdGJ4;(z
zeyo|CE@y5}9q5O!P&Jb6smS+a3~)p(&*m?+h{0KDT_!2ex7?1RZEQoLb&UOpu~q`n
zMDOpA?(W9)SKQZArtI7u4(SJ);Z@Bq1N+f2eEgRuQN4!&G++p<OvSE043%k>JFoj+
zH?plaJ5d4Ry9DzdRHY|p&m{h2wKJ1EeA?oyF2S06?9MOYNDole4BiKS3!z|QSwN|5
z!g&)iIYdWC*>7qE-{6C>#{WQSEOg5W+gC*6F_TRZl6`QVMyWV&Bua|4##3okj%fOr
zFYI?cW_EX_L+W}_zO>})(_;QGke|WHSvJNRR+#F3<L^6m<=C;wIWQ#Mu)4Q@7!N(}
zg1KJxha)A+O3KoSy1hk|mPPNAn(T~h(4Z3EqF9+THu<U^WmKpsUX?`Fd95LbK6DaT
zIp{ubg!HUBEkC*vCN2F@J~)wK5$|ub3>eRwH=kd!&!6Uz*enQHnV?c{W&FfWne<r;
zJJt%abdYCT6|Aj+W@JHNXJ421bq)@YTtzao-I>+J^(HabWaGM_U|LRuUaf`xJm3x+
ze%8AYrU-L4Z=g`@ApX)y5ym4>jG^mJl%V};*YqM`nu)av;`{-034VJ&+98biASLD>
zu43H!6l?dkWCvtfI2$Li!&I%)JO0{CJ5dR@)jhXM6HuC1g$Vg86BQN*Gen?gatzLu
zPNW7fRaT%4SWk}l&3(qOREe9J(bUz0k=i(*|K)M657mF0RH9Eazxnhk$@hTq-QJ1#
zc6abwU3%F(0}cQM9YE(0f0EW~QWTON%jl<>AB7=Ag>oQG@AZUs<g$BBv2+*dbS>KR
z)c1>B$qWuL&n3Y}go*Oegx<V)Sb);U$02=L>$pl@8GU#KMGA*&<R@zgBHZa3-(k{w
z9n@&)kZMt1j5XsN!qrFc#y$vo0mo>^KWYrqTgd=yioNxG#5Cn%IXx|kyG{{m9VU+F
zPf^zcAL-azcW_@XHJ|_+1*Z{_Iv-@9#cRF)#*dO*4ewz(mm@eEJ0=;4IsJFLuO(hO
z@G@tPJ|B8TJ_JpadOPnd?ITSyAc9{2Hg|p^iku%_)O2k)9WgIPcc0Hu*YDx47{XzT
z+{wbreZWXAu}^#ol(34-Y<d#4GQK;Ie@8?Gn2Ng_!SNoy=pPcXJ-yJTp<N)Nc`#P>
zZRs8Br$B8*2RoO`>eIEh>nK1EK{|WiPuuPIqluPh-9{MxZ{YAPh??2BxaabJ3}6C5
z(zJt#WSG>=C9ncAyC9Phrd&L%hZoT&2MG@SAy86PI{a(@S;Wuv95XOb)7a^x$KK}H
zEETL{`1@o3Q&(CVG-?&AX}6Hg7Rsq=1)%FY&;jD`IPW+KRxFQ8=4bLH)`7|@5@4h3
zG-8PlCBRJMH)F%uVyC6%2M8K*S-KMJpgJ+F==<pL%n;-;?NhxYI+lI8`+^ufO$IBU
zCRko6ZZNky!2Il<oZF3E;Zwk=_xEl}Q;cPug7eiw)-~Bzbj2M&<0N+ZJmazj)<5|s
zE#oImIq}j2V2eGXH&4#OpXR{c_3Ml(Y-JIQpo7Rtp(9wlZyZp<^Ce=pv>|1!R!LMl
zuxvS&O|_Q$Vk7=`m>Y&ETQXIh?C_-nu99-W_@P@`o6NGWE1JQ3L#SYh`1^R-`flE-
zwcJ+?yU>c@xzr|GC+-%TJV+W3z3^JUFpS)Fw_ig9nLP86T~sgcaLIi1NKG6}9W8#l
zQI!p)C7q;EVQhR+q_toRRULm)Evw<Lx;n_Io&}5k8YkxeZKY`5Ue(BhoF}yyY$S;9
zQeZ{T%$7M2SXWEgK6rq<RLOgPI~u~QV=fDh@6KC2Sxn=%WI)Z&GPE-=1IcUE3mw?3
z2bs}`ZtcJ|-cOSm1zYL^4B7E}J<?uc4Mh&#+iNCjXG4WR&}K?bMEW}N$HRH8+~9Iw
zjse_s#}hOG#J?1bD<@(np^RR4Udsk`nL?s?vAtdUOZvCqK?g0pLY@(gR)wMm$M%gK
z@xI{-7z8O@IF7syFR_k$IT8mQjrYNHLOQ0-cewBvIm^2qomC{mSHh9sLX3c*ET;}~
zr><Lmup5JqDj@1};yrHUOi<NoMk0E%UY|79j;KT$PdL426f4+?+{G7ovwrXBD1JFV
z1_N|SJblv70yyhn@cQOrAc~B}UKMmbAu@iTGw^9p%QgM)95u9C&>}r6Y@kN;xc!Qd
z(3k^G;-9zd5Tn#yRbNI)$TF^7>r*MAm7LTo3}vdvI*6yI7QgJI7aDDHi&T4A-ADe8
zZ5JCJFox&#zQN(TdlEIs2?S|tMD`2ih-)pX0X=oTjsx{7Y=^GG>wZv{s&-oe^8%#p
z(&3ZdmHMK_%ON|*In$*OvKn8gvX|HmqhW!@(p<UTCAVE*0HJv;zJ>JzR+Ykq6m7h1
z35z(`+5mIB$fAh4rd`)?z79Cqej#cSa9=d3tp<($xC#G?`;t>$tV7Yy-!#!MvjXWK
zL|{JRB1%CvBf$0o`Pj%{a*6=|yPVJlu3t8eb8dQKW<NWTk+U#+g5v0?==OJ*fu5QS
z4swB1w9ww51)OGDeskkxL6BN?al8JlFxsR|DbV`}(%l{A&*^t*qNH)jmmZkx$~kFp
zqffWqU~N<hRq=RJT~Y9d_@;}*PZ)Sg6{?#bW#F7@`kJ03qgz_#1n;xuN<P0`X}Vgv
z!(;NdghkJM;)N6!68Q=}gzii5%Ixs>tIIZPae6znd3~)^ioxKCYdD)|MbH{Lw2qm|
z%OF$A%x{JVyiJ;C;pm{||0*1Jq#H5?Uq4=Oes?Ej?RJDIN_=jVWLQ4EZK+L@V70S#
z`q_|NBsKP+4ROTip2K7A(fQysl8Jv>-Nf!TLwcqCCwa%&tjUf2GR?@2-KX&fK>fXt
z!g=%NO%74sygkm=N%*VB6Z6+A{^Ys$Z6rROFr2MO(zGO*WT4qS6L~ak29+YdR}_6q
z-OZ-MRrd=m-h7#vJg04kz9W$nx7EqUk>41Lq~7=hM!N4-i4qGQKlk#Ib=NfpMO;7O
zoTN$<#J3i9DSX~iEIkl|X4|K@o8X-iY4PQT9{#p0SwlBMM2@R=U;YW^r|jTfATHxh
zSlB;O-%YIK)xh5pQ!VhfvI``0t6WLcBcvsZXW!r9lAuRX;0Ik4F>WW55pFd?pG7J$
z%V<cUTvc>8vUOzg+43KE9=wi1M>KT#BHc2&3wB#+4hNclo0~;@Zm4nf;D)J5hx0tc
zsTPaN=FxLqmoamuRs1RL*}T?Ta#S4zKmU%?$vq=51%CedMaxbB!h$CU#e})ejc`Mg
zg%?8JRWs3YA4{}m2zH=T%c#-RjB3Qp#F*;aZVDjJwyf{W|JnA&T;!B$dg9wV2YIp6
zC;Gkyvzpd<9X3?J#uY<-?aq<Q>6x2UeGv%*ffj#?NyyI%N#X|xs;1h?a}GMFnHb+c
ztT3axeht`TXEx*bg!|l0kfKYslcIhYOCm3^ZQ1=^I8~S5fj&UD87cl!1_&Cgm)$Ny
zNXdU}_DIt&?LnwdIU78Hj7;1hAa-H~!MJP&dmZh`oH}cW7f-_g1^suMKQ?2QZe^Ja
z33R*n6nFNCHv1Twx5Crc`$1Rd_6=0d{oK3oB36yXBl2YXQG9E?HmPlI#&PEEP8cwq
zyV-1k6qEu%D+R8?zj~dRn9KV>&Xd}C>h(LqBapK~1h6+gN~-Dcpw`V5&<BzMI6rT#
z0Yr4ntHF^L3I62wi4#y2)3IO;rs}fb>T0SldNtUosi`-I)!nMb9aLZirT^12KgaB^
zKhV3iJ<&`f2LN)x_p$wq^*BV7Q9MEkrpvu4UdLC1r_MTV?eQ0{68hSV<ka*u62~S<
z649*VBaEvdQ`WujHg)SE916_(eR-cURE51DeoQ;+-`yS?{eN7DB^hYKL~F*F1bR_z
z4<*0@tlcNp!l$QbHa0c`bXaScwF@^u?MjDaT$Ue>9Y)n@fSU-tF-2_MAq$$?+1_rD
za;Rz`m0`UpYr|4nrg5++CAgrAv%XjM&UbDw;QnEO6(fR{tq=I)<XJ)2Iu1kYLWvUP
zrH3`E;#35V-d8O6@80$HONIZKF18qoBO&IrL<ZsEH|q-)o@k9=Y@Fs5r*(&1Jul4p
z%jeQEs)5!a=OK#nUMV6YgJxu$KjKX>=CG&zb<e6%G)Eu-WxJWEq2=oJE4}7JVs3qr
zFF7`CUDI<jDPEUj-OmMGIF38dSw|kS8ER&4SBKBOc#^>YCVuCr?46cok;^*5_lP-u
zdoPv9bK~}NTD#d+?6fpAB5^DTsjDksj8z;%1{f>)ArX6s??m44a=-W8EK1t`VemyJ
z$!VU_nzRy=>Y;-m>ne9(U{kH-{DX@sivcWS=UR~eaJ{P0d=%cIjJ%LW%+@*T2mz|n
zdtnl;S6`%ET{-D-QP2_L&>s^hDk>`n3uIzVIfyy@zHyzNldVCvUx@srG)7*05WZmt
zm0<k?(RgPQeCrz>7hi@S?tO6x2*MxlPXcvoHVot9(0Yv&ttIJkFKtY~B>8Ypb3FGQ
zJlNa8DtjA4x&mFovazun8YKEMJfGX`=tlPVdMVoA#1G$=k&{Ezik@&hH#{0omX4Da
zop0?Nd#-97rFwWyN|32^J4TR=d94FI9vT>_%Q{rYVr?d`S@YGuVf1O4xNeY6q!l#b
z)plZbvCFv<A-E}Z^&#`Q3cU<|7up?HZv&gzhw|MnGUt8_z74Q%7A4<-yXiuN=J!*c
z36thu#Vu}XArcIrQKS^CUOG^wC1!fIHJAZvdWI4xViQGgv48iUL=7M@EPI7Ny#g;7
zF%a@1m5Wbm?k?6n^YTkc9s)$Y4lfy%s>B=)_{rD05z7ONL#wqPLW*;J$=uy99h!ZO
zep%0-j+%<^4man!Je~kSWBUoRE7W2(JeiJ(JR=5+`7a%$@Ya5rvGmc=*1TTy&){_+
z6&4n53)3p1fAVAtTzg3=|5pd0I*h+mj`D9Hb)OXgf^4UYV1OAro`AbExtW<6aeCa%
zl{b@vZze?&t;W)N4R#}1xA7bT$lrSxF8KfC1~z8XDTABSUo}Gp&7ZUL2U7ligVkq^
z@1(@IQ4Rjq>2uX_{iQ<x%hAZGnq5VpC**|`hqo7egT6z$$KG8h3kD)k-EoKO=jX?Y
zTDcUPkbnrxXyp=iIQ^fL0<VNg0J#S!RFB4?lLgl#L66%zJ&k8<Z0sO~=+yPgdS_>6
zqq2D|1ccFy0p~2r;n7B4GY+6XVra7f?F&vrl_bsZ=t*Fx?6Z({NUld~=hZxs>h(Su
z5cHIe_PLXvp}|)VnoJ(S*9+;vzb^Kh!*$Z^9LPvWP{5`K3s~DCm5v*ox+LxXC1C`D
z56-uNAeZf--oe2_2XFhN*;_8)x9n_WVqy>~_K2C<PX0B&i&r2*qqUIVqYWE4?c*AI
z`Gws^LED2;^zKHeWwIN~++93!`CvXUDw9eZ0N!p()_B>`a<8J3-Pw*kCl}Gc1iq82
z@Yr*gIK3XSN;hKuezQa-?8O0M4d`+QWs~9%u7LxGWbeO>{s(b)89{(rK!8Mic%$s{
zdhP@)!KeamX!a&^6Pp7Tg2^T+LM4KYRa<_tKGALG!T^%ExhdaRtKf7zTs-SU3)Mut
zesg?O(_yxcRdRdB4v2$OA?)u3&;_%<?09503Lf#ljm4ppqZJjU1O)L-k%IE_sKdg-
zkPrN4bF#9?VBz4@R8@nP%9IdwJ%;`(MyC%O!LkJoAQo`7Oy4N;_nN(}FE3~5dVKIz
z$`yrs=HH0}Y(RFy0VjexEp>P=7M$-8n80UPUgfK%j$islmk>V{?ZW_^la>~c^(;2b
z+R;&#vty{qX1P;9cvmS*W4TGh@Rl4*GV)Rfx2C@r7ub4C>Skom;(<rZCe)w)MSz*Z
zDs7>Gm-fsgK_V29B>QE}n+X>Ckc!h&XMBA8yi!q>(>8ka|M-BaDrP(%|1sybWI8!m
zjy1UQ3sp%fDk`vrMlhU6CFkSgvpj#cZMzV#!_S>*4Fq+k<0i6aFG8Nb7EOZ5HpU7R
zqoQYEFkkDlci!CcZh7p=;-LNPReLi&E#UP~=y|p~FD6wyza272B>rPF8fz^O=XO-G
zq}m4~_0a%T>J6N*h@s1+o)mQirGDkw_bYwK%V#}P`7emMZITcYb1uPyh5-;AYK^X?
z{$BoV=Rr&g5HvNV3J(vTfnKE_==5k*s7}McfbjI`Q;Me2Svwa{NH6?rCq?&qo@y0y
zkqcPx@32A~IIL=gR}sDqyxFNgIosiKq7|@$!Nn_hZsm%KyH!Aw-fp@cOt;VprN*QZ
zf${WYsOo<3VKr)NsLb=x+%XkC-GH0=Ab|Yx$}CEn){tKS5f>-#tDD%isk=Xy@~+lK
zZ@FXL9n9-aDp+4L1o(!TA7#~6K~_%xExfhufC~uv^yyQR)t-+j30mV)ib5gSZI$)%
z;vX<~X@;5m5rX<oYZeY*Z?%CLFn?ZU<nz3$!|!>(;~Thu2Y0sL5(X?WV-!fY#pBA#
z>e+%t;?`S5_F&M)K!W>I?6WTHuCBF~&7mx6SZtz$XmOQr87|DC9Of`E6dWzq3%#CJ
zmt1PT>M5&Y#%;j*4|~+a=2g?NfT-x`AGor5obPHbCJ{sP9U??Pb$!&pl<muFzoqm!
zbvQd|b=U~{p$4|}&z~}cUNI{uj@4Qn8rw7q(qm9XFFSUUyxIQ}uFHC?9$PjWN5XXq
z8Fi|0`@zFhWhd#aMWN})ZnWf{mZ_HjBCu4Ywt-RJ>bFaMUsK!6!+ell8z1a1yZ=9a
ze%l(c1Pg$AS@@u;{M1^jA<2rX=Eew}+S*#Cr{z644SsPkC>(8%A73c|K)Ruy<8s}>
zfquu?Rk7E7rHY!GTJ&Q5{zl{cy0n5q%%IGSTs&zw2oscGfa2-8W5i3r^`pVbVrMj&
zFOku6ryyiEoHA?Wkw{}Wyn#ZS?^kA2M}e_~zi@bI0gjry#9)I_x3sj3T-KLjQH;cG
zvRj8ctQ%wh-2*zE;A7dWbd$*FE|XdgIoH>m<$(qECbM9GlG4)tiu&rFO*%$rP^7=P
zm*pg@srl~nn)Yfm*ltf03rH-lGLBil&f#2M8yiCc<pJD2xnZ2m2?~XFz8@MUctV<0
z(*Dkw%_Q>7fx-iu_o>e~IltLZBj}30s{!H0XBnKbh;C@$_G{mTugbzhOZ1TXrEHlF
z3-lp{Q`3l&g3*;9x>6{wI62_deIEl(7U+>1zPH08CXUM0zK;TXMk$@m`rSLO0`$1i
zUmX?&2XLdMo!`8XGBTn73%}mwCu4sbz6ZnlkyxXKhS=of=sjMO<=WX!T)Z>CmqCi^
zf4%DYJEzcg9P3ThK$Kv{fdiC@v|)g~93BD;jQEW1?}Fs=A`vIukC-22<8l20l@MgB
zs;ZFD&<?S+8?ox**ti<~4G2ASm{Zwc($ZkkM53X$z(1Og5ub^d1VB(v5Vbu0TlVHG
zw0fn+A1k8N)BwmBiYSbhpUT;hfQ1RDQE*kzkN6U=LK2R~-b&E!K{e34UNvxYwhgmT
z{h+C`WYCUfaoEz{4hJ+$pw}El|6AXyi4{3iApl<9-tQfjjb5_8ajykTL17mtx8`%9
zW`h&rI#AVBi+vK037ih<h?(6FL2m9YCOK@seZoAvwCb@ubQjcMP6dF<q9(cJ{Nw*~
zXl_f0K#)S=5wG9D_>5Bc9;;p*eDj(Q3-6Iou#_HKXM!as39r*?JgA{WuYWbk+h**9
zpwx+z*0{g7hq%$*4Y!E&AAVOf?k5%(zgp(B4`o#h{ZO16K&nx!+`C!9*}}X6ifB$h
zGv=Beue4gvyEm=rIvhq3*Dl~u8T})@2&izs5=vE=-Q`u3VzuD9b(dpK-Kw7yl`_o}
z%jAi_Iqk=C`695d>o?xHNH(^1_}z_7ib<xR>T-C*gCC9NAE}~P(d-Nym`*i*U7iTn
z1#zQ)JQR}dNwf!^p4skbD!=Ov@)xm3zgTO4yU9roy)dle<E$MFVE!DA)%P#4Fq8P>
z@+AO-OVW6)e%VYdof^{QPtC}P3JZfz*-TH`{$9OF1Zwm#|E8e_^ZIK`S*UvBY<z^2
z?nFz-C|N#q83z-mV;N0=;<%{f)qq_3AA>2O!n-#R?%<KPt!|9e+P7jmbf@55c(|I&
zZAbGtBC)=d#bU8XYi=H<)a?xY+bX?%{<XU?otyM!<ZfD+Mv)`mEZx{!jxpT12KNSI
z!%7foV!kVWstTEB_`g2!N!=3=2c<#FoQnPBSG_NxR*+>Bw&OLj&N}j^cV#6d0MNoD
z%w`-Jwv8?M?>#6T6u<+T+S;%jBCl)Q-<RqkEjK$nc3$ou$Fyf{$xER_zIL^?wpJpg
zDIMFMHND{fOAj6lTh^rk<sBV{s*@}hg6od9E}k?}=;2{{Y2Pc24Ts*Pr8V6j(O%ct
z_*zo@pKlo&`U3#?D~%kvW-ms+QR>dk4Afa=?AmnJ364!pA^}l@>P#zl6>FI9!BhE%
zdA`r+V*>zHUEQd?y}hR0)ys|pL+I#CdMzZQEZR!RBwVjkjRg%jKR*WmRKCD3k~XjY
zi+;6pfMW4<<7HnReaFGLt__1FQ+_M<NE%J*$C<g&&!1s{7G^0{JC(WrgK|$-?x>ST
zVF0;AN**%f#_kDSr}E>z->`e-7L{M?|K5I{$U!AX7zI!*qnmI{^ojV-fuG>M*w|de
z%_A3dD{*LTUDI5}AUR^6I_T(Vw_0U8@nbF0#S_#kD88%)VS<yB696cUYqgysS^sJ`
zN^;-mG{WnamX?M@z&5>NZ8`X?Dygx263;P~BZY2|4UX!)d<oht)+DjS;alhbwkm*C
z%@6c^$rj27?c9yZSZ@hBx^i3jS|qMUEKCmxlN^{*4^?_NQA)BD`#;}$_LvMvmsC{^
zb@@Y;B2+8I&`2b0UcYap9{Xmjx9521m?gQ4Z2Ri73uLh#3D}_E7(Hq#+5ay*y#Xmp
zP2)`<=<;wL?t9mj)~g~(R*-^<zkmJ0W;VrGuc*m(!XvDKtEjdX2Ru>`-+poR9ANxi
z!iS)xW(N6R;Pg;CL}K>g`Zxl1$%o18)fJ_=O`=C-lhZn8yewR;F5<K9O~OhkP)PpI
zWZ($OO{5YG@TstHbE7wO6;XK(orb%y@{5?~nu_O`;JS5OWk2g1R@?cdu?a?J)=!+C
z^~;}f{$BJBJlOx;IDU={)VS^{0DF<Y+`A?Wqpa+h@=K`|M>s8p%?>;?!qBA}=ubI|
z3JPFBfhZgRANKOZgUnLsTbC#RI?}-!hR%T5=K`kK<@7YZt-eFvg|n!r3O?5itS80r
zw01Q}?~XaSd4DA7s78vE7A~|@0{WF*)mX_<B_?RZ+<5Qh#CrMG{X&tb{J>EVN(YHJ
zd3sn=!Hge%SxNa}LvsYUmWw`7`E1K>SKwTlRPnUL-WJSB&sV}~xqlDh=*zN3LgWc$
zaI#dpGFJ}qVf3PglryBTR`={2hFr1w=pK%q))iMGbW(CII<=&%tdB9*FJ#%Nn?hXC
z%gR>X!Zyn4Fh6YWs^egSL-FI+jdYVh1OQ%cJXDvJYccJ0>>u^lNENt~j$6wZaP+Mc
z96;%)qeVD-p40ipR9aeDes3!{ulE%Uu;#r_!OhDHThqap!sA{e=u~_$Ipo-EsizV_
ztdFbdK0E^fRgp4QG6)0aB$Bj5ZtWO#Y*#&Y`z!T`n^k0ysQUZcPT$T3uZxe|q}hHe
zjeVU+p4enhc8Nr*bc@&)|8HiaZiPqD{5g}ft(rk=Ec}?0N*~W-GlEa&sqI8`6f$zG
zDAup{<!a!BsppzElIN;B5pW@e9FOoKE#M?JQ&$9|J`9uUwVhpGx=8>+Ug1?L*vTlk
z9N}Gn`=4bU$v(leSQ}TBI1Gzqe$HG9UDKDAw#;0a#iCK$hXwnazX&W}y@IQGjo5bu
z(GTRkHj+=WI=K2W)`nIQ_rtcDMX|3Ul|`qZp#k1J8m(_TJ>#|9)j!?CqbGur2(5;+
zUY%xVcbZvIC5(u}CaA4_WEdEiUOUNhuSLVAbjcJ$z>!kVFk?N)iHYyv;NZ<M^aKU~
z)zo>;7ksUv|Hk4vvea*FTTOPUvGIvvQ8uQ@@<uoUKlOp0gW2-4-E@<tRqLw#)LLVW
zy|l)4*?oxKZF{SgKaO={lkeGJ`qat{JW)6w;-K+@gKr(yAI8Fx&;3%re6GB*-cf{>
z_EtrFf%_&>83ABze+(cOa2+_pmeknP^c-7WU;FjSK7g;O`*;bpbs}>altRjVDxw7S
zNeL|&xTWP^9g_TOql9quj<WZkP}9s!Z(SYo?r;B?SBH2AOZ!JpA{|WnT-;6YYhYAr
zW0h(y>=)S<GgmHAT~Zn&Mc+n(4T^%IEqJii?=sOizd0!u5ZT=9xeO`tVRyf-r$c9G
zkeOsr{8U`L{V`Dt5rD_aL0iwmkDa6Yw>Maq1&%=RI<jClDBF6|U6C_2PJ^if1}jMY
z;|{N2)#^r!$7!_eyj4^)FtAtivSfb8>6ulV>mcy1hRYY@IV&@BUw@)7Y^5w5pA~Y!
z+bX`L1aPS5e{ILQ^6PH?;JTP6u}h@rh#lw0INUskM}C^p(r}THI;^-utfBJsL&0!R
z=iOAD{L<3TmNr(7Hu<H?%gu*(^*r5K26IN>kVn$8oxT0pMkrQ(K?gY}5f<3tW1`0m
z|LR`q`Hz&Note#PKqL_&scdZ23?U_T*F95U_BdiYE~KNQCFKVNLew5R5I}mN&Wek@
z?K>?P%st4oNuY}>p1w$WSI4Oc05}Ktd#EcZI~xJqa{e}DaF$%j*QOa?-G7Xoou!#@
zeytPX)l00wnX}-i1l8Vtqllp=6s~9oHNJr;zlU#kQ`0VIK(yNo>Dw1Cc90(0ysotv
z#{BT+i=W^9rOxld`KxJ3du}C4bp=M9&qp2YLr7s^p>CI-KwVuOI6s6Vc1u~}A3<!C
z?nCtF3=arM<0;GMtt~E>j=DtgX$xRjxDO0R2-f(!POLr%y5qje6~U_Rx<$2~%)#hs
z+ZbK&d?U8(3dRKxs7A-f2R<f>#uOCLMlrC<lh>nnNo>bA6|N2c)j`8WnT*iKW&C6{
z+{s~LVHr%-F^>L?d5w*YfDdoj)XHtA9-iU|M_>2j1DWTF3sOu>40Upw`9g~viSh3V
z{eQ9#xVTXv%Foj#p<urh=)n@Z3j#-TH^EU>SkrYu-6moMoAOLu0s;cBquSxqKD1|f
zrKKp2qu6mD&S^XD<TAbCOPl|u;iN&}EDf>fkEa6(9Td3H<a&B~x@~Sx30ZZ6R@*(v
zFtU}x^@bd|cq*orsK+v`iuzdNWka>fwKosStB0B#mVt(!N@P3`Ev8wVG|{k`*nh4t
zD$1q@m&WVV(CZdmVkkLLRl5ZVdVMmyH5ltMr}xSXoLeUr>#|}pQaJ$Y|Kg>`6*4Il
z81d?P3s7zTJKauBNr3~BT1&7+j(p(JGtGLpW&Fec&1t>@`+GPMX4_P9GM^<ZDesAS
z2#Ra0CrB&w>Jd>;P+AVk%AG;fm&jKIz6VO7kdcy}?&k(>ffMl3#>SL@IQ?5{`g3x0
z<rZ}H_umeN|K~)wO7yU}=E68skm!<L$|!I)1)O2@<a@fZV#)Cx!{+t3{5ILpg13k}
zJM%OUO$JP=XL808of8S$(NI}%K1@7z`B|VHmIve+PDgJ2t1$CLhZn0&Pgxy%-e&Ql
zuJHmL&@Jf!nNl{#?w?;K_)|3OXS-NkmU*Ieg#&9|Hu2aia9F=Y;q`_(+1H<qw#)f+
zP{|1}QY3d*!%A&;;!u5*mCqxCy<goZ^$3<^|NTe#mAJ;6F$)d-wWy;GLCX)NL%kn&
z`Lm5IrY%}GWB6J1@U2{+-_B(Xy;c#+udg>*Qm}b+!H?XtF3x`1mr|r%4)2EwsFxCd
zej!RM(ns_h$1V)MRpQ5!(AZewi3uOgc{^3ZrJy)29)6z!SfOizk44%R*V~*7tOFGN
zxE(ln`I2s7sB1Z{E$uHhj~~|Gw3oG!APioPd@k=#Za^g$)J_252qb3-h-9}j8EOfe
zySMWx`29NizB^Q*qP&fSn(Kz}(e{gA@0=huDj<dz>{{trd?d6YcscT{LT>4^!jUrD
zV6;Xm2PbTSL4w=En)f~S2TzZdK`0BeZ4U#V{&nE&2k}51dIm4L=U?z>B#x2KJwr#O
z5L*plOQpk#tVIsU8knBiOG~JUfRohD+?B9$Dw>kjL^pCZ$z2_3Lf^bCG2~h!urC=w
zeNeJ6gy-FkgOuaYvl3>Zi0$D-i(luvy0zvAAfFLY|3wgu%X&Phy<G^H{>{KNA=j}Q
z70n;IoNh>f^{$w1vm=F_oqkm`Z8Gv2j0KLs4s%O6>*J%ee=H249_thJ_}@k`+5+5o
zu_*Dqi=s}6-pqeTLqCG?@vUDCb|?V6a<!{<u@?<6%8DN?+oPnI45qURfvsp^YSe<6
zTSyMDUWUJIH&>0qUG(k)C704+BNCK^&D9llP4-^1>-<XsKbRy#SD)Lvaulhc_T?oV
zi@m^&HJ~H||IdQnU`Kg{pN{R7Ee$we#522G7hqy?J<fBYK2;rcKI@bJz$Jv9!%Xzi
z0Us3wAN6y$Q(9+@^D*^zH^kR#dQsH@<Ko}|nX!PjN+a6u{O1Q=Xd4#IvPiQO_(1D0
zsxM;yAA4^ZmSq=h3)9`*NC+w|-O`G5cMC{|bhk8!f^<nE-Q7rolr#@WcQ>5%yzky;
z@9$jayUyS9<9PYYOL(4pt#!{e=a^%RX~7N<YAovVjugzsYcFS!8Xcc<3OBD;v1PH2
zdSA(iS)w|6Dq-WA-^!Jhd`c4AVU=(%#9NoSGu`>3^_OsJeZlbc$z4;L2)gnuCw3mj
znR%%3=2xR0$xqZa&9CSk)ZebIKbP^YA)91Gf`zfN;=Z=<g7wu-SYjGOG#L81g)xhh
z)5aJG!s~U2oVff4B+zz}a6Dv~nw?#b6@7&IY``WDBjPhe^#jO*!|Cr^3`zk4R#uj$
zC+4D{=|>A)ByATL7e4Q6b`aA-<x_dGTUuHUcmR_zAjq7S>sAPOfOy@%P(A`>x_Pfm
ziQ{xH2T9WY%DOEkmZ}MO2t8jhu1BrRNJY*3+^YGe@n;urld~=zClarmtbiUjPH1s9
zrw(X;QL!p$kxQN>Xp1C??<yN#&1v)R^3ToUnFu@Hti6b$ri6(v+*&xhQeOpb0MM-g
zJn%5+)qX1LOS?opl8zgpTc+S2ro!N^A1)aTb^@xl)Oc`2I`Z-Dva{cudPS^P#f}Hu
z9wb<KDUZL?;f2S2-H!etY0s>W7pbU`Z#ojH*D3tnQ+)cc@)CSboi#oOfA1-_z5qI^
zQ}+@tW^bbfW><tJ)-%TPQKGP&b8seD4Jo3f&blC*^VLbMRI;Q*!=%B8&Pc|4Wwb3%
zA5!!mv04&!$CArvBx8EIInhpXAF-7s%B6rl{_Cc_jK_(uCD+KGnveLvMgjpQZqV$l
z97V*$039wRWi$ZfF{p${L_|c0u9~c#s-L&d&d$>D@)8#)q<3XYggIOv8=IM%yP`Ep
zDtYvFu$jGv>$VWvH1WXpabm`(_(k8S7noWWMLe~!qVhVK1bqvuYyV}Z`_|<8wU2(x
zsx9ywk@}#{DKy>Zh4+cU?7KlpkCtNO%5h%QX*YI>BKmyWxG5glJU_XNDC1oO5P9<I
z6UJ6s{Mk~a2kTp%A7-K=`^>=W31!B1w0_9<*QMEOj>C2qR8GcJsw&f$z;FY7Q|1}X
zJpPqvEiy<{$tfUy`SK`TU?FQ?neD}7#=;HR$#*U8WV`Q9t9|{-J^$%0zvi+dB@OTM
zMm=Na$OsQxV-B6#^~xE3rA@CLsE%p|c+#i8<N7vSC1xLAxzyg&G3Fr{?Y|K9KA%SQ
zep>jLia_3ycokKxFY%coez+GNdPW__<+eXXzhGO8Jk9X|^3c%R6d_A)G73O148x+@
zuE;1U5ftz4!o{ONFf?QXh?E%c-T_^;jEoEiN5_CpBWP^vS$h&$oZa~ZP+Bn;7j7#n
zD<xgs$dnW^0%Br1Mn+<Oe*PD1ypN9nZS3e~Lh|jzhY-KU1&YyT5uPbQ5~FzKcnFpI
zTAMNorfdD4@8aSQ@C?Qzg1@oHS{!lY<psp{3aD7RYf#0AYA;SSI{M$U7Uqi$zBubf
z)_sn75~|0F`-yrD@e=L5u!>z<e8Mi<mYIEItj2oL#=sJGb`37Lkg0ClaX&|^tovnB
zZ81(@DP+g3Hiq>XUE|oFMI(~n9ffRBlLkF`nI*}4nl%3E0Y)d;eAZ1q%_oe{J=Y(S
z7$6hGm&v7ohziazs{k(?uVK2;nQe3PyOVo5Q-{eaTLr`ZF`XnsoM`LBo;PNZta1zu
z;Md&jBGC7^uQl>wXBW-gJ`qC?ymmP_@CvlbHJBU-F!Ija#Y3^V#ru3#uM~3Hc(CO$
z^I$M6EepE`&Q1A}eTVJ(>At<pK8*>R7o>WXDG4}DH1YF~@EE(g7!`$)z<J00FndC&
zY2gyT^iYnJ`ZJ85CbOSYY!*bfNQN1^!avbCc;SjbchTUj{{}6-X%CLQm`hzShBb4!
zjkv~PN2%X*=IFrk*VlvCip=EGwk(uh4Gv-mdS)gqmyZ($OKjQ-v_z1B4+A{d<vN(*
zXI&$j{p%yxUYFu(U<s3vrA_~`Q<GC_UkOdKx}Qu`y07lE@)>PW{d6t}`@<cj)HHPb
zYl+VBtm;7DDgfhCy<yVlvn|ZS+6Vbm5(MBBgq%5t9xd%&IAq;;k#<8SKDF{oPwg00
zE<n*pcHuQ3++EaqSQZY+NZ5*`kPZE-QzT2tFZOHKlqld_>I7NYn^(?3YMWR^a;V^M
zvK}UoE9or-&9^oG683@^s2BpAgpwZYVu(!Nd7+(u?OM*1JERi09>u2<VaxM7Xlcd%
zXm~LM&&;OCpF<aX5l1FCIJO2eB*oCT%07hNfIS5XdN@eiX8|AqIHk*e-IG?3MF+Eu
znY9AZs#~+CDPi!F(y?(1F4U2uSpD<S9(?i2AEs}e8WGrp1&AcpT5Y_|Hm~l6gK{1B
z;1}YPKP)8kEbK*Ra5*YlrExM5lsp}ZN@N@y^f9e_akp4;dp599HJI{gw0L)Tue-Xl
z)Mr#1N_<WW&{~7b6M&O-3C_BxNlC;$kTQ8mk9YSZn)ld!x;ydr{N9^@g)Qgy*$YcT
z{OqoTp#&Nt-I)zh!Ey~Hn%@nUijfO3lsk+K?pA|uhaw|nWD1|fYqbRh@Of8=W+b$B
zj;Kd49+J-$#G;R%N^@}iYLgHca158E1y_Le#qHH1SIz8-d!5P)dUq=ir}E3)nxyw*
zu~mEQjgMxRQ#g7~24<NDez!f(#2}>Q8^YbzDDh`j2OoQnBLu(}z`%gygYb$`R}W_?
zLmKO%lN)ZC0Cgvs{)c5#93<!`@U+39*fv*QaECP}^M{>PZxzi<xO6@EQ0e+omig<V
zR3Ld-)ZSiqmIyejW5v8};I1+SA1g=^zYz!=4kp!4d^|Dga0pgICx}K9_lBYWI3_P~
zcgybZu;F-oR=JN!T)r{0&J6_^)^Nn(V3;$gX&SN`g!Mgr>Ff5HYb-5gcjKLgznjfr
z=w?_EU*Ej~sq6#BYm>@fySxZ5bMKjVBiMdCs%uN(JDqu144#8~5t@TUFJGPq<>KNS
z-_%s=x)QqT(iLP+eCk|y^j4TpD40h?H^;8BS~`ycGE@EF;e9f-SxZ2FSuOfP$Ep)u
zgb()<jg}!AQ&Q`5vwr>;H-wl|ZwE6@2ITd#BL$ts<rU2U@^XhLULTO&K*lZ_L0;`g
zY?i@8gX5*rjAcmucI!x(7yIBWL+;J{u{02U)^6&tTo%ei^@k`Agw~*syK3S;Eiua+
z?oyaRI&*ybb$t*$_ot3#?u6;=Bi?;=D-8dQ%L^v^U_I7=@_IOsrn8%>u+w(4l%Gw>
z0&+)LYUtYLhlSzM7`hq@6}_*F5%1BPZ4+?zK3;GQo66{r7@=-s&ZJ(H1Dhj;J>idt
zL<P21zje8nKKY3<9(+8EQu<}qB`~Hj%e9_7i=9$BR`)@ZM&yx!5}M#)CiSC}2{7To
zI_HP3=9W()QmXnvP{xpT3(G$Ch5khR<JW-Ec;iy|bF!mX3gcTCx(Tfs$f05#2Oa~%
z<l$MeTjOB%z>D(}iwxiieVgeaZ^sJ7rPMk9vYNPi4013pqfas*(9q1Nj$caBuI@&f
zI;=!2X;8-EjF1WQ*s^t$Jv;~XPtd#o<_{GPHCa;HE@5_%odPET0<M~t=|cK->IS}{
z8*7EZ7ozm3?ij=TpGqm7Y}h(Z64YOmTLvp&yFYm;jHKW(U#G$OYpY5epYZN1i5NWW
z=p0&ZO}uFh1=2crW;ln9kO>E8eBW14-vVcQDselpS;f6m^gYLIE&jG!4tOYTVLMBY
zQihL1oYxo30sE(}xp2X?@hOxbk!UzNQp0qp>=3^6YkXH2b{!f26!PojhK1zMdW3iw
zXtnqFzv07>XO24`eZip{&j`>-hrJSMBWG09bX!m;=QY|;Opg03)o}RQSmIsZ^E*LX
z|LK*T3ncFgU?v1UTz*8~iwBxhyL&$OePAL7k*Tynl=QK!YgZl=pfpME$EVENwj{l4
z=GUmI4+sgS0Ro1-W~no4fECh<$(Laee&j10{q7}f!&4o-*x11Y@KwOietk!=6Fwq{
zcG4FnqpUGeYi=syU!$si?d-z}Tt`lNs+0pIE<rVR?LH7~=l87P77s#Auc5)czTpNs
zi)CfAXH}=tX~U&m#iFA|Aha+ybEBe#Yy^a>(RP)-q`BTKz(}wK0dn-8WmZO?=^$HO
z)XM{|T7|0@bqB0nl-NgHWCWisXZ!RPtGoq^ty2(>wm_21Y?b6Wbqcptsl3_Tq^tT=
z{7sLw^SI}*pe#0A4gFP9s^_Ow1g%jgh55+1Y%-YRu{t<0w&He!Z!g^&tfq{x8yZi~
zaAb0)NsoV>-9dL;y1Qgl!A#9~E@H`&=ufUVEiMhM+(+ew-m{PqaRjK}Rl`95rSyus
zYn_WGuAP?y@-E^inSfjVv2{!ybO(SB)=G}U%X;9_sIf2oq4wB1Ax_&i{hfGe!75~v
zyOwP6Vp|~>qHaN6Pq<np<EC>?VP(G?++k<GRl6tve?lfMDfwjV&)qSSOa!M1oB0Zk
zrIr|K0qNPgv0mtOx_jI)>6JZ+O78UyAnOk3%Ot2f*=Baz86ZM&#0!_Sa?QwLv(j9Y
z%MOyoYbveeuJ0(OZKTy8S85?(=T+of_D?b))&dX2YagGOEEhm862FCDXpA2IjEynA
z%P<k!gWiZq+?!!<+<0E}+&g!vZUlZbU!HQC`BT`P%eGI<wP2&6z+&KW^f~KcIE}z2
zDf#|!`D++<y8w-4I;i^Zj~706-l3sZ*}&miaN3)HUv)8Xzrz{*JEgNIa-c@I{CM4v
z<<lcsC>JUQ5-E#k1`?k?7t-}Veh=9nO(E4=zTf`7sz?jF3XITvZ<yYX6HLOed&z#D
z<Ao9Td{HE%2er8AT0_dMkEPtPP^bKkwLr2F<|e}ZU^1(`XUGp{!OwUg2HusvHPQXH
zObIwot~#`H=iY(gHWmlPry@`^zxoX4U;FeI(uLUN$$zcGzBdm}VVrD;kKN^kBI&Qu
zY9UL@T4QSw*7j#)K`a=l)31noq>F6?-bqwT$IgoKSxq;Q*AbymJ#MT&ueUOMNPdd|
zT-<PKMki{}B0UXUF7KKs^gh`EOCA<<_Z|~m6IyjX%fFt3){QPm^B|OeZZg3xg&mf7
zDIp$Jks%H6mG#ev`W5mwpEllgauP<@8u1wdfGH~{YYFk~rl+Ddt&mzcjOe7QX}^q@
zP76!6)b1Upg#hCnr*riuvi05ht7^XqzZwDKZkUCk;o{1|40W#ztFzX3Dqli`?Lj=(
zy0{}1+pBp^;xCGDDe|t)X;WL3i>!5^Yj%@>U>cojjk!i9mh*F@O1J9sec$pbqc4P}
z=brF0_5;K<3WitaPIcBdZ<;{}R0am0NELq}ZGp{#=sqVi+VVf89bosjJ6{#DxCgwV
z-{#;BR;0%>9!6Pcf#DzwZft&sOJRAV6gx%NB`S7Mo(3{7aKUf~&c-+M9i~#@Ntg4Y
z_^$62Z?{R*gY1Bwvldoxp|1JYE)0tQL<ZYZIN>;F9q(67H1rArjnToGOiX-tg`H1G
z`yxi(NTTmigbTb`()9Wa(sp!4tx<4sVZrySp>fOzoVRvC+F!JIKyTL&hewV_`5ew=
zxUcq0skz~WV(t*W$&``@=!r4E?6ZE=5fQ1OD<oOjPy>r71z+&^tvWpc9`(H+A91$5
zx4vGJAAdZ_9x8EiMH0oPc_cUE`!~^aFrV@G&N5q3AIRV4!5_VQQG?^@DNSevS~LPb
zBZi`qsMvc)0=zhr*9vEypa&eq2(uKHMMzDHW_Or#TG$gZyL;>i5st_~E~((Hty$m^
z_k5L{5<dQA4ta<v^>~Rb8B`s?b_>z6rvYlTfpx0!4yur34)KUdL3j&6#_-#c(ODMf
z9`of39nO=^3H)z?vmeWgw8KKB(|Z%d5s;gp#7QF@*OddQZDWicxZk)z!H7uOja}9>
zwMmA5{Cj6h>l=J>JF*+h$Ur3{iNM}LHXa;`2mq#hQ=YssgGk_Aczu^rhC8kO8ByX8
zEn*j#d5+s26luu1k%Ba@Y50)W^=tc_i`xNH=VfcJIXpA3=F3n9cefo<2D7FkH72x*
zON&ugg-dP#>HybCfaKF~{lXN3wL4a8e)H1_iepAbBB%^>cul@<Ror%NZmB{ggfqwF
z%&SzkK1o#s5sR%hGHY(I&|drWsjYP}FymnixRCfb`5ynf*|osUQv%dQ#<PzZ*v7k~
z<L+!F=H`1bZ|MUwV=IV#g&+P_wNB2}26n-TqA%oAz3kSWlwh$UC*GK&={Qwud^RdM
zR(c5%4rx1IXnz66D*ui3;M;aq*u<h+-9C&TR9d5+3YT@qO3%#|u=*M%K(aE6GZ)!t
z{lNl&pEi2jV+t~pBfhPFz0c+pL8S;FHH4pZW>raTebyc_Ezq2y1E!?^w}Lukw!P}0
z2|In%=nQ6PTAj9GR7|_^z~Fj%3XS~o!vKaRjKk{N#tm4F8Zz>_N6kCS;kTmI66{=L
z!k1JwsLXErEIfkK_kWaq-H#$`>Q+ERiWKFrJ5c6P;@jh&)9s5o?gm(^saBw-AvKyZ
zv21{tgkfb(0pf*lUh}bYu_(sQdhH_LzbDb3+o&-)nPc#KsPsbXafv++4^vcLh+xRM
zR>U5cZq)OOa+TP`T4Ah21T9d~AD?K{AhM)i%{{as%^Zta2s0kA@Qq`-t#A<xyi03K
zrO@>AP~9rztWeh6WWZw2p9p>8w27WQJ^be`gR!8Ys3=XgYtEjyE&42oPe%0XM`C)h
zxcNb3xLWPSHEy^hiSXimWFMth<btn=cj;ozPI7<Dy?t}wt|4X?B*_0PBjJ*Z|2YnI
z+v{X|_g|1k9bBa=#3Fd1@`2Z{nM5Rk0p)=My>P#EqsM<NxOK<tH`f?1>%1Y1xLP)9
zZ@u1ou{Ji!;u0;Y5O9e|W7ZDd$5mXyCTdu8WT>58jP=Fbms=#o-D(!eAZz$<3~&7q
z9!@0;WlW6T<;|3x>|jW^jD?$occ5+e9a{aa{nZFuTcNW!w6t&}MwnV7BVC3!;9T_)
zWOtVbBM^#vvi3ge)(C(2aRUh|sJ2$pTC8N4juGx<(0Q^rcQE|i%TjL1Oey}|P%C!r
z_oJ%K3{l!mT1{;w-Gjr?h{TO}@-1e1#^hjvt+q3!>(}g+pCB`$_~#w1K$`KNHj~m?
z-Lz_+l-eE^lZQhqr{bf{!UD$zfV;YCPsKh*B^rWPNgYP)pLFl_0oV%c;lRraS^rtF
z-4MKpYykn!#{#a=<JI);5d}UYSpbo%#D1j{Y$tl27j0=d<<iK;%4#BXwrZ(M!HNr$
zRW$IfX(+DS(vHX%Q-e>5jnQBz1OmOqV34%nHROLH38agSv%hfTT}Wp&$Z!%nC_x;?
z(NvlFeBb2>0#ULpc;8TK2YYj}efr=^cY)=XpmI3P$<i1R6tC!4)JR^EDVYMUO#Em3
zAKz;lQkYIS%#POWzv@X6HG3x9eedxro7v2|u2fS70fyU!teX0nOTI%E+(JttIw(*7
zjrq(#L<W+N>pPtpIusbBkQcUfPtW|$ASzzZ;ld^<`G9S#KPacgLHb|K=3i2r>Ub`h
zH?iQl&%{G+6ivB<Ow+oe8jDd%iUPYO%4iEv>h2cp?7*3cJxuqV^zLhCiL&&Vh+i$B
zsUj&;$ZTh*q!v5vw*}Z0QA2}24=#MZxO@_Te^s0UVOi})e(xo=KwiGl_3tYHUkdxP
zqQO8(3y0%ZH^ZHaTLNvznEJRt$aBn1^4bL8e6}@=#<>7RvjP!u%@+;?#$T(Ae+O@b
z<I)Gmr7~*#j~*wNi-7`P6R}HgHGe{nOUOrjI7G#X2avPEUt(hO$BbUUk2tEoJpsOM
zf|Qv2k!xR&#9%cn<0`OU?T5@dLEJHcubjWsB65vtK?!1QY_y7)RZ#LQo@pxrF*BiO
zDKf&jQAFh`zOX64<35;AXZ@1<PJ;(qNkrs8tP;FD#|JhCeV{u;zS2N>F4*3W-?ktZ
zcT^I|25*l{FqV^_J8<5sSRaRI&8{Gq#==oRSIa($o&0kCApFsn<p}-XSCdK$em-0^
zan=k@r>P}Y_O$m9{<-k{QNzS0dcK?ayPsi~gM;MpsfJ<Ws~PR?6T29HOgBZ27B!<n
zoV&eR*xqPeZ`%Cx^xsj2yiQ>|W|pMJttbnQe~x!um7zUGIuYfE8o604N3pkDNu?ZM
zho<!nOseydCt~*kBvB$eE~|2)=^Y<HSlkZ=9Es`;p`NriMb>Ot|I3&3W%9foPQzQw
z^%*oX8U9XhL*95ZgIQFqPIKPfKd7v^;&U>7;3ao8j%W3Z$iaSNf6Gkqv*a5k{|e(6
zQj1_86I*+A?k=>I<|bK6s~Pqx19J^bD+C2^c6*J&)j6?`!1JI*T*(XAIR2$KZq1wr
z@VksdR%)+dpXa4OcWn#XF|-hXfu5Y27F_TfF@sXL`5R<h!ZydSf(kmc-I~bTW+`<q
z%&N?ukYm1TKZM(P&3V+mD7V=?ais{6W7x-AhkmISfAK!|b|Fpk&zH)JuXuy+m=+>o
zFNhy0g>}^@wSCr^ynTTL5Dj`uN>G*CHS<j5_jB;cg`=|+dcD=>U%T<z{Zza9l#ITK
zQRV6Pk}l+8hWk=1j8kvOt84!3^M6J`_q}=o6e~8ONQZux@Hj1Hw-@6pgtG?oK9$a<
zJT@c5Em%g)8FGoi&@THO*0)P{!x)jfECVB4Iz#)R$UTsdI#)3QkRoX>3uX_ED3<V=
zVMIlJdL(cbcV4h;`ioTj@fG3BkXYfey9i$brf!IEJ*?3vfU7>0*)B6n%M>2}UVqu}
z;iGu0IEDp;dFyCKze_y&tFkZXeG#=#gGU=pw)J)Tei?-s=@x43;nnIv_0P)*(!~aD
za_8)6RId{bU^{x)>hV3x1$dde?^F^rG^3V$bbeip_7QH6w)PdkT3rps@;OHbN+j&W
z(xq%|Cz!VUgRrRy=7Sg*R9LR<4~M~$b8%TA5{qSu(4f!;Oz+Skd8|?e#OCD%6G0ID
z8#%>ssa};HpY9jYG+h4H>b%1%=FPw!H9P9WE6M-f4v=O&5969u=f+lN^AN~LL4S9D
z$;QZ;J}*`$U_)rwkC8%AjFDk)>=kbD@u+&0a1`uiem$k~Q4m;j%f-?lI?D$38UN-U
z;P{l~RH5$iZlN030{}<p>X;<b0EU6_W(~@M>514W@e<e@4d@o$o2W6(+{m69_2~^X
z{OY>7eNq0ZB={oBF+Lo`pe|27{yYAUEa{`q8V)twzvF2d5ZF52p_;-S_f4*sl6hJT
zkOzV2Tg~a}x=D+_J{Kmf%ascC$bM=zMxknPc8^^y)cWT^dyHV(9{4AVU6NSCd-oKh
zB|u@^y9cxcKR{1LcPysAwH{+nNl_l0h3qHtfcS3jQUNN9Rpu>w&=gL?;VY81=5T%Q
zX>#MqbljC|8vj~W%RV1d7d@(t!QsE}Ys{50*+mneXoV*y1krp$8{$-zzJW~g=9>(S
zirdU9|50f#%0UGka1jG1`aVySz8^+WvQ>wfUgjF|v0+wupi|M+IOBFk^t+_EGzXQD
zvjoTb!$?MHnocJhf>$c{MdPTTAjJgkE1N|P|HXR&z^PkZqYeEn9}2i=_vihjT-E}k
zWq+aPA&pNRQIvYf3lpYenz+B?Jxf0$(_}Oj1Rtb696jVv_^iRquOwEUroQyg?F2p{
z$}v7q4cm(jOzPIxq}IR;ec_PSY->8Z%m6*PbmNGO;}?7`=%AlA!2HtpEZ_FB7p6`d
zNQw5);$oxVi0>*-0NCI0s58C;b1R<UCDHnLr4zw7uB@hfQcvO4;<%16nE<hDS&a9`
zT>ze15-|i_tqh%vsAj6AX~yb^OKuARKT&-TyfG0jopAw>uR~+ypW1d30GCOEUHGcW
zldYW_HZKvnjl#_kb<$t@vQtA}^HIyb$>KW*47wMW9zEb*p6CFoAdvm|gUcd%h)4$2
zU{;-`GwmbIcTSd`{C+cbm~uad8bvRz>6woX*9{d^df?0IQX28!9*e<fw7(%II||7@
zF_5;u^U+sGA}${FR=DgbgMa@0E8a8r)(~f8$bND*AAs=yDg%7+x~A0wS7F@f`#jKC
zP3)ucsu2(0vD6lqeUoG83*--?C_a1(U8wL*qmGgz>fThv*!p5SN*J*Dw90STA`TlG
zW&h~{-31B8rP|LqI9fpDwvNCH!RPP;gDwp1&Ow|W4q$FqFOE6P!H%R2b3I%`W3{?{
z=0C3+rVWMoTNoYBmb8H#?ba8%I-uyL5STd&-2A3K@~i69_drAmF1<rXZox|ld1xXG
z8?Hl){9c}UqZAwxo5d9S3!5a?*BsK=SG{XDL5{s46Aebb2w;Kh2gs>lh-SIw8fxD-
zj1b67r;Z_8I0?1lQTrt<&xTF(0f+{e(OXw<iTgopwvOH(QAn#gk6FMUzWk{X>n5tW
zR~P-yzV!abzVyOG!ql{^dY*^)6#m@1<4u(L{c5=F8oz5kLw<(fgJ`mL$m@Vw7XQR$
zVdPkW$JFq_V)HZs{UxS55T}3ZfKKOqMU%aiLo)uh{ai&yzB#3@VUp=q?ha+^jkg2O
z%Kg`X3*B2gK0Av>M3+KGe`|Srr@AxV_6n-<R==8ZZ1^MJ4D&k1n18<1^nZM*9+=4a
zzkjD8mBd#PlVRPOpdLH^<$RYlJ%312idq5Sh<^w+8J#fuH71~{<1XY<ne4*#dD1;<
z-FBS;_eYz~w}AVu+cuFX)<8tLv&U}xg7kc14SNyjuEPjj^@;5huq%hQngJWy6Jl(X
zL&rUgw1a#7Y8v8|hk3WFolG!?!tsJMa{ixfHB9?=TjfBDF6bd_@OYKeYhr5ZZt1w%
z$@;_(`>4hv&iUA~akWVba7%O^kQP!hK)a68@7kyYQ}+~cjD8k>)Lr3H(li$f3JdN+
z7%%aNa)RZ|=i0x5XxVb!-t8)qlQ=i9|Fb?5dsGt4NQmFMG(HgRvY@Q}w!ZVNVI7i=
zH8EMu#<zZRcWBXna+ayx+O~4w6>)rSjm%<qgfV-n;p6hpO~!T1-jTz4NyXgzBwU5x
zo7Z|}Vy0+?dgyM+IQS}f%-mE#-Gx)ZVirZm;%=F?<f{J4sA!e8t|$!peVKla`ZF5J
zhtv^^e*9GDTm|~?Wqm<ohqVjjnJs~y-mR}B#s$FH1SBayV)Bro@zqUbIsV0bb-<Q<
zy@qUj)k)@a;_biy;Oen9N1P+y#F@QTidmaqz50MH=n}n-Fx5IjI<_){$}4g!KpAR~
z;<A3_!tcJ{3m-UUY|)Si@8k9FQ&a$|VJ@^@zV)gz?$)@QA-1%dfdsKBu0Aqe&0iq;
zk5ehkoab0gPyN7Gi(4|<HU!o`tCl*5%i9~IH&A$~2tI7c0r&>TeY0K=zXCG}9Jjg!
zD~zoJR$cmI&he)nr>|nx#xU~>QtCrNEbub?0a+UR?RjuCOAKDCGw?(W8;=Kk6X>cF
zNng3w;<v6KpcQlR4wU-qrCUcyqG??|iu;w;V_Bftkm0lb%)oQ2Vj2<-4s$@8Xe>0(
zCL;mu@ORVPBkrf))E3XKS)q;now|#E5Vii_g7vF=>ZGnuU)A1X7l1hlB^InU&*@<R
za(9??;SZKJ8uU{aN|rX$cR->a#W~$@vTS?(L0%&^R<nQ;+5-RwBhkPjS)2O>D<Ka}
zXG?N+oGi;zy$L(XahGn`@vfJQ(n=Pg=P&)go3oIZFjo`sGcf+UDa(SqcWXDRHVPSK
zeIrA45YWh(zaJ5TQB&iAq$|d*pXxq#&gjovRk=uydOjWsszsC>{)u916Afv)%`i08
z`RIalU&Vl)w9+)d&^>#52ZEpBzrl}R)Yy6Bw|~u(66q!Nd<>wR45yMtyn7iCSfFjE
z4vHneI^xy(TEIQpZC%SNk{L2$hoOzXsS~tO!ubSn=S4v9ik#1<+7azW7F=j7CwYIg
z7#K+;ZS=S=1}H!XKg*{{v+CD+n>f=F>V8j^c3XoOUf-V9C$%NLx=)%NH^lNJXvyVi
zvuNPY=EoP3*79UN3VdL%AC7FGozIgxkkgUiZM}4t9x;3x?3>Y-YA{o#-yFffzpo!2
zF78zHOY6)ecM>F+I5?pC<Z}T|Gti`8<qO@nzQl%Jx1%*UQPc<6dCkMc2i(@@f7~hv
z{Oo@9#t2I(aI1~Zq+Q&Db{Pb)#Vb#f<kC1fF*pkl=vZZKr|UrZU1@GgrBOa2?U832
zmL%9+OR;_TZ}Pmw05y;{2!DqIjPw9I1ta_nQ0tHb@0V7OO8iSo2+$f4JSB$E`@mrX
zzUolkK0c{B-xrO5VP@mn!onxen~zKT8)S^S{5e*+dqEWoaJ~-hR4iSPxVS7qvnCi+
z;b!LQ>i|v1qGXZ@!nE=`PP>m4r|AS}Sro}yP!FFXFqO}~bO=y+8DwDpW~n_^%-j_d
z7#{Y=wDw|6?};<u)A0`w(}jA{@u)<DHjjJpMqKmf>{;^h@j?keW_CK;gQgl@*ol_|
z1c#gF8)uz!Z=cil^t#h>^x;p$ze2cars+_Gb>k)d>x9~qlNk61Gg{}X1{V!)JJwud
zE#L*h$tb9u?=a^-e5=lEe{3rQX}h>dDREce5-!OqT5T9QffFh{9xfTVOQHQ#4xqAu
zJD<;`i41%ut>D;YtEb$~(X3O4<0u^z;!69U;xJlTC(F`+|2LTKUzHjz?*EnJ`@lf7
zH+}^gjYa?+>*+7V<$sIlCyLlI<@8Ix2PaYrKvLN)IjB&2>0ptRr#T@&t8!~vD$B9|
z)Bd{95Jz73yg9oZJEt8t-2a^^yyM}b*jt6ufVcE`HIIXtuTPeVKe`GCRMmrmf*pW~
z%0a?epOUgG--WdV3V^9Zy?wTbz$MYg=d;4mM!zcitAYNt%RB6Ekc@t}IiR5V_1zfN
zz<qt^BygtjG2<sVdh-f0X6b_E)PZNCSO7^^eh1Im=$O0uaQuYs&`s#5RrO+U?GlW=
zX*h1ebQQ|USYP=Dehtucyw3{OQe1RdR{|}t(&bQvvEd5Q)61`5K9h{m-|@1}cL1<6
zSH$eBP3kl09YO|gR@D`D+~?1?&ma9974DnyaB=5|tc_3|=GI=cTnt}Rg=oTLO`asw
zJxT-6szfoL#0PiYz(148Ks!G0nq+L5pB?CeX0M-m`A?2yfpWwPqk{R|j~AoUC8<}8
znTSVkoMcn;VeEgAuv85+0t8|-`pGa2|EUbH&w*j-5F9|~f<l~G%6*KnfDVxjknRAV
z0ZoTdNbO~zG?>$YDRlp|mUiv-oR$_U;V_RP*$rZ1i>TY-(S|Sa3y)C}V@*Oau-9ry
zqKpXzFDl|wJ0IhtKCpA%4*~;Qz$^ZEbW0OxLCPgl4yMgy7JhwQGNW3eXX8yTDfw6K
zzaD}bqoRq!#T%!qo4LgB83Odn{CA}Y8Oi_mzg7Z9YqO0eQ1Ly;_9a_c)^_bB=A{?c
zJappV#!s$35pVUhGvVUK`@97LTZ(T<1r*(Qr6p2I26Mq+8r9l(B^m+2Y;GGUz~nGM
zn*(&c;}Z-m)^neGSy@gQuh+p1XONkk2!Q?m<D4}WBLgDN1Lc2zwnWtKFn3+`yWLoj
z_N?ccT3Y=kZGD*9+0CFLy9j`iJeA+I9iMzjwY3J9I3R(KPubj4Jfo$x>V0Ax4foRo
za)$*Vmc(D9oerFxYb!uudpN2XIF7h22ax3A*&o)we_d9*%CeQi2+Mz%^e?X&2)qXS
zKK5Vh;I$v{K^%Zgt1inALYPR2^-en4jkOJzhb++XRrxX4l7Q1q^{+fkS1D}i?)@>y
zH=&5qp2Tz79N*yoItsloLkRZhP2TlM>6+G;syw?-piu$tx4zxlIUk=FV5=nm>vIJu
z#4Q5>yKgE3LiitXDBg#?<2BGjYjm`h8CVz40ci4{KV*MMjFO*yLK26MH2lwyHHY}0
zN?&L&|DQ6w&%d%Ux3y6Wy__gQu}|s->PAzjA^>I6b%6oY8A(g0vGSM5V0KX)&U*N@
zrJ^L}<r}jGWWbPxQr0&ag2e3Km?mINbCZG6_!(n67Et>*Uc2+3qV3wcQv3{k?hc7A
z=+|9*ETQH+hG;T2F<&VSvb%`ms7T+^02v*KPH*#Qr>5!_V{;i_og8j`1mUAj=-zJW
zKbh(Wk+NhC1JUFxR$kCj&iq|z??T)Ei3MM@{0FG;rSJivB;K_OuUYlI<C@xYPiKVv
zRrcq7QRh%JAAsACJ(jQ%akO}?;M?28c1Hj%UQ)AmUkdjEg3bAIr}oSLAD;eM#s7w<
zpCO+PRq54dq{GnAWpI-Tm$mrdgIojQXlzM7qI@|Ssdi9m+;b>%K1l!WJ@{80@p38X
zysuO@0$1&_Pf5mLNEui#x>t+vu#aWO4oPAR__;;eu}z+s(C7H38#zU{@yDxz0A$2G
zjo7?;xM9yDa{z`8<O}HK3q}`@BHkbHa*#@x?b_{}MKXL@rgtAupX0#-9D~F42Q^fh
zLAH<d?KdJT>*bT~pH$(eb`;3bUIYl{IOIiLtL)g<x4$5Hi4v?yZx{&0a=EjL-i3jh
z6{HxnjOAD$PX;Ll1?a_iUOauy0|cQj3Eu3U!E7e9Qz)oTLBHjZh>1B;QZEY2rn5j3
znAF0`;an2Y^^i$g{-^EZ*0D>_!7not48?P4r!Q=@$X?Hw|4;%3sUD%q_R|BkE_e)(
z#RHfp<N=f((7wVcm0_DOCXJXK(ZLn8b^+;rU7Mh!<P<!-K*w%57`(^lCH(@BlfV#y
zu1^x-C?Jr6UkKW&;O0R_2O3ZZh5{n;`pxy(+PT8g-BjY6Lpw@EQII1J5z9bwLgF3N
zKcyr79#X{uq(v~h>||n=F^e+G<xHJQzdNYm1vje>NkF(M{4+NW;h_9~rx!x9WkCWP
zoA=%X5JO_^{RVoD_MEb27q$qCw3xd9F2m<%zz4n>!vg3IWt}>R$^9S$Y$hqdd1&X|
zfB+s_c7vMxs)-_C)d9XE2H@knJoU9Now0*?kEYVskb7sOZX@>9;}f*fxwy!7-Ys3i
zUsUhQd%)D3@7&M-thoT7sjQW2wD=fuik^cQrrC`B_1wz+112?_N7#xft(umTF9DFL
zzInyHtURYq6Hp=!XK0W31+TTzX!IG#Xl<6%KSRN!nuKqy4u3}#UlFdSX=gY5ZFvFY
z5oETe=l0ptrhA99k1WHW6U%OIP694c(BEnLCFyW;r9(ut785VwGjCT?Xw#KX8FFpv
z!>VAeF?Uxna{Ax25DaD7XdwvT?_(PpM)XxzS7T7tBx!|*1r3zo1ID9zff-5#qHT6C
zFn)%JtXen$jgt~U&_QZT_wh=U$0QD!AqutQ_wzT}9&}I=mgqzBG?8qCq<^M8Z+U9?
z=U)(xj$N6x-06nhHIk_Jmq#acNMSE4KfPmy@=g3o$9fBxCY809n#B@zn_-3kbFhG#
zBzhZV$P;G!6V|n|J)3f^7w*<kNr&w$gNc)D*7U;vmc2h`{x*&Hu+ifMEs_U{!7L!c
zLgzC9v60CAYf8~a-=;Cq4b2ighk>rQ%qhfJjf>}zzRrLU1lBtqs0P3}IT;xI1h$gt
z`myy%iVW-wia;WOQ%{!43lLi;FwWh2*PM~i1$fd&{p&?VSS{1rRuAUzi~#AwaqqVz
z7})r#P*ax)Fh)P(2Lh=A4(J5*?@?3KYTL&Iyx@_IMm{8o=`@z@+>^~Sfew)Sh_CZV
zWbf^cq278gIvW3y08g)tk8CTG^UpT2w77@IpyTo!gzsqIfr3vZ6x^8;7M+kq((Hzf
zU4(=H88?tU<SSxy0i0axqMx+o>L%Ra;J}vc;lL$G?N#45AVtav!CeZqUOG9^Fao*_
z<_u9109AyF^8W2oWeJOnnpOpA7N<e)9V`$QKy$mNR`v-7V7B-l;sVVhxo)tAHcht9
zi~727rJxpSxfynk1U8_q4?SZOwZ2~jKysPc!jmV%CcY3EqXh9AQ<O9*Es(E61`e6T
z;j@`!7V7TP8G!1dTmG&i*DZE`k~kAk8zGVP`D>ufA&gcoaCW9_H23oz6m~s6!@b;b
zc&AO*_V`kDT!0qWVf~vU$Uz|y?!OR3E=8Y`L%<*{vAuIddqsYrr#kK&N^rQ8+v_U1
zl*~ztJI>W)r0WbFD+n;#{A&cVMfVag_tRX?>P8ow?5fUq;C~(FzFy6nzgE?&%!67k
zKn@s*M?$=?fG13VCTO!l09sUGM`Qta_V24+wOA=K6F~xRaNTXCWRsTH9+dq&m!Mo-
zw+!-FCf2Ar0q{RIAb}t1pF;u!!|3=rs<MMXGSC2eyA8h_u)VKO>BU?KO2Pfx3vm8!
z{Hy4y9dc*qyHDzGkI&(AAxGBUmY-iX!BQB3v8)Z-izuZHerjO`Hg&6q483QuQI!oM
zl5Tdb46wWgq}bs<!alwcoMb?P6d`{>M1Cm@WyaqeymQ}Qju-Ydok|BFM9b4}dW`ot
zm(q6&nViac^DivZ|I!;qkwPq#7eKWwmq|izc?Yhg>;2}0z?mH;aO0fZs;=Xht@HBw
zilDXJyQ4`zzxi%2XA2a1eG*T+i}_>DU~sL0r+4XyD8jBiRQ_b39}njzh@FcU?tkNq
z1X&_xn7{Y<5Cux?$k>?P;ekZ#g1VkKcQ&D?UnB_<;dhabr%fP-K(iMXY+F!)pGo25
zMu=VJ{JpsV(yZm__9r^QMyMp<p~w+vDUND=6o4WCdUC4FgIOAzWgX9^Q9ol4&j|J#
zv7g_tSG94ud7{|033S>mfSF}brasNC81L5-wwO-DGddf0wI@=}E=7lqNqi90#)O6X
z_USR}){0!AU++N4urCb&xXVwp^2cp<Ew4v&+Rs=t((I}IoU2waGSSf;!+tM`bp9w2
z4=hO16%k7Dk0h49+`cu90B0CbB)Z}n0_O1dBG7Xk?`p$cJ#6GrvDN=+FERJ{mYdR>
z;AZG0+El;u5Fp3f3P~-GsUNEIdhh4HghTc>CW)GQf#=5p)js7S9&Y>tM~9QryYOZA
zo61U8FV*REaE}?d+mtRfkAwl`yWi!r&OOY(x0*0bY>W1E|FG_dnmWvZ08`J!F)BK?
z(Eis3Ud#EmRusidv#=$=8ZtZ_YO);M9umDN<T*u#zP<z#e81b~!`y=yK|<@WJ)NAU
zb6>}!J1#IPcVe$N+18MuDg$uN3{PNq>*}4b|9Mjm9hb{GoyDVA|M<7*%VV{Ltsstn
zgaXI4Lv^|=0)iBd%5_JCQ@RunE<w$y1YmuokLdxU3JS<Nz3~-^FrXZ?kdq5WQ)E>P
z)v{?<wAyeASFbfkIz8@O{sbLwD=L2h>c5QC(D|Luo-4w<n1mF|e<Hx~Q5{M^45703
z@s@Kq>ak{v<mOj<5AM8Brr;|f_q|+G_$GyP4sc5?`r4WpQX|10t2M5+>4sih7@w!a
zJ>y;UF<mi8dhj9C^1VA25f073376EGmw`3%Ga1=Kf@#?6%jO{s1hXDTV__46;$<bZ
z9Q~@6M2ZMZ{wigP-1XE6!nY!8*rTF3bZ<ktM5fz5d<>k}X}Ze=axe}rtGAg{5=#E$
zc1?q)FfReI6R<!TEvW%`!{@hblv~e|LL9UD#@PN<-O<agHi^8z8PXSEHFu^V<!1BO
z6OZ578M4Z;b2S&8Tmq-5KZB`=Y8t$`g+E}qYg4E&R}@J%EUMQaJ~SV`Qi}(9mj96O
zGaK0p1wBU_gXSnuI%+;;>f|9)`8l=^WFWJNX3!RzcZ)8dACEFFDH7YiJFar~MOe$F
zEJ(f0+meBH{nCCFf=cEi82oqzE}PH7MbC+9qr=rq`{=jaad*LW8m)0IR2AmI*$th<
zOCfALcieH+E)?)`9S(8i(FK&-_mv_A5+knwpG{K_hh<x<R!4aGrsi&M^^My);Yq_m
zC#8=M3Bqb9(^`e8JqLz@o*IXc+(&h#dMIKJG69)Mrtv?8*1FJ~Su2p3XcSXs@Wl{A
zfaMW*eJVa^X0KjQ^hOPIUbke*DNJYvx7fwWN<Or;k>KK9l)+LOscZ12w#aX@*XA=&
z$_@sPz|ACsN>$U~#XhDfQ?zs}NY9VQF5!SoIlHt47YJ9{meHVXzNmMdfsuLeEK8e5
zO&?#_8Pts!qZK$?s>u8w$@4W<JRQpK68*k-0)=8pXfWIxsSo%wwgdgkQz}5umQ!W`
z5Aa6g&O<=rBA#SKyxLXU1hLuPB{l@mS1Liy^qaF-NqHKhF_HvugD@hmx_|)eEe_vO
z!`mqpf~PjZW)>?$jpfhf8Xs2Y-?JPE?___4fV;^3s`?47)6hjZYL%4OPs<0%1Mwno
z#!*rr9Ts#6O}E-i%*<!As*0i0)WK6qVw`q>HY7>ns_pcR2>miTkn14KGLip^`JoO5
z4T%4+&;Uz<3ZAz`SRZ<00gC%~K8B9sEo-P4^~(d;uu969d5&S+Kapyn5woMIdIFX*
zw|;i!BXl#Ns)QD8<A$qE<G>7Lj(97;0&)P<h^%$I9MD(=bYP<=$ZG(%XV)pfgK9#J
ziuH525~z$sLCaA0;$EI~V~YSbF}KAI40)=NX`O#Ps%Cm1>hX50RQjVf9dLk!{sfAu
z$vKK45P+dHzF+ya4$A)p@^SD}ji+6fCHcG}DH;J=%R<4>QS9{_#52&&E|mHYEq%ez
zPaM6se5|t3;1#K`b&Fp$twx^dxE<T13~^uY&V5m0x$C4Wq7(Y{p;3ew3{!MBnS0Sm
zV-99jd$;_Ru3yOja`Ob0Qu3Iyp%j~zvjGk;j-4`*IEe>L5JF0IC0J`^Q&?>pGO2X1
zYf!(#p%s~L$}mHex^Ta}2$Bv82aIeA#qu7v_KdzCUtt#gbiZV6LAG(*z$!p~gxKG<
z-95(#G$)Cy_LAN^XoM)e6-MvP!vqCbcUN_Y@C;~@Uay6zLN^(px@+IuVzaUet#LF#
z1DWn4;kB(T541CSDj3?`|K6SBSjr-dv!m(_AZ|k0<yh25w_1crJkLNJ0wx<^Xcp69
zvkS==#1==pT1$flRb(ykFlV1r`KE#6;%d>Ejc31B2$RtFi;`atjsd!-fqjQ282t{4
z{qd>NJtr>%G2xg3%{4&U#04sjh`R*DF<D~bJRnjOQ&pWkxFU`@1q@p_Rvn`yn_g(6
zXJd)(Pff11eH*X|fGQp4<vrZ*64o1Timwe)rM?4vE0(*0A~>~Vs@Sh$!Ic<vW!%Ux
z%LVSNO<C=<+bE~G^Sv^XouJpjY^Ah|JSUKx_JbZrC+IcxMPJ!={}$w3&%djK0L=iT
z2prCx!N;ea0v71@Q+YYI&k={i!~xXi1Cy)U!ru7TPUB6(meCYE6ZOugtG2h$cF7Ky
z1+Sr7&<X9FfGnJ_1v{H)jQBB7fT@6}Ubvz=N67?edKWKOv8HCN5f4lc<%Y_!!5g!D
zM?2!(?fOsgR+=|E6Rp`J@#;9?3d;Du7U53;>9fgPgfLV(0c}5mzLNI&{hrO*cbH2w
zcDe(z=XN@EBbM&d+5jU>{P`#7z$+M8dEi}}g5X&)m=?4umKcT&Xh9&CeQrr@SU&hB
zy<^MA=EuPhJt+BvPVYs$@8z3-%TG0Ed}!5~)XzN$r@y18l?;CQQ+QZp>uouCXpaZY
zVnlxx2ztDW&HsEBXm)0Jo#8A$ewSDX2RI`<Gct#T4vHS)R4J@K5OE3J$QEbOxbS<p
zK(&s6dvBljdFot<cdG!2M$7FoF4Q?e=s{=qsore`qO5*H-7lK3j7}dAH||A@gQNCF
znV`AMT36r8ZPsPUW%jVCDPnJaHn1#G^e&>+|Al<hIi4rVPV3d{<Q3`wlpiC>a$i!9
zeT8Gk)+IKVy*3k*8#BE|ueOIm-pyBV%XqD$yRbJ(daa??evm06Dt|jU8~J6vlrp^+
zdr0+S=FTfBabTo;>b@L5s(xd5_|0VgcjC>5kMf}+xA*=NuML^sP9>p_*j2~{hg@6s
zsa0R8C>zhxjoGLe1e}RUn>dAMc$tPxxSD7D9<p>T_)zk@*483pf@d^s<~=ArGz&7!
z>aZ^v33i%$UrG;YjT}CNcplasNMFQNIWwJ)Pm)K6ao^o|SgrA$EsOU@2IjmHK0lYv
zHTqFElii=Wu&;LQPLGY9ny(P`+Sa512XCJxlVR7Jhk>(M@56?<v6@GSero*|8H=d^
zM=+<s&6vVE3@1lkPu@|22uC`2iRX`yG(810HRdmp7<pcBHZNK>-mK7XPugRV*<-^P
z2_t9`K?ZFs*q$s3R29i$Yn|-_+U}R{Wfqbr=gp<-f(D*9on#Q+?%vU_7i9P67VqjL
zdC{_H?<|hT(baNEzT)cXzYcF&Ivn47vY3(Bu4p_uR2Iv=!8f)@<6x0CFfgZ%r1qvN
z|1pKPZp)&boF6nW%BESLDG^n7GPuwj1xK1XlE1RT_1lu%Wnpe^2i>^+Vwq~XfnBWU
z&<C-PQ&jf%^#p>JeDc+VL6T>kI(UxDFt6w&a^B+Rlh^41@7$lidweWY|MphyrSeDZ
z=*g!>T`}WtL)bh-ES&AGbWN$4f;Dg@4|Z|8=5X8>Cz_}cqTBPwlZ~ORUtnQoBr%!M
zQLs*dD9jwTV?J7Yej<YG)tShA!Cb)=&+Y~HNADjelg)_)MCv<ieou|lh{v&v)6=!A
zD+oU<5{n8OWNA7_v6E4;tR8Dk^<J2_x_?M<R1EJP9JK!QtWs;ezu_t0`4pjAyH<9{
z>U^#qS${sUo5rV}Puoq8cX8(fLsT?-3ht+s0C5(*FU506-PrOhh6&j}9nFPXOAE(C
zvZupZ&)OeSxanrL1xUDs7B>!DTpYd7^bA~2B0ep-9ysLAo8^YNIeU0%Xc%i16nQn2
zE09d<>$-lwDD>QW5Vm`=HOlEbybUUc5AQ85ts$3(!y%f#2~E>EaFh5H3zJJ0t)f3R
z9NW&mSL;Jh6$kfb_6;^O`geAoE=$WedKQEDnPOX_BsFs457bj^JqNYo%eO}5RZb}7
z^Qr~`bJ0zP=%V{!Sg*@1s-{91n`}pB`&CV)zc2kNyXCJ|7e<o{%A|oGxw_CjI^v)r
z`dbQ)PwOLAt<-PMp{PKqcVy#?e;Vqkbv7ONYFu;Yl&Uh6ANx4%T#<U8PrrKklSgOs
zaV1vyh-B6xWY5ORnzFB5?EWF9-J<>Qaf#i@^1CB>V!48S_0emXH(Q<M7U=8`wB?n8
zHLj+vCH2;1fpa#$jk;;%Sms*GJAUp-49N}++gY}>q+n~_k<Lh$l$A}JcQf7}827}n
zuhZ}{&D82i*71iUNuWIcm<6#>`tns%spv{Hn%7{IG}HTARupr!4!!=gY_~IT&E8Z?
zC;6^hKX89nSv|vTH89$WC|w>KaXd@@BqRmKPiYzJ*EBp-%C+PBc*nG7j)HG&Bv74A
z|4>usvI52umqD)Yi0ZQ1D$PaHuql{d`xeiCKWH8fd%)P;T82SC7^_iJe%}f&pE+|B
z%~tc5;BT3n%6Lk)!WT8|51Jk!XLmW8V=(K>DPPV9W>HzO=WJx{eDju{KDF!4&Ltl>
z(L}{Yi}-pr)i6#PX?-!72XjRU@BjA5+4i4aolVsyVb3r=B^NOsi7Ic6?dEP%={rBY
zeO>0W1?jSIu-H0W!OU;>Dk-sU?oo1qd9z39_mIW%>pW8EW$hHp0t-utvW7xq4sBYw
z#JIZO-)<LNh&iHd!sMd!V^ivm%XhGB-a*O8sVd6K>z`NzK=|sC@QE@P`nv0T-+no2
zC+xf8u9@<ukauOll%UPUCH&>)R_(iV20k{HT(#O-EDv`+YOYUvIsI$>gddwuifPcW
zIsN<$GF&*hs50_6+Ot#yuZS#X+nSzS4_TBDGhrRXesmrw6dk$+?d;EiwGD?U37WIv
zk#gm|qg9mS@M~K98vFw<7iQ>O2DypHkXjKD;k!@Nj~}|69j^~CCs~Fy--`+sMC(ir
zyLS6T!!y6rspOH+b^W`Gz&qSf=jE48#Pa^*g=f>3#TGPmwLcpc>>Scsma`c00y@!4
z*=a4ZQc`@>WzBfUpOC(Na~<)qk9~BS{jO2YBs8qasJNS*z<3d-#+$mIaV`FHCGBTz
zYSl|rm;x8hmgU8pW@4D}MvmZ$pqo1{va!{~)UCFht={M661alv`+}B&0ilp@^c#O`
z+h$dCQFiI2(&WvtglF2Hn%`qhRz8b%2jcbUu&)%@a(g`ph^H7uKfh{zC-idNs4lJ6
zYM{@X#&759o1DzYmFW6(un}}IpH_71e)zFzhgX7dZmCq0HAXZ)fx*nI(G5iiChLs0
zW7i0lb=Z7;)L1Z|v*|lgqx9^iEXM*`H~G-z?-Zj#;hWor<<SRJsoTr`nTs@?7Fu~n
zuT$OHn6kn1>bd@A=QQVZ<q+d^;Um_^C7!Kswtdx{DG}hku=nLwqHgm|p=#PfxQNQ>
z=ONp&<%4JHo`!`9b2%`yNq_TR6_dB`e89<B4xV|EnsR%-MURhK&YpSUy+tzF(l;O9
zAH~Hp2YyUMtMzD;&Z)?7w*BWq7dvY!wjd;XZtq0j-Z%H~tRxl`$a5+l<hg+vpw?{E
z`@ehex0_m8gra1qz9yZuf(gNswSJW@a9GK)-9^P^E(@2!!Xv&?-`lA4Q<<dHmpmSu
z65P-yeRZX*4-xPBkaoJN@9M1XsxA7g9Q@4bY@;06GDaN-U1a-K)cZRtD;6j{cYg8-
zUr!-@*lH>#5L5MT5&pCUmU>Kvkqnzuf_Ss*`fN}`#2psq6D5KcWohx?z4`Jt16_HJ
z16ZT!V_3@E{Jwi{%MqN0I<xYFTdDNJ7Gw7k2}^J@Hrr7^@`+qn^1GEvZiH+(^Mwgx
z3rs6LeG<zWog0_E?PJj*is!w(@cSgU=VTa36|V!ziuw-OM=MHin_*$bA5kg<wDQnl
zHT>J}d=XMa2tQoo#QYs}c$1(#Kd<`X!)#lC@JI2l3>i2(i7wHk6Y`u2F|I>RO?Z>3
zrNveviVG1tm3$d+%td7~L&%xEd#9;M+sT@BFYVkGW@^b_v#Z4}3zo^(2aI-~SH~XX
z!#I$@Y9KSQ7V%JpZj8=-kt@Jrd!1H`qp$m}2z{%Z9A3-K$-<Vu<m9wwCuT3S*(JUH
z!IgwNEoSxLAUn>e8W}DxPyZ@y&oaM1rxe}rX$0)gbl~%sO?v^{O=~lGw^s|zHOB81
zQZeRIxL8%H6=PlQJST1l2vZ*tF|evOkC0&A+^v&m2k}#2ZER`+Tfdu+1$R9Njkb3a
z%COSqW1}DMnn<^WD6opM3T2nN)3L=(b4ErRFTW&cW{V-!rh|Lwd<1*I_D@dV^Zc(Q
zY|bZ*4^x5+<3A6!ad*mx*vPWnMCXoXE?hNQJ&{O=OGepBZE|NQR&01)_EfkziWx6p
z=T$ci?>mh=F^HYDzl%#s3Jb-;nEsV*OvWvwmm3;NE_!S=?4pS=aW$l(?nQwyCq3zO
z#spr)|Iyxie>Ii8aibAN7(u`WDs>!D5d>5^2&gCsNbfbG(h0o=0w^jf0s_)|FM&`)
z2_<4iQIK9DB_JIVij;sP1nxdF_pWvSfp@*Xe6tp7SPtZz?DFhSdpLVjt&GPJ<5e=S
z@SYbS4REuj^Bq(90cv9FzTml^g@SPogVv5ulbh|wmlSJix}urN+p5>tACazJ>{^-F
z+1(ld^V4A9I&tONKN>_^*+!ia)bM9!>?5zY-kX2cKS8FkzEBAI!yIv;rWx<WQQpE7
z^EnRu9UAV2D{!!ZsrbrM!kWx97T3++BHg!SESc#|vT<t0FR}sh9O(2*U2~IAOf6sW
z=HNR+-lnkbT>Quc8?xJvJi4MMaudmT|Lnr1H^D9Z;;R>Yy-p5eroO0e&V}lgLO1*N
zgeq2-A9+{zQwVoa6O-st@rl6U6Ahe7D)HIb#qMnmPU+>%wda*@O$4US4HZ=i4F28G
z(JqYCrJQyRwJ9n}#@^A!B?0_G`?VEF+U`iiQG3zWoVk}{ee}dtd~I1df=@+8?uphX
zQ}G^0V2D^ScsnbS(nyqkPQ#bjH%?T4J;nZgjk(Fd+WI_-_VweTf8+L?f59j(%>kBr
zm#nb3J-O!bnvY}UY@ScA+qi6&g19;%@&$HTRxv{JmE63H3|6b#N%7;&%<F`ySkB?d
z=<}1^fvE+?Te(dgwXGX3k%2wx%8X4}h2w)GafI&#TVHWj&NS8I%8U=Th`v*>+l~ZD
zTlODy%EZ9b)IsF(V)v+o$Kd!l;djSvEz7HFFZ({~o_(Hu-YD2*>WJ&hT-H-jCf0@s
zX{kj8$A8EXy|X56{ogp&aCVJeHbwKUH>FWpdc|;$T1|Yj-HWxBFsxT)F6Qscinp0*
zX&hdo!8s+P$4;<uMDf$<!QXm&jkvkLyUF`K{?JeH*%HNBbCfR|A;~WcNSUFG!!|8_
zWKoc0-FkA7)9tB8HvV_Qij!}YqF!K}=@MHOl8!pD{q*cLxh#1WSRb~Jxr@nrQ}m3-
zZ)x&7qhM?q&q$Etj;Z<U*#4WYvQL{p>9c9x<vyo(C#-)I75zN#;vPMy3@)@w>@TbE
za~ke-P<wp$Im(w9eQ{zeCbTtTo3fROKkwElP2e-v91F<N4-59Mo$*g6SsxcVRU}pP
z`JDI@8Iq+z4y`kal~=MB;b>bMCdY9fA?sWcMetF+<t71-MYI>l_Ef8Lvddw5>qx&s
z){nF7u=n4ur7JR~`b<~0jz)D~uKn})FImo!e(W5#F|Xc(Q>O)T*n7yco3c8TnIo|B
zH+nu%<}H7dmZ*Y)vW$bGlbgP|Jf^)OVWhysAX3^TvB7uAcZg;tHt24p@5qxZe*`YS
z5{qoCYfY~d94V{HRnRs~vxzh$8QCRFvUZ;zQoYx!A`4)?s`X;8HzN|)&=BcPU%fs%
zZ=2a*#Tlt~nAOnLC^sxlJe~-4!G>(bOp@!X&hhbmv1<7GUzsw5TP?1otO&cfpxD36
zB7ay1ZNTo|PtjTGPjYYce*Nigw_w$S_-+TE<(8?M{JrbdQk~s$6mit22eno72YX*y
ziTqy(oc+`kmFw{Zl*)5?Sq2!CDaq4*{GkIA%n1%?U$v+6TbJX__p`5;H6QrWo$~EJ
z5kjad`3cccit9@HC8SqaoaerIwJaepHOgUkcqO%3y~{e#A8r$(3!g<OxDrO(W{W??
z`_lag)NweMi%I2kpWda4<m?PX)%;oIh8Sty&VYh0iKWUV!6WKj<unB&E6$^F%{x3!
z%c8X(74y=wwUy(_A3wsMV9aA~Z2s~*ILE>gxV#>g`Dp(s9#m+n*)%SlhgZ1Y7l2YP
zlQqBfefb7%LzMVwuKtwZ0vdm4|9qc=xj#Kr>R$eFikJfbfYw>}f{LEHqN(NLdt$;r
zZb^SAn0)ma%N|v(Fvq*<y1}*;nb&@2GHvVEy;&b>iv>!Nx_cV-^DG#TIJkc4XVpSp
z$$*{ZY9uZ9&D*z5O-28_xN#CmT`qn5Mz*;+u^<-z@VYHaN31<s>Rpts_CU6~Pz9xu
zf8ep+r*N1gST}Jrg7`%nM4k~p=kly1XJg$8)r_-0N-yK7ao>bPt@GyZ2d$e!XBf*d
z{TkFqHKT6GUtCw5CY)-sPLc>HYC4?brsWs+fF<hTIBE#rjS7e@J0AJUHq<VR`npb6
zPtXX0HjaX+OGCj+Q&-FnLy={V^Sd3t&^C&Vheu=&KmIL;H%uL!SEo=ncKVFCvX+Kc
zQotvMZj1Vn^h8`C!*!_26WoJw@#T<TRO*nB`}tC|#0~r%Qk$4wlTB6qll}I`^Jk3}
z8ML2&d60s~MUs17!ZXKvm#9Uj!*W~|-<y})1hc<Orkp-q(A1l?GIU}u=e7r9I>`XH
zTW=sycLMh4{u!@^_d!DIgWrvU&#QK4-%>H$vQ5KqyGqrC=)8(I)c%kRzbYxo<;S%<
z{Q82OBB+zRs$Z}dm_X$_ukzX<@q;NPa=uit*YihuWTXzBLH#RJp(42ro>ZnY?)@Rb
zth8p6_b4k8t>^Y0fS26V;vJU;US;;=BJzw64JU0hvot*oP1{&g!);KPoX2}^**heo
z0b|Ev{iw}<H`7bOuc~u#5r^I=r-?hQ00463K=ID*t(u<Y^S3?PkR@KdiIR9dW391%
zsTuIQt_Q?p>bc>SvBl6nW~{=~qw75`LBOlk%+YC&>|0@*U5GmNva=igp>-tpwR;;G
zjE__ib)YmM7$-f~H|@E!wSFoSiI~U=nZ11-rxAXzHBoBWD19Ft+GA|!QVKMJxmBB8
zR3BciN|&E6*GP|i0WRdqwa4ElXYR4T^_0<~VAW+-?7Dk!*M8Boq^1)C3zMY2IX3j>
z$wl9_^R2_J>8>x^@#a4#s+ZjOIV0N`H!RHH<d76)gq9v-wRd*Ak{BQ_^J3T`0n_SM
z<&eRT7^?4<cxWAg0c(|OsaiEw&K9FlfX||jKSjLh8lK4>I1^U&U^FNZ6mJpfA65+7
zAFeY${>=2(lAK*vgN0*HKC*bAZrY@BaPtm+FLBT4X_%^BciPE(3yGn}&M|}wt-l>6
zyp)>HW$aF$W%b?pKDp_gD`5qc2b+MsM>YXL9mEn(d46Q5dxmYO_gih51z~5v#-pz<
zy&28`AFewnFfVlXV;aka!Rl8WY{TW}9SAqIwb0a_4muxWoSyxKl9AdPO+MKzuV9&t
z3g|1eC@TNdHCO}|#K3nWk}858pSY~m<>_AEK(+F=E_0m+6TRg~bv6-@L065E1qU7q
z3N7#WIX+Enmfmlw{r%W3J`@!iwntM8V-6#0`X#7_0J)~i)X^#IF2GAMYj4i;kn`VM
zxkrxop`SlH5g^ZRNxoZg$5%(SqI;-~`K5&N^_tNFuY8<q#`M!m0L(>Sc)=sJK8sRJ
zakGsmt_ay#ZRc_9ViLY8p8pVznvy|Et&CaaG^kFD_ji|^<(bKM6v`Z$`JNj<lD}JY
zF?=#zs4{QnOR&|4L}Fu|P-wvHpW2+-6eqxWXuYgG>%E1b;mz^li>-sLcEQ=PgiK9$
z+n1Aj@Y!i!pXU)RetR#Ow*l$1{MCL9b!%6evHRH>xtq95dpvobwvTsQde+>5leU`E
zbCpVrpA0z>I~z%u?i2G!*W+b^$%lgZeW;^TAsFP4ucf7QP-Ne+w$I|{6~3^)7}46<
zc>_KE#6&1maNRI&v_3xGwrs{h<*Y;2nD)iUH0~<h-fM%7Qvz-~GE)aBZv16jf+xyq
z^#VLR`Y=B;4_A$lMLw;S!lhsxdxSl7C-4a1>sP<m4pB*_DtqMc8UN-<zJabTHG`7}
zWTMi8>Q*N1vAeG)Gd9_pZ5itl$;leTI-s?x(03kb$T7qEG*3LT(D!yJ6=W=4HsRyZ
z_b>jiZK%Az{e?x1HGJVi;_#A?q<dm3`?iaxd_ggMtPIOntBAX*^-!W8dfL%kC>2!0
z3cP?r%Vg8~s`G|VQT@pDfX-q!{(KoMOuba79%a_1vOf{>JbVv+rH{R<8|Zx7+g;-^
zQMN)d{*i*A4hc2hif#G~sY*A>O)mMLwjM3b<I9S%u<%*FBT4rWV@YV%gX;FeRFb9G
zjlz3jfld`{86q=m{I0InS++<qK&3XQc?JGWd*#(i+rI|+uuiFa$8*<eTs@wJ9`=nn
z1l!yCZG<~SwaYmyPBMvG&0CA7QLSpQq1yHRGy);SFZ#}rWz4mUXzSSTqd#W8M?^!~
zc5NlXBf?YwvD@}scIuTB(7;^>*IUOdBLxqM4*6N0nKq$!3fF?3A|hKIBh`?0?iooH
zMLXQQW;QlxdiDemzL<1jx3~VRy5>e0;b%-wV^?Yacr%jR7zgdx&hCIv8seup9F<)l
zH;G7}F77fdr0mJf80-H~S#$#WNU`l$8F6Zqw5ELOtb}I2axBKRMm<sZ{{7#}n^7$1
zD#z>0hS7&4d;X8s$WT=(`TV20hZ=ixloztc?$>&EQWx=zi859u)rxO@K)Rp!QI?O|
zpFh&7q}tX!;_-OCHx;?x)Q#}27+vM;4hl*iLEL12()_&c-A$6;VVZxob#C4#43N^x
zCC~at(_T9%1w}p|sV|G$ng3KzKYkQeC&Y9uYP=P%FE`b!rEOY|sEFwlZHBn@!R9VU
z_vAI^9@^3tGm<usC@c4dd%X4FxwO3A>k&to)_3rytCTW+cQNB;CDGVofmaGo7fqL@
z75HR;@*%#X-n2S4y-B^1emP{c%=h!^jpjJz6zj*<vERV5Zh$LIIHktaI9Zfsh1f-v
zP00HOdxY4LR^r?nF9aV%%Zr=G&%82ad;$kYbU*-w8sKlW-~)83yJ({0a(l6CS$WGB
z1V#L6#R$Pi)}?<lhN3gtzsV-*x2xs~85<MGEIIqtFV{%E>uklrNT%}^^E48(Yh6$<
z#)?S)W_Ap@(JkO^a|M?3<isOCru&~wXmlSd-}NVyI^Y6W5pAp}eKSCSJ6PkU{j3dC
zh>6Vm%SmoZQm21)w_*fin$>Wra2OgE8j+$z4nAUE=M#QOlYZ*0FCB&6jy>BTdgC*r
z_T|D^WAboNvoBSktIpfTA*xbH=9+bJCO@Js8a&|!63et#gXx4;Q86iYZr#)gwORFm
z80Vg|z^Sp>tu(l6=mk>hMn>pZ71bQ2b@*)km>R&(y)895z4&T^c)PBaWohW)PfL_<
ziG-O!wG7!!fU_uUGNZ!ku&z^FjZe<)TYvO!`A`~%0K6BI52S(CL+2KtpQN_YZ#3zU
zxdlN1fM=UmLQ8#Ud)Be!@<e`4mDaAxPOWWvL)UNmf_Y?^DqhheS$HeeOR0uO9G2r{
z{A2Z=ETU_;2!WPyxF?q>C1qOtaIN$sjL2z+bVyCA&?SP!8jH64%PH)b=4ag2!El<&
zB};r;4qpBEF(2e;O${%qLD*uwJJxLahFaBFGwX;QXXG|v)0k0p%j8N-bYJ=T8)@E;
zKRjn@wXuYo_*KZdclQG^#Ijb!NJe*3f6Q%Q-JRdArM0(BX=zgiu5Vtrs~Sb@Hsg}9
zT*L6GFD(R{;f$HfT2}#>w_39)9hC~EyagMM<5_umo$JP1Y1FTvkaSXG82AGlrkJiF
z?z3Ed3R1y*VXXWQu8k~C2@HX&X}mmZy7bJxK`Dl}EejNQr30L$qi$3`_+kA+m3H0A
zu4zvvMiM_`z3UIeMA9Hn_v%oMx9E1SSp!8?Xk~b`xWi>+`y6#uU~ZH4R=W)Q)E)<5
z+yI%CCmb9!fPVJn*_YzB_YV|z-%YZy`-QT6j~{SBwTfs8q2lxpM|n=U9SGPMIz&Gb
zg8gD2e;0+v9ta%eou8l21)8R`w^JhvmCMxEI6Uv~{kiq^OR8|aVMVfgiIx^RG0p@t
zv~9ThMsg^Iw5Ry~2TqVB98LS@4+w=v^YdWZs_&2m*TllYB)?7T1NUg4wv!v+9lrVn
zC(@T|iDq?&_gIQrZXtLT<sV*TiFED@KXG5<Xo*HaHWPEpJcV+V%gRPPW%DiX{G6HS
zr3z!stCz;w#NbLhb6X#X-4MFe*3-RVxd3LuCG2j$!J$K~=EcZYt^<t^H~_o-v2^?8
z%imv#L^Tr=tmsv=feW(qRJ>N5b8rkub2|IQ9yvWZDVTQs^4%-%$VC^J?+#0K!tHX~
zHmMu>hzhlNZvXi?6A^G-NDe2AWU#DPOP!aMf0)pr;Q~+;b&b2EN*}(rhb$?>ncCaS
zbbb{zd#v>a9I}HnafQxrl;5eliV3gXLwQwk&99ChH*u@HO(mbq0k9vic0fkexVilk
zKbW8k>ePWFqxC>^Wb*f2Fr3DZwKS7cP&^}Z^Ui}QaU^NGhc8&T{xop&&AA(anp<2f
z<!x32#X$=IfHvm)V~ye(6j^(@-?poKd<8+0I#Oe6z(E~&i#@*<A_kte{x=Yle6Oyt
zRl#63gq6W3ep5D2-X%3L+Dyh;@v9VDCRm0B$2Ayu*^K<-6{lWVS>box@(AqOYZyED
z$M8$XfhsjZy}$csU+ER9wB_X+g#|Vals{l87r;BiV13gP%9VKAAeS-+omj6fnw#u$
z4<)jzYtW77lOJC#sRjiL4?g+m2>8(@eFDo%^2iitB9M`Hr<6_c&0a4;P`9kGJysaO
zBB117w{`zkwrz?4y1ne5;ErK1-;|Hw(c#|f@<BliZ&&YcO^odw_F@;>hpd`ZzZ^r)
z_YDU-iyOF^nIm5i3V=PKSVbl|VWxA#{T$G*d+y`bdv3g4JK6VhDwuk_?@5?oB|t7H
zytIj{oWs?FN7ei>uM$dvkz>*&@YfEyltPGR!@`K}J`1Rp-okkpBzi#uaXYf{cSc*9
zY~kMDl<NLxkaYrmiB?vLU1~Kx`ZBSsyxaslV)J=K>#&lderRX~pLe5No4y#)zRpDe
z7GAFweiXb-4vAw;C~v${z`gDrKD(G@m&+^Is;tbF3b4-5gGC8g_<eomf3MfPxwSQv
zAI2-`;o&+F(<1AUd@BB}67D=K+`)X7j~TqzN3Z;v0ZgOvo&f2%=0FEru<tDUsegZh
z=fuAQ?qtRpDGg3bOJG*0jo&y-|D*MwXN?oV4Ev}s^xy2Q0qZYqt5X&fvVw7pzzBwL
zOboq(^m5PO@%0R6fq4oZ;Q^Nl=iC|%V8y!oB(1dt6#!Z|x-dT8a?wn(^?Wh#u@P<J
zuyFc+7hTdXUAD)qZ%}!aYSJ;dr#Y9SeZt;jue9kO?&49FttwrsAjDUv%=GV~ORAEQ
z(6gG|Ji{kY0ueeuYOmIt<#bWHzKRloYYeQAr>lA*-cPiTz*eLGTatwZ1<5Xx9dv1c
z{DJ*3c<f@c>r#$BHRhOcrQkERV>?M;WN+PaD=Vo&x8$jRE|k&g5;4(2rgC0B3!%Y*
zo1KcZ3K(qSAKBR%4*>zvpWqXMSI*T{xnb7-zW>Se-~GX0=Dh!o0Ql!?|6Lz^m!$sh
zWP<OsA+Z*Eg%|#}$icJ>{I_&rut&~+nE(4fVO7%qdpl@VgV+DY?tcsAf4kzpz3{(^
z@_(y*mg_D6!P}BHs(_?483C!n>7s194v@l!futx%UB~d#4^Yps+qFJ*;A?{PuxonE
zNg2c&Y=BA++}w)%^ndHV#s+zb#rzonG^(LDt>TRVud{EsX5wypKdKAJhXYEIdI`cN
zW<-~fdG_(TOnH@u=f-VzNiyp3zTKH!iSf2$?cy$zam3zgmlaNK9usHcBohSCRXuv#
z7f0IvIqFF57a($(*(cg8T4Ntzu`x03r=Z32Adl6Q8TcugN>U@G#4I^<0AB-3h2L)X
zMd+q|!GD!-S9P^@B#l6L1yY60%t!mXK?k8(Zr!^Y+94a8*s$`186Z}<3S4?aLLPjV
z(z~hDfG@M7sVl1H1%N{#rV^(vOmlafUHfP64}kQ5Lxn!Mm^Es(-V>Wl=-=kZh;4}M
zQR!~VVZR=iWl^N<VLj2`?fGr?aIAc_c{7&Q0JLix;I2SlnX2g6cq45ph|~xS-IaFS
z+Of_Irsl=Cvp}Cl`Zibjleq;G5z$X@0I_B1xMib!ZvMH7m5HQCUZ##(z*}1PCIwM#
ze;LI44qsxnch!;m7eIXUiWD^O_-z-IhLImKdb;|h{4zY?pj;)s;C`1Or1`sT`rUap
zi38wGadplK;uv3S(Z3@;(-tD35LQu<Vh{w$D4273{RG1N>}+nqhf^r5h=obw&Smh&
zuGb5rdY93_Efc{-;zh+)-;NvQ#J0)jAe6RZkgKVKPqu;d4+Rr#Q}~LT-OuI5sS)b@
z9J7GJL8XSln{Q~x9=g_I+I-(TJd8F4uJ2o|GOUAI(n4Fa2G9k%SGtoF#urNd4C@Yd
zPTObPqJEl?M>SpFD536e)Eg*<nF<v;CN0xc%lm>4voL^BP{Z&}z$ub$t`rqrNka|q
zR*X4fRuX`uU8>!)jBaPX3+PknN``mE_=k#Jm1qxrkBYGDN3D!crSS!W5__0_1`qdi
zG4z2oXaDBrwLV)QVUdanSX?)=ms<Q<{ctkO6@|U7nVd1GXP2u&CW+}UW)E8>XMrb+
z?s6~f;LF{A(SW~~AM7qrSf0Ta6!^7tHfWBHqYXSuyCGv4N3v2;DI%6CRmKu1mN-!x
zk5;?}6x#yCTOR=So3&zfAk3%oTiQ0!WJf*OmCWlukJ8~iTM8DUv4ejTrqRzipFX@D
zvOL+XhgZR8>t_8>i#r)wR#r9)vS5%`jfh5DEhIGP$|<&KDAKphA(P9p_JTH$E!6Np
zf4>|XYaCb-yUA9zJvipu%4oMuH2Wdr|5Oev#oN*6PF)66w$MIlnO;~*0}@j-XDYwq
zb>rl$DL6z20kca?G!b%X4ptR<Snu=W{j*%$+Gabi@-1sX8nv{<hlx{HoPkQ%N}af>
zr7J${5!TSs?tQtVN_@AXcGc4!U%wCn%0sx{$wvaSk=ce+3OkKba4hca${Nv$3*FWl
zA&m@d>=awEY`dKQ4Tc7JGv%#c!k_Q4esvEJ0rKUM16v3_e~DQEv}mXAw4_@cDReuQ
zep>G}FrG3*fWHGIIp9=?)SJCuYejqj=?Y#Fw7M2<-O^+rSxW&ebv|zoC^-7+74>Cs
zZQ3Gw97GnhBIbcZv;6srE<~ORaOrQK93FHU8Oh{$Q~`m@#MaKN;W|7sSlxr;{E58r
zHLF$c3jPFH$N3MG?p=S%u3Yp`v>8W#e4?|cL}`*R2hg3jddkrnI};QoV+-(*SPlz-
z!25F!E|7<%Zi8DG%hvZb{<AL)<xrys`lK5rnse~NSEZU;)&kX8m-0sa+CP!FDosGz
zcaSa)LS2=rJ~f~2q7swgx$!l;5buQIP0+Ncs?_M33}f9%himWSY-|q?+uJ8;VB<ps
z^c8rfRqTT>d%=wW%{0a8NMYyYGU=nVU~J$mF81TUM#S`V3=UO#1cb~gjlQ)KJANLy
zfSk>~B6j_w_GlB}Ze=D9eZxcPlsgb#UqjVx%#IDoOr-4&pEK)8&Sh4k4n<rM1$PHB
zXoUrdqQGATOKhmXD-KD;H%kL%Rg57fZO0rNnsC%J00RqxC&osz`d~t!y8|?D7?S%I
zN8-HY3qYt12nS^zZtvZj97>S)Xq1;tN->sGl|7VV(7kyfy#iA|-uC-0^w~8}=Sc^J
z6l4X4qLa!Wx^4%iWSqvhIRceKIq2|@prD|V`klUjd%igbf#V{plklaHCqH=TBZ>Yg
zD`o*1dZ4sc2{M&G`S8Kib+|Vb(AVM~<@^S~Z7bVdCFF<b<c@4Z6QjXE{h!OugHOVE
zi&K_hh{-JUm8_|}mgl(V6HnBA2WNMqiSH8f!D&@?7*f>`+5~a(z};iuS<!uI92Urh
zsc~a{^GkYq={+jqreTeRb~h|R!YcAmUKcFIW#Bd<r@Q476NkS#BuLz9u7o(`foGQp
z5bekR5`MjQGUr2`A!BQ594nby)!x1GG4ukotHi@B3sJ0O_jjOhj$GW08T@%97i5!a
zMzdUWyb8NPd>qh4r1M;rC&_dE1hB(0fcUVMuKv}b7HsURP(nQ(*m4y26zGByX(Tgn
zs*Xf?d}*@JPF+a=v+6f`lwkt&PuA=)b5(Zu(*RZFgXCkpvLeP|Eq))?LY*oG=@_e&
zO8-^yzI7pMD^<1Wxs5pF+@u$;g0!`n&CRO*t$HjSk438Q5f8%*yb{3?m-xXlPvyp)
zG?l{QgWX|CziLp_WkP)eGzWlRHpT~U$WB+x>TvHEot-87AyYt^1Y%VMDW%X6KAsCw
zkRV-|>1X+Ftrb<L&cRMhOg=uO6wOckf|(v^t9;Vr-S(RvL<WAMSzt;f&o#|{ZI92T
zd7mWGb#On+arSGCp(*uW=IaAn6`K!}D!=uyd#vc+F-UZ)$7RXk@y<_CP7S~(KA?{I
zb0-^jf%sxNh8J1Vf$(Uhe^Z%XAg<;E;N!PQCCq!uZ*OalZxi%Nz2(V0$yS*2MNs0P
z*+Vcld&EKdH|KSQE7qgBkHVAJ@WJIE23QBYlB`hYbWlg;!Eyp>Q~EXY$u!r=O!~<1
z|9?fgJQ5&uj2i)8L%0-^(j3{*k3|9@$Zui$oaTVp)Rk}J%^NoIPh9GN@?~Osr%*7h
zw)$YfARdy}wmgOyAKO+w9bseNC_Nmvkb2AwT*H+KHpc2`x2Q-tACFyw()McXH)KF)
zNCYDD)>W<iS1&2IA6I7u*{64Qx(I6mE%@{Ed*W7!5<(ta-72ki{d;fOnt@A`X<FW;
zuWlL?A?OGcK*q8Mh3s)o*m;!fi}+!A_MdmWJd;awk2hine|dhWo|*s`2RaFlpdw^k
z)yqLj#tbCn4;WK62pr06=i9FfcJT$u8!xFKX9|k-Qenf4G5D3-h`Z^xVtI`WEi34U
z)wwDy@dbYAH54^8yW?(RvE!CZk>%Ebjo-#fTYSOuPojkd!&pW~HW``pFq;=O<a#AK
z>I2BU7!G!k31W_^{7_9Zs~?WfXkk;PeJ`S2C<G!tdvd{2LM7*ecnQU3kBHujr5mn|
z*ma6ICPUIOlLrmb;EE~Md5&-r<}F(=<0f3<;n4HX-#}<0O?gncwrOF(j4UMSW^l*A
zgyFApC}H3gOuozwo|D<9YWu@*%4ZPdC@Q#iN~%h<00@mfx7k(A2EzVws=}02u3g}m
z4AF9v{F~K$rbrdQ@&UOd>8H0JMEL(#zDC}i1L~{@NE^qh)RrFn7+d8;ZK>59tS2y{
z*Rn^fx7H>aF!lKrZBd|r^#z@PmP?0Pdi|ovrB?TnE>IL>X!Lgpl(!A*z~2RlSsfOx
z;!NuRwKgYb7Y5h%MMj;h8aR74K~AH<3xDQa_I262@pZq8>(nEaq-9@te#uQg{46$L
zJowc!hZ>2z6wN>Oi#60mz0`X%P2yg5l0jK{#;Y(r-3s=<?nbnxTh}XK>J`Abyxub<
z2{PAE@gjM5>uU}~d3+w8x`mzJxm1ht4xHLqKV1$0SS*r(X+4_ew|6%a^?A3<|MAx;
zI}jWZz2;)Bu{bW20Jhc{;6{UtR=SOb>m>ddAQl`;eC4W>vRY>|OwK++{jvyQMAN2W
zuD^d?zkh$<u-1WGfSZnp=ID2M^KHY6s_18LC4Ti<nTzl1pZk?uTJhk>9FmhQX`kY2
zeq}{(i<$4-yXp6s<hTedfN0MAeOlyGz$=zZ{;HSp-V)^{g|TvR^pbd!i9gr<oAVE(
zWTfYk|Anzx!Klc|!@6l^=4O(?;iC(}jds5sy>%OFGB@%mZ5NX;T4q7_3G1(iw!cKC
zHY}tCEVlV!1rSslKoP=wA}+k>__eX~9<*ZAidZz*C_OxzF{}YxwUI-{zJ*`w(KgEu
z#)q^o+iyyn`zKoQIsJGg{()!zJO<um&H*a)7~f+g%Y*nGp=;i_ZU&Nwpe&#x$>2+N
z5BIAoDcDk;@+(^7iSpfy{xsRJ-xe*<*|0S2CnpcC;XGQl?LQuB#5;Zk3Z?+54+2nf
z2SGLdYu&_G;tG&j4)u6ogho;T!I|eahT1yvf`5y(rTUaq^rR+dWeluLsWKLF7Q(i=
z^xL<;-~7DVL;Pwto#t;?w-A=_7t}Ds&lY2ItSW8b$NxJKm`<@0V^I9TDnCOaz=0<v
zE-|~d3#Q<dfXS|f|MjMgowZ4`91@+^BU?#;GcrAGBB$wz3^>?(Qb(-_ERmwOh8o(L
z*%Q7=ldze#5+NE75I)__H6A1qXMn9Mbc)M@Q#>$em?VGAJU)-Fk{816WcG(#VATM^
z0V0hRg<=$@(~`Ykn9B)z8QNNWJE8K|<nU|G-nTzWMz&8)8O0l$PHua5DBk)*<SO=F
zVYizkK?nP8B3A~10hajQ^LtPrNpk?SYw@-ei8pwB0()F9wqg*3{g$8C(wye{Jfrz}
zq2PBpC^e|<&qq)@h&+BB9S!G_oGL?*vEu$o+%F`VuB(a_TPG&sxBn@rCYF^nTGCIk
zQ3;!1^D!U%GD-twlK8GvSq7jcC>IS9RKWhgtWWowTDR(sTZP`S37?<(<fZ(bwBD7t
zb!kc8VDGIu@|YjXE=fThWW_tD-}|rh5WiG3iC)9R1E=eyBh_zw?-5QwbxLjOWb}5q
zYm7<TmGS{jFmS#qf0%d3?-w+Kd{P(j>C!vrRw&N{wL1A7<j$-{B^8cvt-F$sg#eQZ
zOkf)7E&rJ%8+--mG@^`99@?Z4MA2lX2tfIMj#$i&8M=<GtS^?LV^j7vzDynOUl%lY
zJ;Q`uR6$oOK{yafCoAXg%Y;6Bp__HC@G3y>HgfOu*KMC6?J&V?$Az+<VOrh@o{Yo}
z)5B)=#DS?b<&;{89`FOXP3gx@jUYff%%yDA@(I;inKncA8=Ktc5;D6&_$vS}39#tq
zCNESvrH4?;s^eYnO8e84rA&{$G{Nmw`zgK;^p&g`)LWiUf^{XXeh@@9o^)u0S8OWV
zCHjN0$l1zeF_mhgsQ?b$bH0`P#7{rtjh!Unq9H2(`M!qbX$3XT;d@%T^g@>J(=#KH
zkuZge;`u8jR6mvq=Pi(@gdjHJM|?hz{2>68oH5=&s`tnPv8Km)%yYpd#CssH1gu{R
zE)}dnta7tvyl=Y&>J0x7jV2B#4f&*n+#vi3b|B_yp-&N*5Q>~*mqS94&T?tOm62h*
zrHlNvA#RLq@#<CiuU2s+3ONGnYt7}eOZT1+QD~VY5b|OnQ2_At=vNN)$uycxml59!
zErHg|AvHQSKynd(QJ7-AW$Fy6_=-YI<qmFBiIp!39z$U`X1ov@09QnGmyw}M7a`5G
z9F0!*n@mNKgFo{-Pb{sG1x}X$+Z=?=Ob*v64MW`}AXR0)M+=lSm#8;;6cJ`so9n&@
zTvq`9;SqT4fvR>p@%kp^rm=+^7jaN8Lm3WdD%p0v`0T<+cai^~i5fR4e>!?|n%AiQ
z39b`MRH2WfW~q}P8uY1_CjEOHkR<@E#vBIH!5D_+1L}i(2aF4VVqB_q<A-}vg_4T3
z;wA7^cqA~dKz}1u4yWNl4#ag1Q|iS3IEs{044xY;{@m$+M!)ovPjPwEJe4fA*oD)H
zRO!-<MQjH`nd8>&xibuMODOelVGTU8h(Q02j+;FRLb|`MPjQa-yi&X0<JkQ=4i5)a
zeewp!e`B~h%8CA$KX`I6mGgw4O3dlsA|3Ag6zwJ&2dHJG80G;h6Efyr3f>U*{E?#%
z2!XlgKxB3Yx?nqbbSrfKs!mf7Hvnn<YP%Ww_zWPCLH$r@iSs2-Aa@=_CN@DR==83h
zyy(|s06U-pV)|WuipUdE6H+!PBZyytol}y1q(T8xH`+0-7S{Hp4j_DjBqx9Y#=tbH
z3%sAUzkiEbJgy=4Ls!?9bY@G9<psZA!Vg>eif2U~T2i0@%*^m%b8@i`zRCAJ0KtL}
zmQ#C(!N=IPM+UicZj~iZ0yN=E@rcxnSAoA53BFhxEbvWq@w**3PfE*M)D2GhDSu59
zotzxn@J&P$ovom51^ODlkMU36ffphqkhj+yaGVnK#Vz6g8~jg~u6BMy>jT3U(2jo$
zp6xFeZx3*v<#<n+mM2RMlRAhd&79oHs*VmGI_He!DB0Z(gF|l&kOvzH<SXk=E~jGa
zCwc(C?(D8K224^A=V;CF^nu7#`tV}O^sq)vr_5B=YE>sB%E5MXSWMYL57n@^8CL>`
zJF~H&f#h+#I0@>(1K|}i=v@Jg2M<u23(ElUT~mcu(yq*Dn-x+>dOJc`Ym1<05RpLx
z*}wqO0)bd?6%=pC3E$l^-f#aKB=^0CZUVC!>cRmc#XSyzb7i~mObqDy0(lRhamE8I
zx+5Smv?<erC7D22+ia1VfX{Y}BH*o^x2R^v4S@L#iC7UAi!#FylM*_qCki*7;3yMP
zND4qhl*4)lwIcU6<m*>l#|9U-dh|iE2~MhNB<+kAPYFA%e07Jy8nz)b!uC%Sp`dBM
zGSeCUIq_yv?xO8fZd%$aqanFV3Rq+1iwv3dLTKbbcZdc<X9Z*vfL!#OXXH_)&q5Ud
zqEHwEgg?CHhvv%Tbp-Ux9DRJLiU@Y#!GjZCPbYi8NVD`38{0Mp-!xS(rFTg0-228h
z!DzEqfJ2eAuTtsKi@9%bzgF55!Dfvg)Z#w5hF&A>L&`6^&uon7$~v^kdd~`zfxt`#
zro5w2dI5;k0<QiQEaIS}iQx9qujOKus{wfeJ;r*ijV5}^fq76j$o}E?TV$obLC6f8
zA$)FKqQsEkdV=WUX)x0h5rXF8BI4-Mb&i@xnl)a1o`XVWOANi)#4M8{ASrR5TB#6M
z@}}-C)-SF1A~4xZ`w!9s=EyO4%m|rkQC3oiwrZ?29MGl$sb+h{Rf(500)Q9EvsVjB
z?EsCKdt6K(H1jCFH!e3@TpbVyvl(1aeh|V*trGF~R=SK3gfudnAMp6?&T%D5)RML#
z(3XLgp!aW3J(f4g8+3!~;p=p+E*Ea@Y|58C@(W(61$hN<9Nh7-9W4U4#|;{8o-ytk
zo7fY<8pnYg!WTIg*7&!6lx#ES{+csEfj`ciS*ifQ3-HlUK*3ardWfkR<TcM8e&_jI
zJCE^z`Kw9|dHqD`fLk{6WIwXIg~B{;wavtG&!-4TTVgjq!Ix9*X?VRIN?Qj}3HARS
zAfwoZ+j5h&cY$tTY-f<jvcmz|*&-o|oVi=++?S6PkEs*`{BRq@g_dePxJ1Q@@3yIA
ziHc$dlGzh{yIRE{l~-6`7+s^>Q0rwCv$juhsTkGY73gnG&o&&?hLqb@#<Z=bA>v|!
zrTKiCN2R~{{J%nA@DB&;eeu}8r+Fmz8N$&5qdHu@qvk^DupZoeS}tyL2A~7?j5h0(
zAN}3Va*n#O{mcQeCSdzPO*sN%NdWB0EKa}a{4PP{Zje~*tN$ni)CYYzxU#X5{~{%T
zt9*HB0jv?2yBgQE#?O7vav}MU^K$ag+2x}dP%yVvFDenVl5Y+pROx^5F3y|mCVD>Q
z(lGBmmXDKDbbcwUqfqVcKv1T$^D&gb8}(TjFtfX#JhxN`=oNDFrMNiH3D%f1Cw>-A
zk*?pJwrc~Sg8N7BAKzLQIjvVBCY+VJx?jNL1P59>a=&duRIIXpP?E@@lSKa10s1(~
z3<#e<(usWKFDMCuV`Bn$S%hf9?M=oA9K7iHOdu3VE@bBB+?E9L2S~`1@j|PsOAZ3b
z2OA&X@T$l^w9EBNI1+-F#zt7ZC<1a8C86@PFM~URx<8wcm}-NWiFf&|&f3}AyQS~7
zFQE1C>he+%<j}a^4?mhi7#bQXYx#r$t^}1F762;T#>}ddmHoU7ROPggrEQie#;RUN
z%a=h>bcG^U<cUy4J7YO2<#hSXj3|^27eWQy2K^PjzNev2(2)Nc8YS?$7XA0yf8YJj
q<o{nl;(uw7|MtTFx#&yXA*-0s--dNvM?OK9(!8&G4|Dg?^Zy6$1woep

diff --git a/dev/history/hatch/index.html b/dev/history/hatch/index.html
index 386497377..02b34e2b5 100644
--- a/dev/history/hatch/index.html
+++ b/dev/history/hatch/index.html
@@ -7,4 +7,4 @@
     .gdesc-inner { font-size: 0.75rem; }
     body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color);}
     body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color);}
-    body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style><script src=../../assets/javascripts/glightbox.min.js></script>        <style>
          .commit-tease,
          .user-profile-mini-avatar,
          .avatar,
          .vcard-details,
          .signup-prompt-bg {
            display: none !IMPORTANT;
          }
        </style>
         <script>
          document.addEventListener('DOMContentLoaded', function() {
            this.querySelectorAll('a').forEach(anchor => {
              anchor.addEventListener('click', e => {
                e.preventDefault();

                const redact = new URLSearchParams(window.location.search).get('redact');
                const hasExistingParams = anchor.href.includes('?');
                window.location.href = anchor.href + (hasExistingParams ? `&redact=${redact}` : `?redact=${redact}`);
              });
            });
          });
        </script>
 </head> <body dir=ltr data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#hatch-history class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title=Hatch class="md-header__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Hatch </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Hatch history </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg> </label> </form> <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> </nav> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class="md-tabs__item md-tabs__item--active"> <a href=../.. class=md-tabs__link> Home </a> </li> <li class=md-tabs__item> <a href=../../config/metadata/ class=md-tabs__link> Configuration </a> </li> <li class=md-tabs__item> <a href=../../cli/about/ class=md-tabs__link> CLI </a> </li> <li class=md-tabs__item> <a href=../../plugins/about/ class=md-tabs__link> Plugins </a> </li> <li class=md-tabs__item> <a href=../../how-to/meta/report-issues/ class=md-tabs__link> How-to </a> </li> <li class=md-tabs__item> <a href=../../tutorials/environment/basic-usage/ class=md-tabs__link> Tutorials </a> </li> <li class=md-tabs__item> <a href=../../meta/faq/ class=md-tabs__link> Meta </a> </li> <li class=md-tabs__item> <a href=../../blog/ class=md-tabs__link> Blog </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title=Hatch class="md-nav__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> Hatch </label> <div class=md-nav__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1 checked> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex> <span class=md-ellipsis> Home </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=true> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Home </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_2> <label class=md-nav__link for=__nav_1_2 id=__nav_1_2_label tabindex> <span class=md-ellipsis> Walkthrough </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_2_label aria-expanded=false> <label class=md-nav__title for=__nav_1_2> <span class="md-nav__icon md-icon"></span> Walkthrough </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../intro/ class=md-nav__link> <span class=md-ellipsis> Introduction </span> </a> </li> <li class=md-nav__item> <a href=../../environment/ class=md-nav__link> <span class=md-ellipsis> Environments </span> </a> </li> <li class=md-nav__item> <a href=../../version/ class=md-nav__link> <span class=md-ellipsis> Versioning </span> </a> </li> <li class=md-nav__item> <a href=../../build/ class=md-nav__link> <span class=md-ellipsis> Builds </span> </a> </li> <li class=md-nav__item> <a href=../../publish/ class=md-nav__link> <span class=md-ellipsis> Publishing </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_3> <label class=md-nav__link for=__nav_1_3 id=__nav_1_3_label tabindex> <span class=md-ellipsis> Learn </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_3_label aria-expanded=false> <label class=md-nav__title for=__nav_1_3> <span class="md-nav__icon md-icon"></span> Learn </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../next-steps/ class=md-nav__link> <span class=md-ellipsis> Next steps </span> </a> </li> <li class=md-nav__item> <a href=../../why/ class=md-nav__link> <span class=md-ellipsis> Why Hatch? </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1_4 checked> <label class=md-nav__link for=__nav_1_4 id=__nav_1_4_label tabindex> <span class=md-ellipsis> History </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_4_label aria-expanded=true> <label class=md-nav__title for=__nav_1_4> <span class="md-nav__icon md-icon"></span> History </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Hatch </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Hatch </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#unreleased class=md-nav__link> <span class=md-ellipsis> Unreleased </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.4 class=md-nav__link> <span class=md-ellipsis> 1.9.4 - 2024-03-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.3 class=md-nav__link> <span class=md-ellipsis> 1.9.3 - 2024-01-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.2 class=md-nav__link> <span class=md-ellipsis> 1.9.2 - 2024-01-21 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.1 class=md-nav__link> <span class=md-ellipsis> 1.9.1 - 2023-12-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.0 class=md-nav__link> <span class=md-ellipsis> 1.9.0 - 2023-12-19 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.1 class=md-nav__link> <span class=md-ellipsis> 1.8.1 - 2023-12-14 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.0 class=md-nav__link> <span class=md-ellipsis> 1.8.0 - 2023-12-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.7.0 class=md-nav__link> <span class=md-ellipsis> 1.7.0 - 2023-04-03 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.3 class=md-nav__link> <span class=md-ellipsis> 1.6.3 - 2022-10-24 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.2 class=md-nav__link> <span class=md-ellipsis> 1.6.2 - 2022-10-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.1 class=md-nav__link> <span class=md-ellipsis> 1.6.1 - 2022-10-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.0 class=md-nav__link> <span class=md-ellipsis> 1.6.0 - 2022-10-08 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.5.0 class=md-nav__link> <span class=md-ellipsis> 1.5.0 - 2022-08-28 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.2 class=md-nav__link> <span class=md-ellipsis> 1.4.2 - 2022-08-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.1 class=md-nav__link> <span class=md-ellipsis> 1.4.1 - 2022-08-13 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.0 class=md-nav__link> <span class=md-ellipsis> 1.4.0 - 2022-08-06 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.1 class=md-nav__link> <span class=md-ellipsis> 1.3.1 - 2022-07-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.0 class=md-nav__link> <span class=md-ellipsis> 1.3.0 - 2022-07-10 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.1 class=md-nav__link> <span class=md-ellipsis> 1.2.1 - 2022-05-30 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.0 class=md-nav__link> <span class=md-ellipsis> 1.2.0 - 2022-05-22 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.2 class=md-nav__link> <span class=md-ellipsis> 1.1.2 - 2022-05-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.1 class=md-nav__link> <span class=md-ellipsis> 1.1.1 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.0 class=md-nav__link> <span class=md-ellipsis> 1.1.0 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.0.0 class=md-nav__link> <span class=md-ellipsis> 1.0.0 - 2022-04-28 </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../hatchling/ class=md-nav__link> <span class=md-ellipsis> Hatchling </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_5> <label class=md-nav__link for=__nav_1_5 id=__nav_1_5_label tabindex> <span class=md-ellipsis> Community </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_5_label aria-expanded=false> <label class=md-nav__title for=__nav_1_5> <span class="md-nav__icon md-icon"></span> Community </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../community/users/ class=md-nav__link> <span class=md-ellipsis> Users </span> </a> </li> <li class=md-nav__item> <a href=../../community/highlights/ class=md-nav__link> <span class=md-ellipsis> Highlights </span> </a> </li> <li class=md-nav__item> <a href=../../community/contributing/ class=md-nav__link> <span class=md-ellipsis> Contributing </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex=0> <span class=md-ellipsis> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/metadata/ class=md-nav__link> <span class=md-ellipsis> Metadata </span> </a> </li> <li class=md-nav__item> <a href=../../config/dependency/ class=md-nav__link> <span class=md-ellipsis> Dependencies </span> </a> </li> <li class=md-nav__item> <a href=../../config/build/ class=md-nav__link> <span class=md-ellipsis> Build </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_4> <label class=md-nav__link for=__nav_2_4 id=__nav_2_4_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_4_label aria-expanded=false> <label class=md-nav__title for=__nav_2_4> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/environment/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../config/environment/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_5> <label class=md-nav__link for=__nav_2_5 id=__nav_2_5_label tabindex=0> <span class=md-ellipsis> Internal </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_5_label aria-expanded=false> <label class=md-nav__title for=__nav_2_5> <span class="md-nav__icon md-icon"></span> Internal </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/internal/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../config/internal/static-analysis/ class=md-nav__link> <span class=md-ellipsis> Static analysis </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../config/context/ class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=../../config/project-templates/ class=md-nav__link> <span class=md-ellipsis> Project templates </span> </a> </li> <li class=md-nav__item> <a href=../../config/hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex=0> <span class=md-ellipsis> CLI </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> CLI </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../cli/about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class=md-nav__item> <a href=../../cli/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_2> <label class=md-nav__link for=__nav_4_2 id=__nav_4_2_label tabindex=0> <span class=md-ellipsis> Builder </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_2_label aria-expanded=false> <label class=md-nav__title for=__nav_4_2> <span class="md-nav__icon md-icon"></span> Builder </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/builder/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/wheel/ class=md-nav__link> <span class=md-ellipsis> Wheel </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/sdist/ class=md-nav__link> <span class=md-ellipsis> Source distribution </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/binary/ class=md-nav__link> <span class=md-ellipsis> Binary </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_3> <label class=md-nav__link for=__nav_4_3 id=__nav_4_3_label tabindex=0> <span class=md-ellipsis> Build hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_3_label aria-expanded=false> <label class=md-nav__title for=__nav_4_3> <span class="md-nav__icon md-icon"></span> Build hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/build-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/build-hook/version/ class=md-nav__link> <span class=md-ellipsis> Version </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/build-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_4> <label class=md-nav__link for=__nav_4_4 id=__nav_4_4_label tabindex=0> <span class=md-ellipsis> Metadata hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4_4> <span class="md-nav__icon md-icon"></span> Metadata hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/metadata-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/metadata-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_5> <label class=md-nav__link for=__nav_4_5 id=__nav_4_5_label tabindex=0> <span class=md-ellipsis> Environment </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_5_label aria-expanded=false> <label class=md-nav__title for=__nav_4_5> <span class="md-nav__icon md-icon"></span> Environment </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/environment/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment/virtual/ class=md-nav__link> <span class=md-ellipsis> Virtual </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_6> <label class=md-nav__link for=__nav_4_6 id=__nav_4_6_label tabindex=0> <span class=md-ellipsis> Environment collector </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_6_label aria-expanded=false> <label class=md-nav__title for=__nav_4_6> <span class="md-nav__icon md-icon"></span> Environment collector </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/environment-collector/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment-collector/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment-collector/default/ class=md-nav__link> <span class=md-ellipsis> Default </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_7> <label class=md-nav__link for=__nav_4_7 id=__nav_4_7_label tabindex=0> <span class=md-ellipsis> Publisher </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_7_label aria-expanded=false> <label class=md-nav__title for=__nav_4_7> <span class="md-nav__icon md-icon"></span> Publisher </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/publisher/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/publisher/package-index/ class=md-nav__link> <span class=md-ellipsis> Index </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_8> <label class=md-nav__link for=__nav_4_8 id=__nav_4_8_label tabindex=0> <span class=md-ellipsis> Version source </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_8_label aria-expanded=false> <label class=md-nav__title for=__nav_4_8> <span class="md-nav__icon md-icon"></span> Version source </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/version-source/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/regex/ class=md-nav__link> <span class=md-ellipsis> Regex </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/code/ class=md-nav__link> <span class=md-ellipsis> Code </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/env/ class=md-nav__link> <span class=md-ellipsis> Environment </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_9> <label class=md-nav__link for=__nav_4_9 id=__nav_4_9_label tabindex=0> <span class=md-ellipsis> Version scheme </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_9_label aria-expanded=false> <label class=md-nav__title for=__nav_4_9> <span class="md-nav__icon md-icon"></span> Version scheme </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/version-scheme/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-scheme/standard/ class=md-nav__link> <span class=md-ellipsis> Standard </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../plugins/utilities/ class=md-nav__link> <span class=md-ellipsis> Utilities </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> How-to </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> How-to </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_1> <label class=md-nav__link for=__nav_5_1 id=__nav_5_1_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_1_label aria-expanded=false> <label class=md-nav__title for=__nav_5_1> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/meta/report-issues/ class=md-nav__link> <span class=md-ellipsis> Report issues </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_2> <label class=md-nav__link for=__nav_5_2 id=__nav_5_2_label tabindex=0> <span class=md-ellipsis> Config </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_2_label aria-expanded=false> <label class=md-nav__title for=__nav_5_2> <span class="md-nav__icon md-icon"></span> Config </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/config/dynamic-metadata/ class=md-nav__link> <span class=md-ellipsis> Dynamic metadata </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_3> <label class=md-nav__link for=__nav_5_3 id=__nav_5_3_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_3_label aria-expanded=false> <label class=md-nav__title for=__nav_5_3> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/environment/package-indices/ class=md-nav__link> <span class=md-ellipsis> Package indices </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_4> <label class=md-nav__link for=__nav_5_4 id=__nav_5_4_label tabindex=0> <span class=md-ellipsis> Static analysis </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_4_label aria-expanded=false> <label class=md-nav__title for=__nav_5_4> <span class="md-nav__icon md-icon"></span> Static analysis </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/static-analysis/behavior/ class=md-nav__link> <span class=md-ellipsis> Customize behavior </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_5> <label class=md-nav__link for=__nav_5_5 id=__nav_5_5_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5_5> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/plugins/testing-builds/ class=md-nav__link> <span class=md-ellipsis> Testing builds </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_6> <label class=md-nav__link for=__nav_5_6 id=__nav_5_6_label tabindex=0> <span class=md-ellipsis> Publishing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_6_label aria-expanded=false> <label class=md-nav__title for=__nav_5_6> <span class="md-nav__icon md-icon"></span> Publishing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/publish/auth/ class=md-nav__link> <span class=md-ellipsis> Authentication </span> </a> </li> <li class=md-nav__item> <a href=../../how-to/publish/repo/ class=md-nav__link> <span class=md-ellipsis> Repository selection </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Tutorials </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Tutorials </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_1> <label class=md-nav__link for=__nav_6_1 id=__nav_6_1_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_1_label aria-expanded=false> <label class=md-nav__title for=__nav_6_1> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/environment/basic-usage/ class=md-nav__link> <span class=md-ellipsis> Basic usage </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_2> <label class=md-nav__link for=__nav_6_2 id=__nav_6_2_label tabindex=0> <span class=md-ellipsis> Testing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_2_label aria-expanded=false> <label class=md-nav__title for=__nav_6_2> <span class="md-nav__icon md-icon"></span> Testing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/testing/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../meta/faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../../meta/authors/ class=md-nav__link> <span class=md-ellipsis> Authors </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Blog </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Blog </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/ class=md-nav__link> <span class=md-ellipsis> Blog </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_2> <label class=md-nav__link for=__nav_8_2 id=__nav_8_2_label tabindex=0> <span class=md-ellipsis> Archive </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_2_label aria-expanded=false> <label class=md-nav__title for=__nav_8_2> <span class="md-nav__icon md-icon"></span> Archive </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/archive/2023/ class=md-nav__link> <span class=md-ellipsis> 2023 </span> </a> </li> <li class=md-nav__item> <a href=../../blog/archive/2022/ class=md-nav__link> <span class=md-ellipsis> 2022 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_3> <label class=md-nav__link for=__nav_8_3 id=__nav_8_3_label tabindex=0> <span class=md-ellipsis> Categories </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_3_label aria-expanded=false> <label class=md-nav__title for=__nav_8_3> <span class="md-nav__icon md-icon"></span> Categories </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/category/release/ class=md-nav__link> <span class=md-ellipsis> Release </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#unreleased class=md-nav__link> <span class=md-ellipsis> Unreleased </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.4 class=md-nav__link> <span class=md-ellipsis> 1.9.4 - 2024-03-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.3 class=md-nav__link> <span class=md-ellipsis> 1.9.3 - 2024-01-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.2 class=md-nav__link> <span class=md-ellipsis> 1.9.2 - 2024-01-21 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.1 class=md-nav__link> <span class=md-ellipsis> 1.9.1 - 2023-12-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.0 class=md-nav__link> <span class=md-ellipsis> 1.9.0 - 2023-12-19 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.1 class=md-nav__link> <span class=md-ellipsis> 1.8.1 - 2023-12-14 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.0 class=md-nav__link> <span class=md-ellipsis> 1.8.0 - 2023-12-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.7.0 class=md-nav__link> <span class=md-ellipsis> 1.7.0 - 2023-04-03 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.3 class=md-nav__link> <span class=md-ellipsis> 1.6.3 - 2022-10-24 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.2 class=md-nav__link> <span class=md-ellipsis> 1.6.2 - 2022-10-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.1 class=md-nav__link> <span class=md-ellipsis> 1.6.1 - 2022-10-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.0 class=md-nav__link> <span class=md-ellipsis> 1.6.0 - 2022-10-08 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.5.0 class=md-nav__link> <span class=md-ellipsis> 1.5.0 - 2022-08-28 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.2 class=md-nav__link> <span class=md-ellipsis> 1.4.2 - 2022-08-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.1 class=md-nav__link> <span class=md-ellipsis> 1.4.1 - 2022-08-13 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.0 class=md-nav__link> <span class=md-ellipsis> 1.4.0 - 2022-08-06 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.1 class=md-nav__link> <span class=md-ellipsis> 1.3.1 - 2022-07-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.0 class=md-nav__link> <span class=md-ellipsis> 1.3.0 - 2022-07-10 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.1 class=md-nav__link> <span class=md-ellipsis> 1.2.1 - 2022-05-30 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.0 class=md-nav__link> <span class=md-ellipsis> 1.2.0 - 2022-05-22 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.2 class=md-nav__link> <span class=md-ellipsis> 1.1.2 - 2022-05-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.1 class=md-nav__link> <span class=md-ellipsis> 1.1.1 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.0 class=md-nav__link> <span class=md-ellipsis> 1.1.0 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.0.0 class=md-nav__link> <span class=md-ellipsis> 1.0.0 - 2022-04-28 </span> </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <a href=https://github.com/pypa/hatch/blob/master/docs/history/hatch.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg> </a> <h1 id=hatch-history>Hatch history<a class=headerlink href=#hatch-history title="Permanent link">&para;</a></h1> <hr> <p>All notable changes to Hatch will be documented in this file.</p> <p>The format is based on <a href=https://keepachangelog.com/en/1.0.0/ >Keep a Changelog</a>, and this project adheres to <a href=https://semver.org/spec/v2.0.0.html>Semantic Versioning</a>.</p> <h2 id=unreleased>Unreleased<a class=headerlink href=#unreleased title="Permanent link">&para;</a></h2> <p><strong><em>Added:</em></strong></p> <ul> <li>Add <code>test</code> command</li> <li>Add <code>self report</code> command for submitting pre-populated bug reports to GitHub</li> <li>The reserved environment used for static analysis is now completely configurable</li> <li>Add the following methods to the <code>environment</code> interface for complete control over output during life cycle management: <code>app_status_creation</code>, <code>app_status_pre_installation</code>, <code>app_status_post_installation</code>, <code>app_status_project_installation</code>, <code>app_status_dependency_state_check</code>, <code>app_status_dependency_installation_check</code>, <code>app_status_dependency_synchronization</code></li> <li>Add binaries for 32-bit versions of Windows</li> <li>Read configuration from any <code>~/.pypirc</code> file for the <code>index</code> publisher</li> <li>Use the Git user as the default username for new project URL metadata</li> <li>Add <code>HATCH_DEBUG</code> environment variable that when enabled will show local variables in the case of unhandled tracebacks</li> <li>Upgrade default CPython distributions to 20240224</li> <li>Upgrade Ruff to 0.3.1</li> <li>Upgrade PyApp to 0.15.1 for binary builds</li> <li>Bump the minimum supported version of Hatchling to 1.22.2</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>When projects derive dependencies from metadata hooks, there is now by default a status indicator for when the hooks are executed for better responsiveness</li> <li>Fix dependency inheritance for the template of the <code>types</code> environment for new projects</li> </ul> <h2 id=hatch-v1.9.4><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.4>1.9.4</a> - 2024-03-12<a class=headerlink href=#hatch-v1.9.4 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Limit the maximum version of Hatchling in anticipation of backward incompatible changes</li> </ul> <h2 id=hatch-v1.9.3><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.3>1.9.3</a> - 2024-01-25<a class=headerlink href=#hatch-v1.9.3 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix loading of local plugins to account for newly released versions of a dependency</li> </ul> <h2 id=hatch-v1.9.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.2>1.9.2</a> - 2024-01-21<a class=headerlink href=#hatch-v1.9.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix the default token variable name for publishing to <abbr title="Python Package Index">PyPI</abbr></li> </ul> <h2 id=hatch-v1.9.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.1>1.9.1</a> - 2023-12-25<a class=headerlink href=#hatch-v1.9.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Ensure that the <code>dependency_hash</code> method of the <code>environment</code> interface is called after <code>sync_dependencies</code> for cases where the hash is only known at that point, such as for dependency lockers</li> <li>Only acknowledge the <code>HATCH_PYTHON_VARIANT_*</code> environment variables for Python resolution for supported platforms and architectures</li> <li>Fix Python resolution when there are metadata hooks with unsatisfied dependencies</li> </ul> <h2 id=hatch-v1.9.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.0>1.9.0</a> - 2023-12-19<a class=headerlink href=#hatch-v1.9.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>Environments prefixed by <code>hatch-</code> are now considered internal and used for special purposes such as configuration for static analysis</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Enable docstring formatting by default for static analysis</li> <li>Allow for overriding config of internal environments</li> <li>Concretely state the expected API contract for the environment interface methods <code>find</code> and <code>check_compatibility</code></li> <li>Upgrade Ruff to 0.1.8</li> <li>Bump the minimum supported version of Hatchling to 1.21.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Ignore a project's Python requirement for environments where the project is not installed</li> <li>When not persisting config for static analysis, properly manage internal settings when Ruff's top level table already exists</li> <li>Ignore compatibility checks when environments have already been created, significantly improving performance of environment usage</li> <li>Properly allow overriding of the <code>path</code> option for the <code>virtual</code> environment type</li> <li>Fix nushell activation on non-Windows systems</li> </ul> <h2 id=hatch-v1.8.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.8.1>1.8.1</a> - 2023-12-14<a class=headerlink href=#hatch-v1.8.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix regression in calling subprocesses with updated PATH</li> <li>Fix automatic installation of environment plugins when running as a standalone binary</li> <li>Change default location of Python installations</li> </ul> <h2 id=hatch-v1.8.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.8.0>1.8.0</a> - 2023-12-11<a class=headerlink href=#hatch-v1.8.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>Drop support for Python 3.7</li> <li>The <code>get_build_process</code> method of the <code>environment</code> interface has been removed; plugins should use the new <code>run_builder</code> method instead</li> <li>Remove <code>pyperclip</code> dependency and the <code>--copy</code> flag of the <code>config find</code> command</li> <li>When running the <code>build</code> command all output from builders is now displayed as-is in real time without the stripping of ANSI codes</li> <li>Version information (for Hatch itself) is now derived from Git</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Support Python 3.12</li> <li>Add installers and standalone binaries</li> <li>Add the ability to manage Python installations</li> <li>Add <code>fmt</code> command</li> <li>The <code>virtual</code> environment type can now automatically download requested versions of Python that are not installed</li> <li>Add <code>dependency_hash</code> method to the <code>environment</code> interface</li> <li>The state of installed dependencies for environments is saved as metadata so if dependency definitions have not changed then no checking is performed, which can be computationally expensive</li> <li>The <code>build</code> command now supports backends other than Hatchling</li> <li>Allow the use of <code>features</code> for environments when <code>skip-install</code> is enabled</li> <li>The default is now <code>__token__</code> when prompting for a username for the <code>publish</code> command</li> <li>Add a new <code>run_builder</code> method to the <code>environment</code> interface</li> <li>Bump the minimum supported version of Hatchling to 1.19.0</li> <li>Bump the minimum supported version of <code>click</code> to 8.0.6</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix nushell activation</li> <li>Better handling of flat storage directory hierarchies for the <code>virtual</code> environment type</li> <li>Display useful information when running the <code>version</code> command outside of a project rather than erroring</li> <li>Fix the <code>project metadata</code> command by only capturing stdout from the backend</li> <li>Properly support Google Artifact Registry</li> <li>Fix parsing dependencies for environments when warnings are emitted</li> </ul> <h2 id=hatch-v1.7.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.7.0>1.7.0</a> - 2023-04-03<a class=headerlink href=#hatch-v1.7.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>The <code>src-layout</code> project template option is now enabled by default</li> <li>Non-critical output now goes to stderr</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Add <code>tool.hatch.env.requires</code> configuration to automatically install dependencies for environment and environment collector plugins</li> <li>Add <code>custom</code> environment collector</li> <li>Improve syncing of dependencies provided through Git direct references</li> <li>Add <code>isolated_data_directory</code> attribute to the environment interface</li> <li>Increase the timeout for and add retries to the <code>index</code> publisher</li> <li>Expand home and environment variables in configured cache and data directories</li> <li>Improve readability of exceptions</li> <li>Update project templates</li> <li>Bump the minimum supported version of Hatchling to 1.14.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix displaying the version with the <code>version</code> command when the version is static and build dependencies are unmet</li> <li>Fix build environments for the <code>virtual</code> environment type when storing within a relative path</li> <li>Work around System Integrity Protection on macOS when running commands</li> <li>Allow setuptools metadata migration for projects without <code>setup.py</code> if <code>setup.cfg</code> is present</li> <li>Handle additional edge cases for setuptools metadata migration</li> <li>Support boolean values for the <code>config set</code> command</li> </ul> <h2 id=hatch-v1.6.3><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.3>1.6.3</a> - 2022-10-24<a class=headerlink href=#hatch-v1.6.3 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix <code>version</code> command when the version is dynamic and build dependencies are unmet</li> </ul> <h2 id=hatch-v1.6.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.2>1.6.2</a> - 2022-10-20<a class=headerlink href=#hatch-v1.6.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix getting dynamic metadata from hooks for environments when dependencies are not dynamic</li> </ul> <h2 id=hatch-v1.6.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.1>1.6.1</a> - 2022-10-16<a class=headerlink href=#hatch-v1.6.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Computing the path to the user's home directory now gracefully falls back to <code>~</code> when it cannot be determined</li> </ul> <h2 id=hatch-v1.6.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.0>1.6.0</a> - 2022-10-08<a class=headerlink href=#hatch-v1.6.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>The <code>run_shell_command</code> environment interface method now accepts arbitrary <code>subprocess.Popen</code> keyword arguments. This is not strictly breaking, but will be utilized in upcoming features.</li> <li>The internal directory structure for storing <code>virtual</code> environments is now more nested. This is not breaking, but any local environments will be created anew.</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Add <code>project</code> command group to view details about the project like PEP 621 metadata</li> <li>Better support for auto-detection of environments by tools like Visual Studio Code now that the storage directory of <code>virtual</code> environments will be flat if Hatch's configured <code>virtual</code> environment directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory</li> <li>Build environments for the <code>virtual</code> environment type are now cached for improved performance</li> <li>Add <code>build_environment_exists</code> method to the environment interface for implementations that cache the build environment</li> <li>Add <code>path</code> option to the <code>virtual</code> environment type</li> <li>Add <code>--initialize-auth</code> flag to the <code>index</code> publisher to allow for the saving of authentication information before publishing</li> <li>Support Bash on Windows for the <code>shell</code> command</li> <li>The <code>setuptools</code> migration script no longer modifies the formatting of existing <code>pyproject.toml</code> configuration</li> <li>Bump the minimum supported version of Hatchling to 1.11.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Environments now respect dynamically defined project dependencies</li> <li>The <code>dep hash</code> and all <code>dep show</code> commands now respect dynamically defined project dependencies</li> <li>The <code>env show</code>, <code>dep hash</code>, and all <code>dep show</code> commands now honor context formatting</li> <li>Fix matrix variable inclusion filtering of the <code>run</code> and <code>env run</code> commands when there are multiple possible variables</li> <li>Build environment compatibility is now checked before use</li> <li>Decreasing verbosity now has no affect on output that should always be displayed</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> <li>Environments now respect user defined environment variables for context formatting</li> <li>Update the scripts in the generated test environment template for new projects to reflect the documentation</li> <li>Allow <code>extra-dependencies</code> in environment overrides</li> <li>Depend on <code>packaging</code> explicitly rather than relying on it being a transitive dependency of Hatchling</li> </ul> <h2 id=hatch-v1.5.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.5.0>1.5.0</a> - 2022-08-28<a class=headerlink href=#hatch-v1.5.0 title="Permanent link">&para;</a></h2> <p><strong><em>Added:</em></strong></p> <ul> <li>The <code>index</code> publisher now recognizes repository-specific options</li> <li>Add the <code>--ignore-compat</code> flag to the <code>env run</code> command</li> <li>Setting the <code>HATCH_PYTHON</code> environment variable to <code>self</code> will now force the use of the Python executable Hatch is running on for <code>virtual</code> environment creation</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix the <code>--force-continue</code> flag of the <code>env run</code> command</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> </ul> <h2 id=hatch-v1.4.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.4.2>1.4.2</a> - 2022-08-16<a class=headerlink href=#hatch-v1.4.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix check for updating static versions with the <code>version</code> command when metadata hooks are in use</li> </ul> <h2 id=hatch-v1.4.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.4.1>1.4.1</a> - 2022-08-13<a class=headerlink href=#hatch-v1.4.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix non-detached inheritance disabling for environments</li> </ul> <h2 id=hatch-v1.4.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.4.0>1.4.0</a> - 2022-08-06<a class=headerlink href=#hatch-v1.4.0 title="Permanent link">&para;</a></h2> <p><strong><em>Added:</em></strong></p> <ul> <li>The default Python for <code>virtual</code> environments now checks PATH before using the one Hatch is running on</li> <li>Values for environment <code>env-vars</code> now support context formatting</li> <li>Add <code>name</code> override for environments to allow for regular expression matching</li> <li>The <code>index</code> publisher now better supports non-<abbr title="Python Package Index">PyPI</abbr> indices</li> <li>Add certificate options to the <code>index</code> publisher</li> <li>Display waiting text when checking dependencies and removing environments</li> <li>Display help text the first time the <code>shell</code> command is executed</li> <li>Update project templates with Python 3.11 and the latest versions of various GitHub Actions</li> <li>Add support for Almquist (<code>ash</code>) shells</li> <li>Add <code>hyperlink</code> as a dependency for better handling of package index URLs</li> <li>Bump the minimum supported version of <code>virtualenv</code> to 20.16.2</li> <li>Bump the minimum supported version of <code>tomlkit</code> to 0.11.1</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Acknowledge <code>extra-dependencies</code> for the <code>env show</code> command</li> <li>Fix locating executables within virtual environments on Debian</li> <li>Fix managing the terminal size inside the <code>shell</code> command</li> <li>Fix default code coverage file omission for the <code>src-layout</code> project template option</li> </ul> <h2 id=hatch-v1.3.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.3.1>1.3.1</a> - 2022-07-11<a class=headerlink href=#hatch-v1.3.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Support <code>-h</code>/<code>--help</code> flag for the <code>run</code> command</li> </ul> <h2 id=hatch-v1.3.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.3.0>1.3.0</a> - 2022-07-10<a class=headerlink href=#hatch-v1.3.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>Rename the default publishing plugin from <code>pypi</code> to the more generic <code>index</code></li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Support the absence of <code>pyproject.toml</code> files, as is the case for apps and non-Python projects</li> <li>Hide scripts that start with an underscore for the <code>env show</code> command by default</li> <li>Ignoring the exit codes of commands by prefixing with hyphens now works with entire named scripts</li> <li>Add a way to require confirmation for publishing</li> <li>Add <code>--force-continue</code> flag to the <code>env run</code> command</li> <li>Make tracebacks colorful and less verbose</li> <li>When shell configuration has not been defined, attempt to use the current shell based on parent processes before resorting to the defaults</li> <li>The shell name <code>pwsh</code> is now an alias for <code>powershell</code></li> <li>Remove <code>atomicwrites</code> dependency</li> <li>Relax constraint on <code>userpath</code> dependency</li> <li>Bump the minimum supported version of Hatchling to 1.4.1</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Keep environments in sync with the dependencies of the selected features</li> <li>Use <code>utf-8</code> for all files generated for new projects</li> <li>Escape special characters Git may return in the user name when writing generated files for new projects</li> <li>Normalize the package name to lowercase in <code>setuptools</code> migration script</li> <li>Fix parsing of source distributions during publishing</li> </ul> <h2 id=hatch-v1.2.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.2.1>1.2.1</a> - 2022-05-30<a class=headerlink href=#hatch-v1.2.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix handling of top level <code>data_files</code> in <code>setuptools</code> migration script</li> </ul> <h2 id=hatch-v1.2.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.2.0>1.2.0</a> - 2022-05-22<a class=headerlink href=#hatch-v1.2.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>The <code>enter_shell</code> environment plugin method now accepts an additional <code>args</code> parameter</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Allow context string formatting for environment dependencies</li> <li>Add environment context string formatting fields <code>env_name</code>, <code>env_type</code>, <code>matrix</code>, <code>verbosity</code>, and <code>args</code></li> <li>Support overriding the default arguments used to spawn shells on non-Windows systems</li> <li>Bump the minimum supported version of Hatchling to 1.3.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Improve <code>setuptools</code> migration script</li> </ul> <h2 id=hatch-v1.1.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.1.2>1.1.2</a> - 2022-05-20<a class=headerlink href=#hatch-v1.1.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Bump the minimum supported version of Hatchling to 1.2.0</li> <li>Update project metadata to reflect support for Python 3.11</li> </ul> <h2 id=hatch-v1.1.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.1.1>1.1.1</a> - 2022-05-12<a class=headerlink href=#hatch-v1.1.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix <code>setuptools</code> migration script for non-Windows systems</li> </ul> <h2 id=hatch-v1.1.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.1.0>1.1.0</a> - 2022-05-12<a class=headerlink href=#hatch-v1.1.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>In order to simplify the implementation of command execution for environment plugins, the <code>run_shell_commands</code> method has been replaced by the singular <code>run_shell_command</code>. A new <code>command_context</code> method has been added to more easily satisfy complex use cases.</li> <li>The <code>finalize_command</code> environment plugin method has been removed in favor of the newly introduced context formatting functionality.</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Add context formatting functionality i.e. the ability to insert values into configuration like environment variables and command line arguments</li> <li>Any verbosity for command execution will now always display headers, even for single environments</li> <li>Every executed command is now displayed when running multiple commands or when verbosity is enabled</li> <li>Similar to <code>make</code>, ignore the exit code of executed commands that start with <code>-</code> (a hyphen)</li> <li>Add ability for the <code>--init</code> flag of the <code>new</code> command to automatically migrate <code>setuptools</code> configuration</li> <li>Update project metadata to reflect the adoption by PyPA and production stability</li> </ul> <h2 id=hatch-v1.0.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.0.0>1.0.0</a> - 2022-04-28<a class=headerlink href=#hatch-v1.0.0 title="Permanent link">&para;</a></h2> <p>This is the first stable release of Hatch v1, a complete rewrite. Enjoy!</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 4, 2024</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Contributors> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg> </span> <span>GitHub</span> <nav> <a href=https://github.com/ofek class=md-author title=@ofek> <img src="https://avatars.githubusercontent.com/u/9677399?v=4&size=72" alt=ofek> </a> <a href=https://github.com/juftin class=md-author title=@juftin> <img src="https://avatars.githubusercontent.com/u/49741340?v=4&size=72" alt=juftin> </a> <a href=https://github.com/jcgruenhage class=md-author title=@jcgruenhage> <img src="https://avatars.githubusercontent.com/u/6861958?v=4&size=72" alt=jcgruenhage> </a> <a href=https://github.com/ischaojie class=md-author title=@ischaojie> <img src="https://avatars.githubusercontent.com/u/12986082?v=4&size=72" alt=ischaojie> </a> <a href=https://github.com/pypa/hatch/blob/master/docs/history/hatch.md class="md-author md-author--more"> +4 </a> </nav> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../../why/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Why Hatch?"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Why Hatch? </div> </div> </a> <a href=../hatchling/ class="md-footer__link md-footer__link--next" aria-label="Next: Hatchling"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Hatchling </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; Ofek Lev 2017-present </div> <div> Logo by <a href=https://openai.com/dall-e-2/ target=_blank rel=noopener> DALL·E </a> and <a href=https://boriscrowther.com/ target=_blank rel=noopener> Boris Crowther </a> </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/ofek target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </a> <a href=https://ofek.dev/words/ target=_blank rel=noopener title=ofek.dev class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M192 32c0 17.7 14.3 32 32 32 123.7 0 224 100.3 224 224 0 17.7 14.3 32 32 32s32-14.3 32-32C512 128.9 383.1 0 224 0c-17.7 0-32 14.3-32 32zm0 96c0 17.7 14.3 32 32 32 70.7 0 128 57.3 128 128 0 17.7 14.3 32 32 32s32-14.3 32-32c0-106-86-192-192-192-17.7 0-32 14.3-32 32zm-96 16c0-26.5-21.5-48-48-48S0 117.5 0 144v224c0 79.5 64.5 144 144 144s144-64.5 144-144-64.5-144-144-144h-16v96h16c26.5 0 48 21.5 48 48s-21.5 48-48 48-48-21.5-48-48V144z"/></svg> </a> <a href=https://twitter.com/Ofekmeister target=_blank rel=noopener title=twitter.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg> </a> <a href=https://www.linkedin.com/in/ofeklev/ target=_blank rel=noopener title=www.linkedin.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.action.edit", "content.code.copy", "content.tabs.link", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.1e90e0fb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.1135ae9f.min.js></script> <script>document$.subscribe(() => {const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script></body> </html>
\ No newline at end of file
+    body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style><script src=../../assets/javascripts/glightbox.min.js></script>        <style>
          .commit-tease,
          .user-profile-mini-avatar,
          .avatar,
          .vcard-details,
          .signup-prompt-bg {
            display: none !IMPORTANT;
          }
        </style>
         <script>
          document.addEventListener('DOMContentLoaded', function() {
            this.querySelectorAll('a').forEach(anchor => {
              anchor.addEventListener('click', e => {
                e.preventDefault();

                const redact = new URLSearchParams(window.location.search).get('redact');
                const hasExistingParams = anchor.href.includes('?');
                window.location.href = anchor.href + (hasExistingParams ? `&redact=${redact}` : `?redact=${redact}`);
              });
            });
          });
        </script>
 </head> <body dir=ltr data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#hatch-history class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <div data-md-color-scheme=default data-md-component=outdated hidden> </div> <header class="md-header md-header--shadow md-header--lifted" data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../.. title=Hatch class="md-header__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> Hatch </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> Hatch history </span> </div> </div> </div> <form class=md-header__option data-md-component=palette> <input class=md-option data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme=slate data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to light mode" type=radio name=__palette id=__palette_0> <label class="md-header__button md-icon" title="Switch to light mode" for=__palette_1 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg> </label> <input class=md-option data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme=default data-md-color-primary=indigo data-md-color-accent=indigo aria-label="Switch to dark mode" type=radio name=__palette id=__palette_1> <label class="md-header__button md-icon" title="Switch to dark mode" for=__palette_0 hidden> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg> </label> </form> <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script> <label class="md-header__button md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> </label> <div class=md-search data-md-component=search role=dialog> <label class=md-search__overlay for=__search></label> <div class=md-search__inner role=search> <form class=md-search__form name=search> <input type=text class=md-search__input name=query aria-label=Search placeholder=Search autocapitalize=off autocorrect=off autocomplete=off spellcheck=false data-md-component=search-query required> <label class="md-search__icon md-icon" for=__search> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </label> <nav class=md-search__options aria-label=Search> <button type=reset class="md-search__icon md-icon" title=Clear aria-label=Clear tabindex=-1> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg> </button> </nav> </form> <div class=md-search__output> <div class=md-search__scrollwrap data-md-scrollfix> <div class=md-search-result data-md-component=search-result> <div class=md-search-result__meta> Initializing search </div> <ol class=md-search-result__list role=presentation></ol> </div> </div> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> </nav> <nav class=md-tabs aria-label=Tabs data-md-component=tabs> <div class=md-grid> <ul class=md-tabs__list> <li class="md-tabs__item md-tabs__item--active"> <a href=../.. class=md-tabs__link> Home </a> </li> <li class=md-tabs__item> <a href=../../config/metadata/ class=md-tabs__link> Configuration </a> </li> <li class=md-tabs__item> <a href=../../cli/about/ class=md-tabs__link> CLI </a> </li> <li class=md-tabs__item> <a href=../../plugins/about/ class=md-tabs__link> Plugins </a> </li> <li class=md-tabs__item> <a href=../../how-to/meta/report-issues/ class=md-tabs__link> How-to </a> </li> <li class=md-tabs__item> <a href=../../tutorials/environment/basic-usage/ class=md-tabs__link> Tutorials </a> </li> <li class=md-tabs__item> <a href=../../meta/faq/ class=md-tabs__link> Meta </a> </li> <li class=md-tabs__item> <a href=../../blog/ class=md-tabs__link> Blog </a> </li> </ul> </div> </nav> </header> <div class=md-container data-md-component=container> <main class=md-main data-md-component=main> <div class="md-main__inner md-grid"> <div class="md-sidebar md-sidebar--primary" data-md-component=sidebar data-md-type=navigation> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--primary md-nav--lifted" aria-label=Navigation data-md-level=0> <label class=md-nav__title for=__drawer> <a href=../.. title=Hatch class="md-nav__button md-logo" aria-label=Hatch data-md-component=logo> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M19.5 14.5A7.5 7.5 0 0 1 12 22a7.5 7.5 0 0 1-7.5-7.5C4.5 10.36 7.86 2 12 2c4.14 0 7.5 8.36 7.5 12.5Z"/></svg> </a> Hatch </label> <div class=md-nav__source> <a href=https://github.com/pypa/hatch title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </div> <div class=md-source__repository> pypa/hatch </div> </a> </div> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1 checked> <label class=md-nav__link for=__nav_1 id=__nav_1_label tabindex> <span class=md-ellipsis> Home </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_1_label aria-expanded=true> <label class=md-nav__title for=__nav_1> <span class="md-nav__icon md-icon"></span> Home </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../.. class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_2> <label class=md-nav__link for=__nav_1_2 id=__nav_1_2_label tabindex> <span class=md-ellipsis> Walkthrough </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_2_label aria-expanded=false> <label class=md-nav__title for=__nav_1_2> <span class="md-nav__icon md-icon"></span> Walkthrough </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../install/ class=md-nav__link> <span class=md-ellipsis> Installation </span> </a> </li> <li class=md-nav__item> <a href=../../intro/ class=md-nav__link> <span class=md-ellipsis> Introduction </span> </a> </li> <li class=md-nav__item> <a href=../../environment/ class=md-nav__link> <span class=md-ellipsis> Environments </span> </a> </li> <li class=md-nav__item> <a href=../../version/ class=md-nav__link> <span class=md-ellipsis> Versioning </span> </a> </li> <li class=md-nav__item> <a href=../../build/ class=md-nav__link> <span class=md-ellipsis> Builds </span> </a> </li> <li class=md-nav__item> <a href=../../publish/ class=md-nav__link> <span class=md-ellipsis> Publishing </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_3> <label class=md-nav__link for=__nav_1_3 id=__nav_1_3_label tabindex> <span class=md-ellipsis> Learn </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_3_label aria-expanded=false> <label class=md-nav__title for=__nav_1_3> <span class="md-nav__icon md-icon"></span> Learn </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../next-steps/ class=md-nav__link> <span class=md-ellipsis> Next steps </span> </a> </li> <li class=md-nav__item> <a href=../../why/ class=md-nav__link> <span class=md-ellipsis> Why Hatch? </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle " type=checkbox id=__nav_1_4 checked> <label class=md-nav__link for=__nav_1_4 id=__nav_1_4_label tabindex> <span class=md-ellipsis> History </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_4_label aria-expanded=true> <label class=md-nav__title for=__nav_1_4> <span class="md-nav__icon md-icon"></span> History </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--active"> <input class="md-nav__toggle md-toggle" type=checkbox id=__toc> <label class="md-nav__link md-nav__link--active" for=__toc> <span class=md-ellipsis> Hatch </span> <span class="md-nav__icon md-icon"></span> </label> <a href=./ class="md-nav__link md-nav__link--active"> <span class=md-ellipsis> Hatch </span> </a> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#unreleased class=md-nav__link> <span class=md-ellipsis> Unreleased </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.4 class=md-nav__link> <span class=md-ellipsis> 1.9.4 - 2024-03-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.3 class=md-nav__link> <span class=md-ellipsis> 1.9.3 - 2024-01-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.2 class=md-nav__link> <span class=md-ellipsis> 1.9.2 - 2024-01-21 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.1 class=md-nav__link> <span class=md-ellipsis> 1.9.1 - 2023-12-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.0 class=md-nav__link> <span class=md-ellipsis> 1.9.0 - 2023-12-19 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.1 class=md-nav__link> <span class=md-ellipsis> 1.8.1 - 2023-12-14 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.0 class=md-nav__link> <span class=md-ellipsis> 1.8.0 - 2023-12-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.7.0 class=md-nav__link> <span class=md-ellipsis> 1.7.0 - 2023-04-03 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.3 class=md-nav__link> <span class=md-ellipsis> 1.6.3 - 2022-10-24 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.2 class=md-nav__link> <span class=md-ellipsis> 1.6.2 - 2022-10-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.1 class=md-nav__link> <span class=md-ellipsis> 1.6.1 - 2022-10-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.0 class=md-nav__link> <span class=md-ellipsis> 1.6.0 - 2022-10-08 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.5.0 class=md-nav__link> <span class=md-ellipsis> 1.5.0 - 2022-08-28 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.2 class=md-nav__link> <span class=md-ellipsis> 1.4.2 - 2022-08-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.1 class=md-nav__link> <span class=md-ellipsis> 1.4.1 - 2022-08-13 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.0 class=md-nav__link> <span class=md-ellipsis> 1.4.0 - 2022-08-06 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.1 class=md-nav__link> <span class=md-ellipsis> 1.3.1 - 2022-07-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.0 class=md-nav__link> <span class=md-ellipsis> 1.3.0 - 2022-07-10 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.1 class=md-nav__link> <span class=md-ellipsis> 1.2.1 - 2022-05-30 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.0 class=md-nav__link> <span class=md-ellipsis> 1.2.0 - 2022-05-22 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.2 class=md-nav__link> <span class=md-ellipsis> 1.1.2 - 2022-05-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.1 class=md-nav__link> <span class=md-ellipsis> 1.1.1 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.0 class=md-nav__link> <span class=md-ellipsis> 1.1.0 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.0.0 class=md-nav__link> <span class=md-ellipsis> 1.0.0 - 2022-04-28 </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../hatchling/ class=md-nav__link> <span class=md-ellipsis> Hatchling </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--section md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_1_5> <label class=md-nav__link for=__nav_1_5 id=__nav_1_5_label tabindex> <span class=md-ellipsis> Community </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_1_5_label aria-expanded=false> <label class=md-nav__title for=__nav_1_5> <span class="md-nav__icon md-icon"></span> Community </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../community/users/ class=md-nav__link> <span class=md-ellipsis> Users </span> </a> </li> <li class=md-nav__item> <a href=../../community/highlights/ class=md-nav__link> <span class=md-ellipsis> Highlights </span> </a> </li> <li class=md-nav__item> <a href=../../community/contributing/ class=md-nav__link> <span class=md-ellipsis> Contributing </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2> <label class=md-nav__link for=__nav_2 id=__nav_2_label tabindex=0> <span class=md-ellipsis> Configuration </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_2_label aria-expanded=false> <label class=md-nav__title for=__nav_2> <span class="md-nav__icon md-icon"></span> Configuration </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/metadata/ class=md-nav__link> <span class=md-ellipsis> Metadata </span> </a> </li> <li class=md-nav__item> <a href=../../config/dependency/ class=md-nav__link> <span class=md-ellipsis> Dependencies </span> </a> </li> <li class=md-nav__item> <a href=../../config/build/ class=md-nav__link> <span class=md-ellipsis> Build </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_4> <label class=md-nav__link for=__nav_2_4 id=__nav_2_4_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_4_label aria-expanded=false> <label class=md-nav__title for=__nav_2_4> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/environment/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> <li class=md-nav__item> <a href=../../config/environment/advanced/ class=md-nav__link> <span class=md-ellipsis> Advanced </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_2_5> <label class=md-nav__link for=__nav_2_5 id=__nav_2_5_label tabindex=0> <span class=md-ellipsis> Internal </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_2_5_label aria-expanded=false> <label class=md-nav__title for=__nav_2_5> <span class="md-nav__icon md-icon"></span> Internal </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../config/internal/testing/ class=md-nav__link> <span class=md-ellipsis> Testing </span> </a> </li> <li class=md-nav__item> <a href=../../config/internal/static-analysis/ class=md-nav__link> <span class=md-ellipsis> Static analysis </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../config/context/ class=md-nav__link> <span class=md-ellipsis> Context formatting </span> </a> </li> <li class=md-nav__item> <a href=../../config/project-templates/ class=md-nav__link> <span class=md-ellipsis> Project templates </span> </a> </li> <li class=md-nav__item> <a href=../../config/hatch/ class=md-nav__link> <span class=md-ellipsis> Hatch </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_3> <label class=md-nav__link for=__nav_3 id=__nav_3_label tabindex=0> <span class=md-ellipsis> CLI </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_3_label aria-expanded=false> <label class=md-nav__title for=__nav_3> <span class="md-nav__icon md-icon"></span> CLI </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../cli/about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class=md-nav__item> <a href=../../cli/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4> <label class=md-nav__link for=__nav_4 id=__nav_4_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/about/ class=md-nav__link> <span class=md-ellipsis> About </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_2> <label class=md-nav__link for=__nav_4_2 id=__nav_4_2_label tabindex=0> <span class=md-ellipsis> Builder </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_2_label aria-expanded=false> <label class=md-nav__title for=__nav_4_2> <span class="md-nav__icon md-icon"></span> Builder </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/builder/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/wheel/ class=md-nav__link> <span class=md-ellipsis> Wheel </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/sdist/ class=md-nav__link> <span class=md-ellipsis> Source distribution </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/binary/ class=md-nav__link> <span class=md-ellipsis> Binary </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/builder/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_3> <label class=md-nav__link for=__nav_4_3 id=__nav_4_3_label tabindex=0> <span class=md-ellipsis> Build hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_3_label aria-expanded=false> <label class=md-nav__title for=__nav_4_3> <span class="md-nav__icon md-icon"></span> Build hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/build-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/build-hook/version/ class=md-nav__link> <span class=md-ellipsis> Version </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/build-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_4> <label class=md-nav__link for=__nav_4_4 id=__nav_4_4_label tabindex=0> <span class=md-ellipsis> Metadata hook </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_4_label aria-expanded=false> <label class=md-nav__title for=__nav_4_4> <span class="md-nav__icon md-icon"></span> Metadata hook </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/metadata-hook/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/metadata-hook/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_5> <label class=md-nav__link for=__nav_4_5 id=__nav_4_5_label tabindex=0> <span class=md-ellipsis> Environment </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_5_label aria-expanded=false> <label class=md-nav__title for=__nav_4_5> <span class="md-nav__icon md-icon"></span> Environment </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/environment/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment/virtual/ class=md-nav__link> <span class=md-ellipsis> Virtual </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_6> <label class=md-nav__link for=__nav_4_6 id=__nav_4_6_label tabindex=0> <span class=md-ellipsis> Environment collector </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_6_label aria-expanded=false> <label class=md-nav__title for=__nav_4_6> <span class="md-nav__icon md-icon"></span> Environment collector </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/environment-collector/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment-collector/custom/ class=md-nav__link> <span class=md-ellipsis> Custom </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/environment-collector/default/ class=md-nav__link> <span class=md-ellipsis> Default </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_7> <label class=md-nav__link for=__nav_4_7 id=__nav_4_7_label tabindex=0> <span class=md-ellipsis> Publisher </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_7_label aria-expanded=false> <label class=md-nav__title for=__nav_4_7> <span class="md-nav__icon md-icon"></span> Publisher </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/publisher/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/publisher/package-index/ class=md-nav__link> <span class=md-ellipsis> Index </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_8> <label class=md-nav__link for=__nav_4_8 id=__nav_4_8_label tabindex=0> <span class=md-ellipsis> Version source </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_8_label aria-expanded=false> <label class=md-nav__title for=__nav_4_8> <span class="md-nav__icon md-icon"></span> Version source </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/version-source/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/regex/ class=md-nav__link> <span class=md-ellipsis> Regex </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/code/ class=md-nav__link> <span class=md-ellipsis> Code </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-source/env/ class=md-nav__link> <span class=md-ellipsis> Environment </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_4_9> <label class=md-nav__link for=__nav_4_9 id=__nav_4_9_label tabindex=0> <span class=md-ellipsis> Version scheme </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_4_9_label aria-expanded=false> <label class=md-nav__title for=__nav_4_9> <span class="md-nav__icon md-icon"></span> Version scheme </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../plugins/version-scheme/reference/ class=md-nav__link> <span class=md-ellipsis> Reference </span> </a> </li> <li class=md-nav__item> <a href=../../plugins/version-scheme/standard/ class=md-nav__link> <span class=md-ellipsis> Standard </span> </a> </li> </ul> </nav> </li> <li class=md-nav__item> <a href=../../plugins/utilities/ class=md-nav__link> <span class=md-ellipsis> Utilities </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5> <label class=md-nav__link for=__nav_5 id=__nav_5_label tabindex=0> <span class=md-ellipsis> How-to </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5> <span class="md-nav__icon md-icon"></span> How-to </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_1> <label class=md-nav__link for=__nav_5_1 id=__nav_5_1_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_1_label aria-expanded=false> <label class=md-nav__title for=__nav_5_1> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/meta/report-issues/ class=md-nav__link> <span class=md-ellipsis> Report issues </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_2> <label class=md-nav__link for=__nav_5_2 id=__nav_5_2_label tabindex=0> <span class=md-ellipsis> Config </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_2_label aria-expanded=false> <label class=md-nav__title for=__nav_5_2> <span class="md-nav__icon md-icon"></span> Config </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/config/dynamic-metadata/ class=md-nav__link> <span class=md-ellipsis> Dynamic metadata </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_3> <label class=md-nav__link for=__nav_5_3 id=__nav_5_3_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_3_label aria-expanded=false> <label class=md-nav__title for=__nav_5_3> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/environment/package-indices/ class=md-nav__link> <span class=md-ellipsis> Package indices </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_4> <label class=md-nav__link for=__nav_5_4 id=__nav_5_4_label tabindex=0> <span class=md-ellipsis> Static analysis </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_4_label aria-expanded=false> <label class=md-nav__title for=__nav_5_4> <span class="md-nav__icon md-icon"></span> Static analysis </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/static-analysis/behavior/ class=md-nav__link> <span class=md-ellipsis> Customize behavior </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_5> <label class=md-nav__link for=__nav_5_5 id=__nav_5_5_label tabindex=0> <span class=md-ellipsis> Plugins </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_5_label aria-expanded=false> <label class=md-nav__title for=__nav_5_5> <span class="md-nav__icon md-icon"></span> Plugins </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/plugins/testing-builds/ class=md-nav__link> <span class=md-ellipsis> Testing builds </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_5_6> <label class=md-nav__link for=__nav_5_6 id=__nav_5_6_label tabindex=0> <span class=md-ellipsis> Publishing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_5_6_label aria-expanded=false> <label class=md-nav__title for=__nav_5_6> <span class="md-nav__icon md-icon"></span> Publishing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../how-to/publish/auth/ class=md-nav__link> <span class=md-ellipsis> Authentication </span> </a> </li> <li class=md-nav__item> <a href=../../how-to/publish/repo/ class=md-nav__link> <span class=md-ellipsis> Repository selection </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6> <label class=md-nav__link for=__nav_6 id=__nav_6_label tabindex=0> <span class=md-ellipsis> Tutorials </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_6_label aria-expanded=false> <label class=md-nav__title for=__nav_6> <span class="md-nav__icon md-icon"></span> Tutorials </label> <ul class=md-nav__list data-md-scrollfix> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_1> <label class=md-nav__link for=__nav_6_1 id=__nav_6_1_label tabindex=0> <span class=md-ellipsis> Environments </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_1_label aria-expanded=false> <label class=md-nav__title for=__nav_6_1> <span class="md-nav__icon md-icon"></span> Environments </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/environment/basic-usage/ class=md-nav__link> <span class=md-ellipsis> Basic usage </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_6_2> <label class=md-nav__link for=__nav_6_2 id=__nav_6_2_label tabindex=0> <span class=md-ellipsis> Testing </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_6_2_label aria-expanded=false> <label class=md-nav__title for=__nav_6_2> <span class="md-nav__icon md-icon"></span> Testing </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../tutorials/testing/overview/ class=md-nav__link> <span class=md-ellipsis> Overview </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_7> <label class=md-nav__link for=__nav_7 id=__nav_7_label tabindex=0> <span class=md-ellipsis> Meta </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_7_label aria-expanded=false> <label class=md-nav__title for=__nav_7> <span class="md-nav__icon md-icon"></span> Meta </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../meta/faq/ class=md-nav__link> <span class=md-ellipsis> FAQ </span> </a> </li> <li class=md-nav__item> <a href=../../meta/authors/ class=md-nav__link> <span class=md-ellipsis> Authors </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8> <label class=md-nav__link for=__nav_8 id=__nav_8_label tabindex=0> <span class=md-ellipsis> Blog </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=1 aria-labelledby=__nav_8_label aria-expanded=false> <label class=md-nav__title for=__nav_8> <span class="md-nav__icon md-icon"></span> Blog </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/ class=md-nav__link> <span class=md-ellipsis> Blog </span> </a> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_2> <label class=md-nav__link for=__nav_8_2 id=__nav_8_2_label tabindex=0> <span class=md-ellipsis> Archive </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_2_label aria-expanded=false> <label class=md-nav__title for=__nav_8_2> <span class="md-nav__icon md-icon"></span> Archive </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/archive/2023/ class=md-nav__link> <span class=md-ellipsis> 2023 </span> </a> </li> <li class=md-nav__item> <a href=../../blog/archive/2022/ class=md-nav__link> <span class=md-ellipsis> 2022 </span> </a> </li> </ul> </nav> </li> <li class="md-nav__item md-nav__item--nested"> <input class="md-nav__toggle md-toggle md-toggle--indeterminate" type=checkbox id=__nav_8_3> <label class=md-nav__link for=__nav_8_3 id=__nav_8_3_label tabindex=0> <span class=md-ellipsis> Categories </span> <span class="md-nav__icon md-icon"></span> </label> <nav class=md-nav data-md-level=2 aria-labelledby=__nav_8_3_label aria-expanded=false> <label class=md-nav__title for=__nav_8_3> <span class="md-nav__icon md-icon"></span> Categories </label> <ul class=md-nav__list data-md-scrollfix> <li class=md-nav__item> <a href=../../blog/category/release/ class=md-nav__link> <span class=md-ellipsis> Release </span> </a> </li> </ul> </nav> </li> </ul> </nav> </li> </ul> </nav> </div> </div> </div> <div class="md-sidebar md-sidebar--secondary" data-md-component=sidebar data-md-type=toc> <div class=md-sidebar__scrollwrap> <div class=md-sidebar__inner> <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> <label class=md-nav__title for=__toc> <span class="md-nav__icon md-icon"></span> Table of contents </label> <ul class=md-nav__list data-md-component=toc data-md-scrollfix> <li class=md-nav__item> <a href=#unreleased class=md-nav__link> <span class=md-ellipsis> Unreleased </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.4 class=md-nav__link> <span class=md-ellipsis> 1.9.4 - 2024-03-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.3 class=md-nav__link> <span class=md-ellipsis> 1.9.3 - 2024-01-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.2 class=md-nav__link> <span class=md-ellipsis> 1.9.2 - 2024-01-21 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.1 class=md-nav__link> <span class=md-ellipsis> 1.9.1 - 2023-12-25 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.9.0 class=md-nav__link> <span class=md-ellipsis> 1.9.0 - 2023-12-19 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.1 class=md-nav__link> <span class=md-ellipsis> 1.8.1 - 2023-12-14 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.8.0 class=md-nav__link> <span class=md-ellipsis> 1.8.0 - 2023-12-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.7.0 class=md-nav__link> <span class=md-ellipsis> 1.7.0 - 2023-04-03 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.3 class=md-nav__link> <span class=md-ellipsis> 1.6.3 - 2022-10-24 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.2 class=md-nav__link> <span class=md-ellipsis> 1.6.2 - 2022-10-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.1 class=md-nav__link> <span class=md-ellipsis> 1.6.1 - 2022-10-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.6.0 class=md-nav__link> <span class=md-ellipsis> 1.6.0 - 2022-10-08 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.5.0 class=md-nav__link> <span class=md-ellipsis> 1.5.0 - 2022-08-28 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.2 class=md-nav__link> <span class=md-ellipsis> 1.4.2 - 2022-08-16 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.1 class=md-nav__link> <span class=md-ellipsis> 1.4.1 - 2022-08-13 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.4.0 class=md-nav__link> <span class=md-ellipsis> 1.4.0 - 2022-08-06 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.1 class=md-nav__link> <span class=md-ellipsis> 1.3.1 - 2022-07-11 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.3.0 class=md-nav__link> <span class=md-ellipsis> 1.3.0 - 2022-07-10 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.1 class=md-nav__link> <span class=md-ellipsis> 1.2.1 - 2022-05-30 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.2.0 class=md-nav__link> <span class=md-ellipsis> 1.2.0 - 2022-05-22 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.2 class=md-nav__link> <span class=md-ellipsis> 1.1.2 - 2022-05-20 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.1 class=md-nav__link> <span class=md-ellipsis> 1.1.1 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.1.0 class=md-nav__link> <span class=md-ellipsis> 1.1.0 - 2022-05-12 </span> </a> </li> <li class=md-nav__item> <a href=#hatch-v1.0.0 class=md-nav__link> <span class=md-ellipsis> 1.0.0 - 2022-04-28 </span> </a> </li> </ul> </nav> </div> </div> </div> <div class=md-content data-md-component=content> <article class="md-content__inner md-typeset"> <a href=https://github.com/pypa/hatch/blob/master/docs/history/hatch.md title="Edit this page" class="md-content__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4v-2m10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1 2.1 2.1Z"/></svg> </a> <h1 id=hatch-history>Hatch history<a class=headerlink href=#hatch-history title="Permanent link">&para;</a></h1> <hr> <p>All notable changes to Hatch will be documented in this file.</p> <p>The format is based on <a href=https://keepachangelog.com/en/1.0.0/ >Keep a Changelog</a>, and this project adheres to <a href=https://semver.org/spec/v2.0.0.html>Semantic Versioning</a>.</p> <h2 id=unreleased>Unreleased<a class=headerlink href=#unreleased title="Permanent link">&para;</a></h2> <p><strong><em>Added:</em></strong></p> <ul> <li>Add <code>test</code> command</li> <li>Add <code>self report</code> command for submitting pre-populated bug reports to GitHub</li> <li>The reserved environment used for static analysis is now completely configurable</li> <li>Add the following methods to the <code>environment</code> interface for complete control over output during life cycle management: <code>app_status_creation</code>, <code>app_status_pre_installation</code>, <code>app_status_post_installation</code>, <code>app_status_project_installation</code>, <code>app_status_dependency_state_check</code>, <code>app_status_dependency_installation_check</code>, <code>app_status_dependency_synchronization</code></li> <li>Add binaries for 32-bit versions of Windows</li> <li>Read configuration from any <code>~/.pypirc</code> file for the <code>index</code> publisher</li> <li>Use the Git user as the default username for new project URL metadata</li> <li>Add <code>HATCH_DEBUG</code> environment variable that when enabled will show local variables in the case of unhandled tracebacks</li> <li>Upgrade default CPython distributions to 20240224</li> <li>Upgrade Ruff to 0.3.1</li> <li>Upgrade PyApp to 0.15.1 for binary builds</li> <li>Bump the minimum supported version of Hatchling to 1.22.2</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>When projects derive dependencies from metadata hooks, there is now by default a status indicator for when the hooks are executed for better responsiveness</li> <li>Properly support projects with a <code>pyproject.toml</code> file but no <code>project</code> table e.g. applications</li> <li>Fix dependency inheritance for the template of the <code>types</code> environment for new projects</li> </ul> <h2 id=hatch-v1.9.4><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.4>1.9.4</a> - 2024-03-12<a class=headerlink href=#hatch-v1.9.4 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Limit the maximum version of Hatchling in anticipation of backward incompatible changes</li> </ul> <h2 id=hatch-v1.9.3><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.3>1.9.3</a> - 2024-01-25<a class=headerlink href=#hatch-v1.9.3 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix loading of local plugins to account for newly released versions of a dependency</li> </ul> <h2 id=hatch-v1.9.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.2>1.9.2</a> - 2024-01-21<a class=headerlink href=#hatch-v1.9.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix the default token variable name for publishing to <abbr title="Python Package Index">PyPI</abbr></li> </ul> <h2 id=hatch-v1.9.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.1>1.9.1</a> - 2023-12-25<a class=headerlink href=#hatch-v1.9.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Ensure that the <code>dependency_hash</code> method of the <code>environment</code> interface is called after <code>sync_dependencies</code> for cases where the hash is only known at that point, such as for dependency lockers</li> <li>Only acknowledge the <code>HATCH_PYTHON_VARIANT_*</code> environment variables for Python resolution for supported platforms and architectures</li> <li>Fix Python resolution when there are metadata hooks with unsatisfied dependencies</li> </ul> <h2 id=hatch-v1.9.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.9.0>1.9.0</a> - 2023-12-19<a class=headerlink href=#hatch-v1.9.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>Environments prefixed by <code>hatch-</code> are now considered internal and used for special purposes such as configuration for static analysis</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Enable docstring formatting by default for static analysis</li> <li>Allow for overriding config of internal environments</li> <li>Concretely state the expected API contract for the environment interface methods <code>find</code> and <code>check_compatibility</code></li> <li>Upgrade Ruff to 0.1.8</li> <li>Bump the minimum supported version of Hatchling to 1.21.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Ignore a project's Python requirement for environments where the project is not installed</li> <li>When not persisting config for static analysis, properly manage internal settings when Ruff's top level table already exists</li> <li>Ignore compatibility checks when environments have already been created, significantly improving performance of environment usage</li> <li>Properly allow overriding of the <code>path</code> option for the <code>virtual</code> environment type</li> <li>Fix nushell activation on non-Windows systems</li> </ul> <h2 id=hatch-v1.8.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.8.1>1.8.1</a> - 2023-12-14<a class=headerlink href=#hatch-v1.8.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix regression in calling subprocesses with updated PATH</li> <li>Fix automatic installation of environment plugins when running as a standalone binary</li> <li>Change default location of Python installations</li> </ul> <h2 id=hatch-v1.8.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.8.0>1.8.0</a> - 2023-12-11<a class=headerlink href=#hatch-v1.8.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>Drop support for Python 3.7</li> <li>The <code>get_build_process</code> method of the <code>environment</code> interface has been removed; plugins should use the new <code>run_builder</code> method instead</li> <li>Remove <code>pyperclip</code> dependency and the <code>--copy</code> flag of the <code>config find</code> command</li> <li>When running the <code>build</code> command all output from builders is now displayed as-is in real time without the stripping of ANSI codes</li> <li>Version information (for Hatch itself) is now derived from Git</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Support Python 3.12</li> <li>Add installers and standalone binaries</li> <li>Add the ability to manage Python installations</li> <li>Add <code>fmt</code> command</li> <li>The <code>virtual</code> environment type can now automatically download requested versions of Python that are not installed</li> <li>Add <code>dependency_hash</code> method to the <code>environment</code> interface</li> <li>The state of installed dependencies for environments is saved as metadata so if dependency definitions have not changed then no checking is performed, which can be computationally expensive</li> <li>The <code>build</code> command now supports backends other than Hatchling</li> <li>Allow the use of <code>features</code> for environments when <code>skip-install</code> is enabled</li> <li>The default is now <code>__token__</code> when prompting for a username for the <code>publish</code> command</li> <li>Add a new <code>run_builder</code> method to the <code>environment</code> interface</li> <li>Bump the minimum supported version of Hatchling to 1.19.0</li> <li>Bump the minimum supported version of <code>click</code> to 8.0.6</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix nushell activation</li> <li>Better handling of flat storage directory hierarchies for the <code>virtual</code> environment type</li> <li>Display useful information when running the <code>version</code> command outside of a project rather than erroring</li> <li>Fix the <code>project metadata</code> command by only capturing stdout from the backend</li> <li>Properly support Google Artifact Registry</li> <li>Fix parsing dependencies for environments when warnings are emitted</li> </ul> <h2 id=hatch-v1.7.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.7.0>1.7.0</a> - 2023-04-03<a class=headerlink href=#hatch-v1.7.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>The <code>src-layout</code> project template option is now enabled by default</li> <li>Non-critical output now goes to stderr</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Add <code>tool.hatch.env.requires</code> configuration to automatically install dependencies for environment and environment collector plugins</li> <li>Add <code>custom</code> environment collector</li> <li>Improve syncing of dependencies provided through Git direct references</li> <li>Add <code>isolated_data_directory</code> attribute to the environment interface</li> <li>Increase the timeout for and add retries to the <code>index</code> publisher</li> <li>Expand home and environment variables in configured cache and data directories</li> <li>Improve readability of exceptions</li> <li>Update project templates</li> <li>Bump the minimum supported version of Hatchling to 1.14.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix displaying the version with the <code>version</code> command when the version is static and build dependencies are unmet</li> <li>Fix build environments for the <code>virtual</code> environment type when storing within a relative path</li> <li>Work around System Integrity Protection on macOS when running commands</li> <li>Allow setuptools metadata migration for projects without <code>setup.py</code> if <code>setup.cfg</code> is present</li> <li>Handle additional edge cases for setuptools metadata migration</li> <li>Support boolean values for the <code>config set</code> command</li> </ul> <h2 id=hatch-v1.6.3><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.3>1.6.3</a> - 2022-10-24<a class=headerlink href=#hatch-v1.6.3 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix <code>version</code> command when the version is dynamic and build dependencies are unmet</li> </ul> <h2 id=hatch-v1.6.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.2>1.6.2</a> - 2022-10-20<a class=headerlink href=#hatch-v1.6.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix getting dynamic metadata from hooks for environments when dependencies are not dynamic</li> </ul> <h2 id=hatch-v1.6.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.1>1.6.1</a> - 2022-10-16<a class=headerlink href=#hatch-v1.6.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Computing the path to the user's home directory now gracefully falls back to <code>~</code> when it cannot be determined</li> </ul> <h2 id=hatch-v1.6.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.6.0>1.6.0</a> - 2022-10-08<a class=headerlink href=#hatch-v1.6.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>The <code>run_shell_command</code> environment interface method now accepts arbitrary <code>subprocess.Popen</code> keyword arguments. This is not strictly breaking, but will be utilized in upcoming features.</li> <li>The internal directory structure for storing <code>virtual</code> environments is now more nested. This is not breaking, but any local environments will be created anew.</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Add <code>project</code> command group to view details about the project like PEP 621 metadata</li> <li>Better support for auto-detection of environments by tools like Visual Studio Code now that the storage directory of <code>virtual</code> environments will be flat if Hatch's configured <code>virtual</code> environment directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory</li> <li>Build environments for the <code>virtual</code> environment type are now cached for improved performance</li> <li>Add <code>build_environment_exists</code> method to the environment interface for implementations that cache the build environment</li> <li>Add <code>path</code> option to the <code>virtual</code> environment type</li> <li>Add <code>--initialize-auth</code> flag to the <code>index</code> publisher to allow for the saving of authentication information before publishing</li> <li>Support Bash on Windows for the <code>shell</code> command</li> <li>The <code>setuptools</code> migration script no longer modifies the formatting of existing <code>pyproject.toml</code> configuration</li> <li>Bump the minimum supported version of Hatchling to 1.11.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Environments now respect dynamically defined project dependencies</li> <li>The <code>dep hash</code> and all <code>dep show</code> commands now respect dynamically defined project dependencies</li> <li>The <code>env show</code>, <code>dep hash</code>, and all <code>dep show</code> commands now honor context formatting</li> <li>Fix matrix variable inclusion filtering of the <code>run</code> and <code>env run</code> commands when there are multiple possible variables</li> <li>Build environment compatibility is now checked before use</li> <li>Decreasing verbosity now has no affect on output that should always be displayed</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> <li>Environments now respect user defined environment variables for context formatting</li> <li>Update the scripts in the generated test environment template for new projects to reflect the documentation</li> <li>Allow <code>extra-dependencies</code> in environment overrides</li> <li>Depend on <code>packaging</code> explicitly rather than relying on it being a transitive dependency of Hatchling</li> </ul> <h2 id=hatch-v1.5.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.5.0>1.5.0</a> - 2022-08-28<a class=headerlink href=#hatch-v1.5.0 title="Permanent link">&para;</a></h2> <p><strong><em>Added:</em></strong></p> <ul> <li>The <code>index</code> publisher now recognizes repository-specific options</li> <li>Add the <code>--ignore-compat</code> flag to the <code>env run</code> command</li> <li>Setting the <code>HATCH_PYTHON</code> environment variable to <code>self</code> will now force the use of the Python executable Hatch is running on for <code>virtual</code> environment creation</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix the <code>--force-continue</code> flag of the <code>env run</code> command</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> </ul> <h2 id=hatch-v1.4.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.4.2>1.4.2</a> - 2022-08-16<a class=headerlink href=#hatch-v1.4.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix check for updating static versions with the <code>version</code> command when metadata hooks are in use</li> </ul> <h2 id=hatch-v1.4.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.4.1>1.4.1</a> - 2022-08-13<a class=headerlink href=#hatch-v1.4.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix non-detached inheritance disabling for environments</li> </ul> <h2 id=hatch-v1.4.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.4.0>1.4.0</a> - 2022-08-06<a class=headerlink href=#hatch-v1.4.0 title="Permanent link">&para;</a></h2> <p><strong><em>Added:</em></strong></p> <ul> <li>The default Python for <code>virtual</code> environments now checks PATH before using the one Hatch is running on</li> <li>Values for environment <code>env-vars</code> now support context formatting</li> <li>Add <code>name</code> override for environments to allow for regular expression matching</li> <li>The <code>index</code> publisher now better supports non-<abbr title="Python Package Index">PyPI</abbr> indices</li> <li>Add certificate options to the <code>index</code> publisher</li> <li>Display waiting text when checking dependencies and removing environments</li> <li>Display help text the first time the <code>shell</code> command is executed</li> <li>Update project templates with Python 3.11 and the latest versions of various GitHub Actions</li> <li>Add support for Almquist (<code>ash</code>) shells</li> <li>Add <code>hyperlink</code> as a dependency for better handling of package index URLs</li> <li>Bump the minimum supported version of <code>virtualenv</code> to 20.16.2</li> <li>Bump the minimum supported version of <code>tomlkit</code> to 0.11.1</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Acknowledge <code>extra-dependencies</code> for the <code>env show</code> command</li> <li>Fix locating executables within virtual environments on Debian</li> <li>Fix managing the terminal size inside the <code>shell</code> command</li> <li>Fix default code coverage file omission for the <code>src-layout</code> project template option</li> </ul> <h2 id=hatch-v1.3.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.3.1>1.3.1</a> - 2022-07-11<a class=headerlink href=#hatch-v1.3.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Support <code>-h</code>/<code>--help</code> flag for the <code>run</code> command</li> </ul> <h2 id=hatch-v1.3.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.3.0>1.3.0</a> - 2022-07-10<a class=headerlink href=#hatch-v1.3.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>Rename the default publishing plugin from <code>pypi</code> to the more generic <code>index</code></li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Support the absence of <code>pyproject.toml</code> files, as is the case for apps and non-Python projects</li> <li>Hide scripts that start with an underscore for the <code>env show</code> command by default</li> <li>Ignoring the exit codes of commands by prefixing with hyphens now works with entire named scripts</li> <li>Add a way to require confirmation for publishing</li> <li>Add <code>--force-continue</code> flag to the <code>env run</code> command</li> <li>Make tracebacks colorful and less verbose</li> <li>When shell configuration has not been defined, attempt to use the current shell based on parent processes before resorting to the defaults</li> <li>The shell name <code>pwsh</code> is now an alias for <code>powershell</code></li> <li>Remove <code>atomicwrites</code> dependency</li> <li>Relax constraint on <code>userpath</code> dependency</li> <li>Bump the minimum supported version of Hatchling to 1.4.1</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Keep environments in sync with the dependencies of the selected features</li> <li>Use <code>utf-8</code> for all files generated for new projects</li> <li>Escape special characters Git may return in the user name when writing generated files for new projects</li> <li>Normalize the package name to lowercase in <code>setuptools</code> migration script</li> <li>Fix parsing of source distributions during publishing</li> </ul> <h2 id=hatch-v1.2.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.2.1>1.2.1</a> - 2022-05-30<a class=headerlink href=#hatch-v1.2.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix handling of top level <code>data_files</code> in <code>setuptools</code> migration script</li> </ul> <h2 id=hatch-v1.2.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.2.0>1.2.0</a> - 2022-05-22<a class=headerlink href=#hatch-v1.2.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>The <code>enter_shell</code> environment plugin method now accepts an additional <code>args</code> parameter</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Allow context string formatting for environment dependencies</li> <li>Add environment context string formatting fields <code>env_name</code>, <code>env_type</code>, <code>matrix</code>, <code>verbosity</code>, and <code>args</code></li> <li>Support overriding the default arguments used to spawn shells on non-Windows systems</li> <li>Bump the minimum supported version of Hatchling to 1.3.0</li> </ul> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Improve <code>setuptools</code> migration script</li> </ul> <h2 id=hatch-v1.1.2><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.1.2>1.1.2</a> - 2022-05-20<a class=headerlink href=#hatch-v1.1.2 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Bump the minimum supported version of Hatchling to 1.2.0</li> <li>Update project metadata to reflect support for Python 3.11</li> </ul> <h2 id=hatch-v1.1.1><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.1.1>1.1.1</a> - 2022-05-12<a class=headerlink href=#hatch-v1.1.1 title="Permanent link">&para;</a></h2> <p><strong><em>Fixed:</em></strong></p> <ul> <li>Fix <code>setuptools</code> migration script for non-Windows systems</li> </ul> <h2 id=hatch-v1.1.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.1.0>1.1.0</a> - 2022-05-12<a class=headerlink href=#hatch-v1.1.0 title="Permanent link">&para;</a></h2> <p><strong><em>Changed:</em></strong></p> <ul> <li>In order to simplify the implementation of command execution for environment plugins, the <code>run_shell_commands</code> method has been replaced by the singular <code>run_shell_command</code>. A new <code>command_context</code> method has been added to more easily satisfy complex use cases.</li> <li>The <code>finalize_command</code> environment plugin method has been removed in favor of the newly introduced context formatting functionality.</li> </ul> <p><strong><em>Added:</em></strong></p> <ul> <li>Add context formatting functionality i.e. the ability to insert values into configuration like environment variables and command line arguments</li> <li>Any verbosity for command execution will now always display headers, even for single environments</li> <li>Every executed command is now displayed when running multiple commands or when verbosity is enabled</li> <li>Similar to <code>make</code>, ignore the exit code of executed commands that start with <code>-</code> (a hyphen)</li> <li>Add ability for the <code>--init</code> flag of the <code>new</code> command to automatically migrate <code>setuptools</code> configuration</li> <li>Update project metadata to reflect the adoption by PyPA and production stability</li> </ul> <h2 id=hatch-v1.0.0><a href=https://github.com/pypa/hatch/releases/tag/hatch-v1.0.0>1.0.0</a> - 2022-04-28<a class=headerlink href=#hatch-v1.0.0 title="Permanent link">&para;</a></h2> <p>This is the first stable release of Hatch v1, a complete rewrite. Enjoy!</p> <aside class=md-source-file> <span class=md-source-file__fact> <span class=md-icon title="Last update"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z"/></svg> </span> <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">April 5, 2024</span> </span> <span class=md-source-file__fact> <span class=md-icon title=Contributors> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2Z"/></svg> </span> <span>GitHub</span> <nav> <a href=https://github.com/ofek class=md-author title=@ofek> <img src="https://avatars.githubusercontent.com/u/9677399?v=4&size=72" alt=ofek> </a> <a href=https://github.com/juftin class=md-author title=@juftin> <img src="https://avatars.githubusercontent.com/u/49741340?v=4&size=72" alt=juftin> </a> <a href=https://github.com/jcgruenhage class=md-author title=@jcgruenhage> <img src="https://avatars.githubusercontent.com/u/6861958?v=4&size=72" alt=jcgruenhage> </a> <a href=https://github.com/ischaojie class=md-author title=@ischaojie> <img src="https://avatars.githubusercontent.com/u/12986082?v=4&size=72" alt=ischaojie> </a> <a href=https://github.com/pypa/hatch/blob/master/docs/history/hatch.md class="md-author md-author--more"> +4 </a> </nav> </span> </aside> </article> </div> <script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../../why/ class="md-footer__link md-footer__link--prev" aria-label="Previous: Why Hatch?"> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <span class=md-footer__direction> Previous </span> <div class=md-ellipsis> Why Hatch? </div> </div> </a> <a href=../hatchling/ class="md-footer__link md-footer__link--next" aria-label="Next: Hatchling"> <div class=md-footer__title> <span class=md-footer__direction> Next </span> <div class=md-ellipsis> Hatchling </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; Ofek Lev 2017-present </div> <div> Logo by <a href=https://openai.com/dall-e-2/ target=_blank rel=noopener> DALL·E </a> and <a href=https://boriscrowther.com/ target=_blank rel=noopener> Boris Crowther </a> </div> Made with <a href=https://squidfunk.github.io/mkdocs-material/ target=_blank rel=noopener> Material for MkDocs </a> </div> <div class=md-social> <a href=https://github.com/ofek target=_blank rel=noopener title=github.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></svg> </a> <a href=https://ofek.dev/words/ target=_blank rel=noopener title=ofek.dev class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M192 32c0 17.7 14.3 32 32 32 123.7 0 224 100.3 224 224 0 17.7 14.3 32 32 32s32-14.3 32-32C512 128.9 383.1 0 224 0c-17.7 0-32 14.3-32 32zm0 96c0 17.7 14.3 32 32 32 70.7 0 128 57.3 128 128 0 17.7 14.3 32 32 32s32-14.3 32-32c0-106-86-192-192-192-17.7 0-32 14.3-32 32zm-96 16c0-26.5-21.5-48-48-48S0 117.5 0 144v224c0 79.5 64.5 144 144 144s144-64.5 144-144-64.5-144-144-144h-16v96h16c26.5 0 48 21.5 48 48s-21.5 48-48 48-48-21.5-48-48V144z"/></svg> </a> <a href=https://twitter.com/Ofekmeister target=_blank rel=noopener title=twitter.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 512 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z"/></svg> </a> <a href=https://www.linkedin.com/in/ofeklev/ target=_blank rel=noopener title=www.linkedin.com class=md-social__link> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 448 512"><!-- Font Awesome Free 6.5.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2023 Fonticons, Inc.--><path d="M416 32H31.9C14.3 32 0 46.5 0 64.3v383.4C0 465.5 14.3 480 31.9 480H416c17.6 0 32-14.5 32-32.3V64.3c0-17.8-14.4-32.3-32-32.3zM135.4 416H69V202.2h66.5V416zm-33.2-243c-21.3 0-38.5-17.3-38.5-38.5S80.9 96 102.2 96c21.2 0 38.5 17.3 38.5 38.5 0 21.3-17.2 38.5-38.5 38.5zm282.1 243h-66.4V312c0-24.8-.5-56.7-34.5-56.7-34.6 0-39.9 27-39.9 54.9V416h-66.4V202.2h63.7v29.2h.9c8.9-16.8 30.6-34.5 62.9-34.5 67.2 0 79.7 44.3 79.7 101.9V416z"/></svg> </a> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../..", "features": ["content.action.edit", "content.code.copy", "content.tabs.link", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky"], "search": "../../assets/javascripts/workers/search.1e90e0fb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script> <script src=../../assets/javascripts/bundle.1135ae9f.min.js></script> <script>document$.subscribe(() => {const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});})</script></body> </html>
\ No newline at end of file
diff --git a/dev/search/search_index.json b/dev/search/search_index.json
index da64ed6be..0ec62e624 100644
--- a/dev/search/search_index.json
+++ b/dev/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Hatch","text":"CI/CD Docs Package Meta <p>Hatch is a modern, extensible Python project manager. See the Why Hatch? page for more information.</p> <ul> <li> <p> Build system</p> <p>Reproducible builds by default with a rich ecosystem of plugins</p> <p> Configure builds</p> </li> <li> <p> Environments</p> <p>Robust environment management with support for custom scripts</p> <p> Getting started</p> </li> <li> <p> Python management</p> <p>Choose between easy manual installations or automatic as part of environments</p> <p> Try it</p> </li> <li> <p> Testing</p> <p>Test execution with known best practices</p> <p> Run</p> </li> <li> <p> Static analysis</p> <p>Static analysis backed by Ruff with up-to-date, sane defaults</p> <p> Learn</p> </li> <li> <p> Publishing</p> <p>Easily upload to PyPI or other indices</p> <p> See how</p> </li> <li> <p> Versioning</p> <p>Streamlined workflow for bumping versions</p> <p> Managing versions</p> </li> <li> <p> Project generation</p> <p>Create new projects from templates with known best practices</p> <p> Project setup</p> </li> <li> <p> Responsive CLI</p> <p>Hatch is up to 3x faster than equivalent tools</p> <p> CLI reference</p> </li> </ul>"},{"location":"#license","title":"License","text":"<p>Hatch is distributed under the terms of the MIT license.</p>"},{"location":"#navigation","title":"Navigation","text":"<p>Documentation for specific <code>MAJOR.MINOR</code> versions can be chosen by using the dropdown on the top of every page. The <code>dev</code> version reflects changes that have not yet been released.</p> <p>Also, desktop readers can use special keyboard shortcuts:</p> Keys Action <ul><li>, (comma)</li><li>p</li></ul> Navigate to the \"previous\" page <ul><li>. (period)</li><li>n</li></ul> Navigate to the \"next\" page <ul><li>/</li><li>s</li></ul> Display the search modal"},{"location":"build/","title":"Builds","text":""},{"location":"build/#configuration","title":"Configuration","text":"<p>Builds are configured using the <code>tool.hatch.build</code> table. Every target is defined by a section within <code>tool.hatch.build.targets</code>, for example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\nexclude = [\n  \"/.github\",\n  \"/docs\",\n]\n\n[tool.hatch.build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre> <pre><code>[build.targets.sdist]\nexclude = [\n  \"/.github\",\n  \"/docs\",\n]\n\n[build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre>"},{"location":"build/#building","title":"Building","text":"<p>Invoking the <code>build</code> command without any arguments will build the sdist and wheel targets:</p> <pre><code>$ hatch build\n[sdist]\ndist/hatch_demo-1rc0.tar.gz\n\n[wheel]\ndist/hatch_demo-1rc0-py3-none-any.whl\n</code></pre> <p>To only build specific targets, use the <code>-t</code>/<code>--target</code> option:</p> <pre><code>$ hatch build -t wheel\n[wheel]\ndist/hatch_demo-1rc0-py3-none-any.whl\n</code></pre> <p>If the target supports multiple versions, you can specify the exact versions to build by appending a colon followed by the desired versions separated by commas:</p> <pre><code>$ hatch -v build -t wheel:standard\n[wheel]\nBuilding `wheel` version `standard`\ndist/hatch_demo-1rc0-py3-none-any.whl\n</code></pre>"},{"location":"build/#packaging-ecosystem","title":"Packaging ecosystem","text":"<p>Hatch complies with modern Python packaging specs and therefore your projects can be used by other tools with Hatch serving as just the build backend.</p> <p>So you could use tox as an alternative to Hatch's environment management, or cibuildwheel to distribute packages for every platform, and they both will transparently use Hatch without any extra modification.</p>"},{"location":"environment/","title":"Environments","text":"<p>Environments are designed to allow for isolated workspaces for testing, building documentation, or anything else projects need.</p> <p>Unless an environment is chosen explicitly, Hatch will use the <code>default</code> environment.</p> <p>Tip</p> <p>For a more comprehensive walk-through, see the Basic usage tutorial.</p>"},{"location":"environment/#creation","title":"Creation","text":"<p>You can create environments by using the <code>env create</code> command. Let's enter the directory of the project we created in the setup phase:</p> <pre><code>$ hatch env create\nCreating environment: default\nInstalling project in development mode\nSyncing dependencies\n</code></pre> <p>Tip</p> <p>You never need to manually create environments as spawning a shell or running commands within one will automatically trigger creation.</p>"},{"location":"environment/#entering-environments","title":"Entering environments","text":"<p>You can spawn a shell within an environment by using the <code>shell</code> command.</p> <pre><code>$ hatch shell\n(hatch-demo) $\n</code></pre> <p>Now confirm the project has been installed:</p> <pre><code>(hatch-demo) $ pip show hatch-demo\nName: hatch-demo\nVersion: 0.0.1\n...\n</code></pre> <p>Finally, see where your environment's Python is located:</p> <pre><code>(hatch-demo) $ python -c \"import sys;print(sys.executable)\"\n...\n</code></pre> <p>You can type <code>exit</code> to leave the environment.</p>"},{"location":"environment/#command-execution","title":"Command execution","text":"<p>The <code>run</code> command allows you to execute commands in an environment as if you had already entered it. For example, running the following command will output the same path as before:</p> <pre><code>hatch run python -c \"import sys;print(sys.executable)\"\n</code></pre> <p>Tip</p> <p>Be sure to check out how to define scripts for your project.</p>"},{"location":"environment/#dependencies","title":"Dependencies","text":"<p>Hatch ensures that environments are always compatible with the currently defined project dependencies (if installed and in dev mode) and environment dependencies.</p> <p>To add <code>cowsay</code> as a dependency, open <code>pyproject.toml</code> and add it to the <code>dependencies</code> array:</p>  pyproject.toml <pre><code>[project]\n...\ndependencies = [\n  \"cowsay\"\n]\n</code></pre> <p>This dependency will be installed the next time you spawn a shell or run a command. For example:</p> <pre><code>$ hatch run cowsay -t \"Hello, world!\"\nSyncing dependencies\n  _____________\n| Hello, world! |\n  =============\n             \\\n              \\\n                ^__^\n                (oo)\\_______\n                (__)\\       )\\/\\\n                    ||----w |\n                    ||     ||\n</code></pre> <p>Note</p> <p>The <code>Syncing dependencies</code> status will display temporarily when Hatch updates environments in response to any dependency changes that you make.</p>"},{"location":"environment/#selection","title":"Selection","text":"<p>You can select which environment to enter or run commands in by using the <code>-e</code>/<code>--env</code> root option or by setting the <code>HATCH_ENV</code> environment variable.</p> <p>The <code>run</code> command allows for more explicit selection by prepending <code>&lt;ENV_NAME&gt;:</code> to commands. For example, if you had the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[tool.hatch.envs.docs.scripts]\nbuild = \"mkdocs build --clean --strict\"\nserve = \"mkdocs serve --dev-addr localhost:8000\"\n</code></pre> <pre><code>[envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[envs.docs.scripts]\nbuild = \"mkdocs build --clean --strict\"\nserve = \"mkdocs serve --dev-addr localhost:8000\"\n</code></pre> <p>you could then serve your documentation by running:</p> <pre><code>hatch run docs:serve\n</code></pre> <p>Tip</p> <p>If you've already entered an environment, commands will target it by default.</p>"},{"location":"environment/#matrix","title":"Matrix","text":"<p>Every environment can define its own set of matrices:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre> <p>Using the <code>env show</code> command would then display:</p> <pre><code>$ hatch env show --ascii\n     Standalone\n+---------+---------+\n| Name    | Type    |\n+=========+=========+\n| default | virtual |\n+---------+---------+\n                       Matrices\n+------+---------+---------------------+--------------+\n| Name | Type    | Envs                | Dependencies |\n+======+=========+=====================+==============+\n| test | virtual | test.py2.7-42       | pytest       |\n|      |         | test.py2.7-3.14     |              |\n|      |         | test.py3.8-42       |              |\n|      |         | test.py3.8-3.14     |              |\n|      |         | test.py3.8-9000-foo |              |\n|      |         | test.py3.8-9000-bar |              |\n|      |         | test.py3.9-9000-foo |              |\n|      |         | test.py3.9-9000-bar |              |\n+------+---------+---------------------+--------------+\n</code></pre>"},{"location":"environment/#removal","title":"Removal","text":"<p>You can remove a single environment or environment matrix by using the <code>env remove</code> command or all of a project's environments by using the <code>env prune</code> command.</p>"},{"location":"install/","title":"Installation","text":""},{"location":"install/#installers","title":"Installers","text":"macOSWindows GUI installerCommand line installer <ol> <li>In your browser, download the <code>.pkg</code> file: hatch-1.9.1.pkg</li> <li>Run your downloaded file and follow the on-screen instructions.</li> <li>Restart your terminal.</li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol> <ol> <li> <p>Download the file using the <code>curl</code> command. The <code>-o</code> option specifies the file name that the downloaded package is written to. In this example, the file is written to <code>hatch-1.9.1.pkg</code> in the current directory.</p> <pre><code>curl -o hatch-1.9.1.pkg https://github.com/pypa/hatch/releases/download/hatch-v1.9.1/hatch-1.9.1.pkg\n</code></pre> </li> <li> <p>Run the standard macOS <code>installer</code> program, specifying the downloaded <code>.pkg</code> file as the source. Use the <code>-pkg</code> parameter to specify the name of the package to install, and the <code>-target /</code> parameter for the drive in which to install the package. The files are installed to <code>/usr/local/hatch</code>, and an entry is created at <code>/etc/paths.d/hatch</code> that instructs shells to add the <code>/usr/local/hatch</code> directory to. You must include sudo on the command to grant write permissions to those folders.</p> <pre><code>sudo installer -pkg ./hatch-1.9.1.pkg -target /\n</code></pre> </li> <li> <p>Restart your terminal.</p> </li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol> GUI installerCommand line installer <ol> <li>In your browser, download one the <code>.msi</code> files:<ul> <li>hatch-1.9.1-x64.msi</li> </ul> </li> <li>Run your downloaded file and follow the on-screen instructions.</li> <li>Restart your terminal.</li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol> <ol> <li> <p>Download and run the installer using the standard Windows <code>msiexec</code> program, specifying one of the <code>.msi</code> files as the source. Use the <code>/passive</code> and <code>/i</code> parameters to request an unattended, normal installation.</p> x64x86 <pre><code>msiexec /passive /i https://github.com/pypa/hatch/releases/download/hatch-v1.9.1/hatch-1.9.1-x64.msi\n</code></pre> <pre><code>msiexec /passive /i https://github.com/pypa/hatch/releases/download/hatch-v1.9.1/hatch-1.9.1-x86.msi\n</code></pre> </li> <li> <p>Restart your terminal.</p> </li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol>"},{"location":"install/#standalone-binaries","title":"Standalone binaries","text":"<p>After downloading the archive corresponding to your platform and architecture, extract the binary to a directory that is on your PATH and rename to <code>hatch</code>.</p> LinuxmacOSWindows <ul> <li>hatch-1.9.1-aarch64-unknown-linux-gnu.tar.gz</li> <li>hatch-1.9.1-x86_64-unknown-linux-gnu.tar.gz</li> <li>hatch-1.9.1-x86_64-unknown-linux-musl.tar.gz</li> <li>hatch-1.9.1-i686-unknown-linux-gnu.tar.gz</li> <li>hatch-1.9.1-powerpc64le-unknown-linux-gnu.tar.gz</li> </ul> <ul> <li>hatch-1.9.1-aarch64-apple-darwin.tar.gz</li> <li>hatch-1.9.1-x86_64-apple-darwin.tar.gz</li> </ul> <ul> <li>hatch-1.9.1-x86_64-pc-windows-msvc.zip</li> <li>hatch-1.9.1-i686-pc-windows-msvc.zip</li> </ul>"},{"location":"install/#pip","title":"pip","text":"<p>Hatch is available on PyPI and can be installed with pip.</p> <pre><code>pip install hatch\n</code></pre> <p>Warning</p> <p>This method modifies the Python environment in which you choose to install. Consider instead using pipx to avoid dependency conflicts.</p>"},{"location":"install/#pipx","title":"pipx","text":"<p>pipx allows for the global installation of Python applications in isolated environments.</p> <pre><code>pipx install hatch\n</code></pre>"},{"location":"install/#homebrew","title":"Homebrew","text":"<p>See the formula for more details.</p> <pre><code>brew install hatch\n</code></pre>"},{"location":"install/#conda","title":"Conda","text":"<p>See the feedstock for more details.</p> <pre><code>conda install -c conda-forge hatch\n</code></pre> <p>or with mamba:</p> <pre><code>mamba install hatch\n</code></pre> <p>Warning</p> <p>This method modifies the Conda environment in which you choose to install. Consider instead using pipx or condax to avoid dependency conflicts.</p>"},{"location":"install/#macports","title":"MacPorts","text":"<p>See the port for more details.</p> <pre><code>sudo port install hatch\n</code></pre>"},{"location":"install/#fedora","title":"Fedora","text":"<p>The minimum supported version is 37, currently in development as Rawhide.</p> <pre><code>sudo dnf install hatch\n</code></pre>"},{"location":"install/#void-linux","title":"Void Linux","text":"<pre><code>xbps-install hatch\n</code></pre>"},{"location":"install/#build-system-availability","title":"Build system availability","text":"<p>Hatchling is Hatch's build backend which you will never need to install manually. See its changelog for version information.</p> <p></p>"},{"location":"intro/","title":"Introduction","text":""},{"location":"intro/#setup","title":"Setup","text":"<p>Projects can be set up for use by Hatch using the <code>new</code> command.</p>"},{"location":"intro/#new-project","title":"New project","text":"<p>Let's say you want to create a project named <code>Hatch Demo</code>. You would run:</p> <pre><code>hatch new \"Hatch Demo\"\n</code></pre> <p>This would create the following structure in your current working directory:</p> <pre><code>hatch-demo\n\u251c\u2500\u2500 src\n\u2502   \u2514\u2500\u2500 hatch_demo\n\u2502       \u251c\u2500\u2500 __about__.py\n\u2502       \u2514\u2500\u2500 __init__.py\n\u251c\u2500\u2500 tests\n\u2502   \u2514\u2500\u2500 __init__.py\n\u251c\u2500\u2500 LICENSE.txt\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 pyproject.toml\n</code></pre> <p>Tip</p> <p>There are many ways to customize project generation.</p>"},{"location":"intro/#existing-project","title":"Existing project","text":"<p>To initialize an existing project, enter the directory containing the project and run the following:</p> <pre><code>hatch new --init\n</code></pre> <p>If your project has a <code>setup.py</code> file the command will automatically migrate <code>setuptools</code> configuration for you. Otherwise, this will interactively guide you through the setup process.</p>"},{"location":"intro/#project-metadata","title":"Project metadata","text":"<p>Next you'll want to define more of your project's metadata located in the <code>pyproject.toml</code> file. You can specify things like its license, the supported versions of Python, and URLs referring to various parts of your project, like documentation.</p>"},{"location":"intro/#dependencies","title":"Dependencies","text":"<p>The last step of the setup process is to define any dependencies that you'd like your project to begin with.</p>"},{"location":"intro/#configuration","title":"Configuration","text":"<p>All project-specific configuration recognized by Hatch can be defined in either the <code>pyproject.toml</code> file, or a file named <code>hatch.toml</code> where options are not contained within the <code>tool.hatch</code> table:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch]\noption = \"...\"\n\n[tool.hatch.table1]\noption = \"...\"\n\n[tool.hatch.table2]\noption = \"...\"\n</code></pre> <pre><code>option = \"...\"\n\n[table1]\noption = \"...\"\n\n[table2]\noption = \"...\"\n</code></pre> <p>Top level keys in the latter file take precedence when defined in both.</p> <p>Tip</p> <p>If you want to make your file more compact, you can use dotted keys, turning the above example into:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch]\noption = \"...\"\ntable1.option = \"...\"\ntable2.option = \"...\"\n</code></pre> <pre><code>option = \"...\"\ntable1.option = \"...\"\ntable2.option = \"...\"\n</code></pre>"},{"location":"next-steps/","title":"Next steps","text":""},{"location":"next-steps/#learn-more","title":"Learn more","text":"<p>At this point you should have a basic understanding of how to use Hatch.</p> <p>Now you may want to check out advanced configuration for environments or builds, set up your preferred shell, or read more about Hatch's CLI.</p> <p>After that, check out the Hatch Showcase project to see examples of what is possible.</p> <p>Finally, if you see a need, feel free to write a plugin for extended functionality.</p>"},{"location":"next-steps/#community","title":"Community","text":"<p>For any projects using Hatch, you may add its official badge somewhere prominent like the README.</p> <p></p> MarkdownreStructuredText <pre><code>[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)\n</code></pre> <pre><code>.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\n   :alt: Hatch project\n   :target: https://github.com/pypa/hatch\n</code></pre>"},{"location":"publish/","title":"Publishing","text":"<p>After your project is built, you can distribute it using the <code>publish</code> command.</p> <p>The <code>-p</code>/<code>--publisher</code> option controls which publisher to use, with the default being index.</p>"},{"location":"publish/#artifact-selection","title":"Artifact selection","text":"<p>By default, the <code>dist</code> directory located at the root of your project will be used:</p> <pre><code>$ hatch publish\ndist/hatch_demo-1rc0-py3-none-any.whl ... success\ndist/hatch_demo-1rc0.tar.gz ... success\n\n[hatch-demo]\nhttps://pypi.org/project/hatch-demo/1rc0/\n</code></pre> <p>You can instead pass specific paths as arguments:</p> <pre><code>hatch publish /path/to/artifacts foo-1.tar.gz\n</code></pre> <p>Only files ending with <code>.whl</code> or <code>.tar.gz</code> will be published.</p>"},{"location":"publish/#further-resources","title":"Further resources","text":"<p>Please refer to the publisher plugin reference for configuration options.</p> <p>There's a How-To on authentication and on options to select the target repository.</p> <p>The <code>publish</code> command is implemented as a built-in plugin, if you're planning your own plugin, read about the publisher plugin API. </p>"},{"location":"version/","title":"Versioning","text":""},{"location":"version/#configuration","title":"Configuration","text":"<p>When the version is not statically set, configuration is defined in the <code>tool.hatch.version</code> table. The <code>source</code> option determines the source to use for retrieving and updating the version. The regex source is used by default.</p> <p>The <code>regex</code> source requires an option <code>path</code> that represents a relative path to a file containing the project's version:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\npath = \"src/hatch_demo/__about__.py\"\n</code></pre> <pre><code>[version]\npath = \"src/hatch_demo/__about__.py\"\n</code></pre> <p>The default pattern looks for a variable named <code>__version__</code> or <code>VERSION</code> that is set to a string containing the version, optionally prefixed with the lowercase letter <code>v</code>.</p> <p>If this doesn't reflect how you store the version, you can define a different regular expression using the <code>pattern</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\npath = \"pkg/__init__.py\"\npattern = \"BUILD = 'b(?P&lt;version&gt;[^']+)'\"\n</code></pre> <pre><code>[version]\npath = \"pkg/__init__.py\"\npattern = \"BUILD = 'b(?P&lt;version&gt;[^']+)'\"\n</code></pre> <p>The pattern must have a named group called <code>version</code> that represents the version.</p>"},{"location":"version/#display","title":"Display","text":"<p>Invoking the <code>version</code> command without any arguments will display the current version of the project:</p> <pre><code>$ hatch version\n0.0.1\n</code></pre>"},{"location":"version/#updating","title":"Updating","text":"<p>You can update the version like so:</p> <pre><code>$ hatch version \"0.1.0\"\nOld: 0.0.1\nNew: 0.1.0\n</code></pre> <p>The <code>scheme</code> option determines the scheme to use for parsing both the existing and new versions. The standard scheme is used by default, which is based on PEP 440.</p> <p>Rather than setting the version explicitly, you can select the name of a segment used to increment the version:</p> <pre><code>$ hatch version minor\nOld: 0.1.0\nNew: 0.2.0\n</code></pre> <p>You can chain multiple segment updates with a comma. For example, if you wanted to release a preview of your project's first major version, you could do:</p> <pre><code>$ hatch version major,rc\nOld: 0.2.0\nNew: 1.0.0rc0\n</code></pre> <p>When you want to release the final version, you would do:</p> <pre><code>$ hatch version release\nOld: 1.0.0rc0\nNew: 1.0.0\n</code></pre>"},{"location":"version/#supported-segments","title":"Supported segments","text":"<p>Here are the supported segments and how they would influence an existing version of <code>1.0.0</code>:</p> Segments New version <code>release</code> <code>1.0.0</code> <code>major</code> <code>2.0.0</code> <code>minor</code> <code>1.1.0</code> <code>micro</code><code>patch</code><code>fix</code> <code>1.0.1</code> <code>a</code><code>alpha</code> <code>1.0.0a0</code> <code>b</code><code>beta</code> <code>1.0.0b0</code> <code>c</code><code>rc</code><code>pre</code><code>preview</code> <code>1.0.0rc0</code> <code>r</code><code>rev</code><code>post</code> <code>1.0.0.post0</code> <code>dev</code> <code>1.0.0.dev0</code>"},{"location":"why/","title":"Why Hatch?","text":"<p>The high level value proposition of Hatch is that if one adopts all functionality then many other tools become unnecessary since there is support for everything one might require. Further, if one chooses to use only specific features then there are still benefits compared to alternatives.</p>"},{"location":"why/#build-backend","title":"Build backend","text":"<p>Hatchling, the build backend sister project, has many benefits compared to setuptools. Here we only compare setuptools as that is the one most people are familiar with.</p> <ul> <li>Better defaults: The default behavior for setuptools is often not desirable for the average user.<ul> <li>For source distributions, setuptools has a custom enumeration of files that get included and excluded by default. Hatchling takes the defaults from your version control system such as Git's <code>.gitignore</code> file.</li> <li>For wheels, setuptools attempts to find every directory that looks like a Python package. This is often undesirable as you might ship files to the end-user unintentionally such as test or tooling directories. Hatchling defaults to very specific inclusion based on the project name and errors if no heuristic is satisfied.</li> </ul> </li> <li>Ease of configurability: Hatchling was designed based on a history of significant challenges when configuring setuptools.<ul> <li>Hatchling uses the same glob pattern syntax as Git itself for every option which is what most users are familiar with. On the other hand, setuptools uses shell-style glob patterns for source distributions while wheels use a mix of shell-style globs and Python package syntax.</li> <li>Configuring what gets included in source distributions requires a separate <code>MANIFEST.in</code> file. The custom syntax and directives must be learned and it is difficult knowing which options in the main files like <code>setup.py</code> influence the behavior and under what conditions. For Hatchling, everything gets configured in a single file under dedicated sections for specific targets like <code>[tool.hatch.build.targets.wheel]</code>.</li> <li>By default, non-Python files are excluded from wheels. Including such files requires usually verbose rules for every nested package directory. Hatchling makes no such distinction between file types and acts more like a general build system one might already be familiar with.</li> </ul> </li> <li>Editable installations: The default behavior of Hatchling allows for proper static analysis by external tools such as IDEs. With setuptools, you must provide additional configuration which means that by default, for example, you would not get autocompletion in Visual Studio Code. This is marked as a legacy feature and may in fact be removed in future versions of setuptools.</li> <li>Reproducibility: Hatchling builds reproducible wheels and source distributions by default. setuptools does not support this for source distributions and there is no guarantee that wheels are reproducible.</li> <li>Extensibility: Although it is possible to extend setuptools, the API is quite low level. Hatchling has the concept of plugins that are separated into discrete types and only expose what is necessary, leading to an easier developer experience.</li> </ul> <p>Why not?:</p> <p>If building extension modules is required then it is recommended that you continue using setuptools, or even other backends that specialize in interfacing with compilers.</p>"},{"location":"why/#environment-management","title":"Environment management","text":"<p>Here we compare to both <code>tox</code> and <code>nox</code>. At a high level, there are a few common advantages:</p> <ul> <li>Python management: Hatch is able to automatically download Python distributions on the fly when specific versions that environments request cannot be found. The alternatives will raise an error, with the option to ignore unknown distributions.</li> <li> <p>Philosophy: In the alternatives, environments are for the most part treated as executable units where a dependency set is associated with an action. If you are familiar with container ecosystems, this would be like defining a <code>CMD</code> at the end of a Dockerfile but without the ability to change the action at runtime. This involves significant wasted disk space usually because one often requires slight modifications to the actions and therefore will define entirely different environments inherited from a base config just to perform different logic. Additionally, this can be confusing to users not just configuration-wise but also for execution of the different environments.</p> <p>In Hatch, environments are treated as isolated areas where you can execute arbitrary commands at runtime. For example, you can define a single test environment with named scripts that runs unit vs non-unit tests, each command being potentially very long but named however you wish so you get to control the interface. Since environments are treated as places where work is performed, you can also spawn a shell into any which will execute a subprocess that automatically drops into your shell of choice. Your shell will be configured appropriately like <code>python</code> on PATH being updated and the prompt being changed to reflect the chosen environment.</p> </li> <li> <p>Configuration:</p> <ul> <li><code>tox</code> only supports INI configuration and if one desires putting that in the standard <code>pyproject.toml</code> file then it must be a multi-line string containing the INI config which would preclude syntax highlighting. Hatch allows for TOML-based config just like most other tools in the Python ecosystem.</li> <li><code>nox</code> config is defined in Python which often leads to increased verbosity and makes it challenging to onboard folks compared to a standardized format with known behaviors.</li> </ul> </li> <li>Extensibility:<ul> <li><code>tox</code> allows for extending most aspects of its functionality however the API is so low-level and attached to internals that creating plugins may be challenging. For example, here is a <code>tox</code> plugin that was migrated to an equivalent Hatch environment collector plugin.</li> <li><code>nox</code> is configured with Python so for the local project you can do whatever you want, however there is no concept of third-party plugins per se. To achieve that, you must usually use a package that wraps <code>nox</code> and use that package's imports instead (example).</li> </ul> </li> </ul> <p>Why not?:</p> <p>If you are using <code>nox</code> and you wish to migrate, and for some reason you notify sessions, then migration wouldn't be a straight translation but rather you might have to redesign that conditional step.</p>"},{"location":"why/#python-management","title":"Python management","text":"<p>Here we compare Python management to that of pyenv.</p> <ul> <li>Cross-platform: Hatch allows for the same experience no matter the system whereas <code>pyenv</code> does not support Windows so you must use an entirely different project that tries to emulate the functionality.</li> <li>No build dependencies: Hatch guarantees that every available distribution is prebuilt whereas the alternative requires one to maintain a precise build environment which differs by platform and potentially Python version. Another benefit to this is extremely fast installations since the distributions are simply downloaded and unpacked.</li> <li>Optimized by default: The CPython distributions are built with profile guided optimization and link-time optimization, resulting in a 10-30% performance improvement depending on the workload. These distributions have seen wide adoption throughout the industry and are even used by the build system Bazel.</li> <li>Simplicity: Hatch treats Python installations as just another directory that one would add to PATH. It can do this for you or you can manage PATH yourself, even allowing for custom install locations. On the other hand, <code>pyenv</code> operates by adding shims which then act as wrappers around the actual underlying binaries. This has many unfortunate side effects:<ul> <li>It is incumbent upon the user to manage which specific Python comes first via the CLI, switch when necessary, and/or have a mental model of which versions are exposed globally and locally per-project. This can become confusing quite quickly. When working with Hatch, your global Python installations are only important insofar as they are on PATH somewhere since environments do not use them directly but rather create virtual environments from them, always using a version that is compatible with your project.</li> <li>Configuration is required for each shell to properly set up <code>pyenv</code> on start, leading to inconsistencies when running processes that do not spawn a shell.</li> <li>Debugging issues with Python search paths can be extremely difficult, especially for users of software. If you or users have ever ran into an issue where code was being executed that you did not anticipate, the issue is almost always <code>pyenv</code> influencing the <code>python</code> on PATH.</li> </ul> </li> </ul> <p>Why not?:</p> <p>Currently, Hatch does not allow for the installation of specific patch release versions but rather only uses minor release granularity that tracks the latest patch release. If specific patch releases are important to you then it is best to use an alternative installation mechanism.</p>"},{"location":"blog/","title":"Blog","text":""},{"location":"blog/2022/10/08/hatch-v160/","title":"Hatch v1.6.0","text":"<p>Hatch v1.6.0 brings improvements to build environments, better handling of dynamic metadata, and support for tools like Visual Studio Code.</p>"},{"location":"blog/2022/10/08/hatch-v160/#build-environments","title":"Build environments","text":"<p>Originally, the environment interface method for providing builder sub-environments was intended to be used in conjunction with some cleanup logic in order to provide a fresh setup every time. However, this is unnecessary in practice because build dependencies rarely change.</p> <p>Without caching, repeat build environment use is slow which affects the following scenarios:</p> <ul> <li>the <code>build</code> command</li> <li>commands that read project metadata, like <code>dep hash</code>, if any fields are set dynamically</li> </ul> <p>Now a new environment interface method <code>build_environment_exists</code> is used by Hatch to determine whether or not it has already been created, for implementations that have a caching mechanism.</p> <p>The <code>virtual</code> environment type now uses this method to cache build environments.</p>"},{"location":"blog/2022/10/08/hatch-v160/#project-metadata","title":"Project metadata","text":"<p>Dynamically defined metadata is now supported everywhere, thanks to the new caching of <code>virtual</code> build environments.</p> <p>A <code>project metadata</code> command is introduced that displays the fully resolved metadata. The output format is JSON unless a field is specified as an argument.</p> <p>For example, if you checkout a project that is built by Hatch, like FastAPI, and run:</p> <pre><code>hatch project metadata readme\n</code></pre> <p>only the <code>readme</code> text will be displayed. If the content is in Markdown, then Rich will render it directly in your terminal:</p> <p></p>"},{"location":"blog/2022/10/08/hatch-v160/#virtual-environment-location","title":"Virtual environment location","text":"<p>The <code>virtual</code> environment type now uses a flat layout for storage in the configured <code>virtual</code> environment directory if the directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory.</p> <p>For example, if you define the following Hatch configuration:</p>  config.toml <pre><code>[dirs.env]\nvirtual = \".hatch\"\n</code></pre> <p>and the following matrix:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\npython = [\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"3.11\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\npython = [\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"3.11\"]\n</code></pre> <p>then locating environments with the following command:</p> <pre><code>hatch env find test\n</code></pre> <p>will show that the general directory structure is:</p> <pre><code>.hatch\n\u251c\u2500\u2500 test.py3.7\n\u251c\u2500\u2500 test.py3.8\n\u251c\u2500\u2500 test.py3.9\n\u251c\u2500\u2500 test.py3.10\n\u2514\u2500\u2500 test.py3.11\n</code></pre> <p>This flat structure is required for detection of virtual environments by tools like Visual Studio Code and PyCharm.</p> <p>Additionally, the <code>virtual</code> environment type now supports a <code>path</code> option to specify an explicit path that all inherited environments will share, such as the common <code>.venv</code>.</p>"},{"location":"blog/2022/10/08/hatch-v160/#migration-script-improvements","title":"Migration script improvements","text":"<p>The script used to migrate existing projects from <code>setuptools</code> has been improved to handle more edge cases that were encountered in the wild and now no longer modifies the formatting of existing <code>pyproject.toml</code> configuration.</p>"},{"location":"blog/2022/10/08/hatch-v160/#hatchling","title":"Hatchling","text":"<p>Hatch now depends on Hatchling v1.11.0, which was also just released.</p>"},{"location":"blog/2022/10/08/hatch-v160/#environment-version-source","title":"Environment version source","text":"<p>A new <code>env</code> version source is available that allows for the project version to be defined by an environment variable.</p>"},{"location":"blog/2022/10/08/hatch-v160/#relaxed-version-bumping","title":"Relaxed version bumping","text":"<p>The <code>standard</code> version scheme now supports a <code>validate-bump</code> option that when set to <code>false</code> will forego the check when updating the version that the desired version is higher than the current version.</p> <p>This use case comes from Project Jupyter:</p> <p>A common pattern we use in Jupyter is to bump to a <code>.dev0</code> minor version bump after making a release.  If we have a  bug fix that needs to go out in the interim, we'd rather not be forced to create a branch every time.</p>"},{"location":"blog/2023/12/11/hatch-v180/","title":"Hatch v1.8.0","text":"<p>Hatch v1.8.0 brings Python distribution management, static analysis and formatting backed by Ruff, and binaries for every platform.</p>"},{"location":"blog/2023/12/11/hatch-v180/#installation-made-easy","title":"Installation made easy","text":"<p>One thing that has been a perpetual problem for Hatch and other Python applications is that Python itself is a dependency. You, and more importantly your users, need to in some way get Python before your software can even be used. The recommended way to go about that is platform-dependent and even differs based on your target audience. I viewed this as a central UX problem for Hatch and so severe that I took a bit of a hiatus to solve it.</p> <p>Luckily, I have to my satisfaction solved this problem in the form of PyApp. It is a runtime installer for Python projects written in Rust. Apps are distributed as standalone executables as users have come to expect and bootstrapping occurs upon the first invocation. Here is an example of what you would see the first time you run a binary from this release:</p> <p></p> <p>Now that we have binaries, creating installers for different platforms becomes trivial. Starting with this release not only are binaries available for every platform but also we have installers for Windows and macOS. The installer for macOS is signed using a certificate from the same account used to sign the official distributions from https://www.python.org, so users will not get any security pop-ups. Shout out to @ewdurbin for their extreme generosity in setting up multiple certificates in their free time!</p> <p>These installers and binaries are now the recommended way to install and update Hatch. These binaries have built-in management so you can update to the latest version by running <code>hatch self update</code>.</p> <p>Windows signing</p> <p>In future we will sign the installers for Windows but I did not have time to look into how that works. macOS signing took way longer than I anticipated </p>"},{"location":"blog/2023/12/11/hatch-v180/#python-management","title":"Python management","text":"<p>For a long time I and other users have desired that Hatch gain the ability to manage Python distributions. In my mind this was always blocked on a better installation experience because there was sort of a chicken-or-egg problem where you want a Python manager but you first need Python. No longer is that the case!</p> <p>The new <code>python</code> command group allows for easy installation of various distributions to arbitrary locations which are then added to your PATH by default. Hatch supports CPython and PyPy distributions:</p> <p></p>"},{"location":"blog/2023/12/11/hatch-v180/#virtual-environment-python-resolution","title":"Virtual environment Python resolution","text":"<p>The <code>virtual</code> environment type is now far more intelligent when resolving the parent distribution to use and guarantees that, when no specific version is requested, the resolved distribution will always be compatible with the project.</p> <p>Additionally, when a requested version cannot be found on PATH it will automatically be downloaded and managed internally.</p>"},{"location":"blog/2023/12/11/hatch-v180/#static-analysis","title":"Static analysis","text":"<p>There is a new <code>fmt</code> command, backed entirely by Ruff, that checks and fixes your code for formatting and linting issues.</p> <p>Starting with this release, Hatch maintains default settings that are guaranteed to be up-to-date and represent best practices for programming in modern Python. The idea is to provide defaults that are so broadly applicable that the majority of users will maintain little if any of their own overrides.</p> <p>The default behavior is internal management of settings to provide an OOTB experience that works. It is recommended however that you persist the default config file in version control so that other tools like IDEs can utilize your full configuration.</p> <p>Since Ruff is now provided as a built-in feature, new project templates no longer have such configuration and are much less verbose.</p>"},{"location":"blog/2023/12/11/hatch-v180/#build-improvements","title":"Build improvements","text":"<p>Building projects that do not use Hatchling as a backend is now supported and such builds are managed with the standard build tool.</p> <p>The bridge between Hatch and the Hatchling CLI has been removed. Previously, the builder would send serialized messages to Hatch that would contain the desired content and style for each line of output. This was done in an effort to allow builder and build hook plugins to output pretty messages without actually requiring a dependency like Rich. A problem that arises with this is that builders that invoke subprocesses will not display ANSI codes as one might expect and will lose out on the interactive experience of such invocations, like the built-in binary builder plugin calling <code>cargo build</code>. So now everything is simpler at the expense of no colored output without manual logic, or adding a dependency if you're a third-party plugin.</p>"},{"location":"blog/2023/12/11/hatch-v180/#faster-environment-usage","title":"Faster environment usage","text":"<p>Spawning a shell or running commands within environments always first checks that your project's dependencies are satisfied and if not synchronizes the environment with what is defined. Previously, this had the potential to be quite slow for projects that have many dependencies.</p> <p>Now the set of dependency definitions is hashed and no check is performed if the hash is the same as before, significantly speeding up environment usage in most cases.</p>"},{"location":"blog/2023/12/11/hatch-v180/#hatchling","title":"Hatchling","text":"<p>Hatch now depends on Hatchling v1.19.0, which was also just released.</p>"},{"location":"blog/2023/12/11/hatch-v180/#better-defaults","title":"Better defaults","text":"<p>Hatchling is all about providing the best possible defaults, even at the expense of backward compatibility. In this release, there are two breaking changes that provide a much better user experience and were in fact requested by users.</p> <ul> <li>Both the <code>force-include</code> option and the <code>force_include_editable</code> wheel build data setting now raise errors if source paths do not exist.</li> <li>The <code>wheel</code> build target now raises an error when no file inclusion options have been defined and none of its heuristics to determine what to ship are satisfied.</li> </ul>"},{"location":"blog/2023/12/11/hatch-v180/#binary-build-target","title":"Binary build target","text":"<p>A new <code>binary</code> build target is now stable that allows for the building of standalone binaries for projects. This is what Hatch itself uses for its binaries.</p>"},{"location":"blog/2023/12/11/hatch-v180/#meta","title":"Meta","text":""},{"location":"blog/2023/12/11/hatch-v180/#why-hatch","title":"Why Hatch?","text":"<p>A new page has been introduced that discusses the value proposition of Hatch and Hatchling in comparison to alternatives. Currently, it only addresses a few features but in future this page will become more comprehensive.</p>"},{"location":"blog/2023/12/11/hatch-v180/#future","title":"Future","text":"<p>Upcoming features include a <code>test</code> command, commands to manage dependencies, and workspaces functionality similar to Cargo that will make managing monorepos far easier.</p> <p>Next year there will be two large efforts that you should expect to see:</p> <ol> <li> <p>A significant amount of my free time (and some at work) will be devoted to introducing lock file functionality in Hatch and trying to get whatever that happens to be standardized.</p> <p>I met with @brettcannon about his thoughts post-PEP 665 and about mousebender. I also met with the prefix.dev team about rip and was fortunate enough to be shown a demo before its official announcement.</p> <p>At the moment, the two options I see are to either go all in and contribute to mousebender or rely on the Prefix folks and use rip. The latter has the benefit of potentially supporting Conda as a side effect with the downside of being quite new with the spec firmly out of our control. The former has the benefit of being able to easily gain institutional support from the Python packaging team and each of our employers with the downside being a significant amount of work needing to be done.</p> </li> <li> <p>When @henryiii is able to get some free time away from teaching I plan to work with him once again and push very hard for the Python build ecosystem to adopt the extensionlib approach.</p> <p>I am of the opinion that the Python community has not fully completed the expressed outcome of PEP 517 in that build backends are still (for the most part) reliant on setuptools for building non-Python code bases.</p> <p>Basically, there are components that interact with compilers to produce extension modules and components that pack files into an archive which we call a build backend. These are two distinct pieces of functionality and my view is that there should be an API that allows backends to consume extension module builders to find out where things got created and where they should be shipped inside archives.</p> <p>In this hypothetical future any build backend would be able to trigger the building of extension modules based on user configuration.</p> </li> </ol>"},{"location":"blog/2023/12/11/hatch-v180/#support","title":"Support","text":"<p>If you or your organization finds value in what Hatch provides, consider a sponsorship to assist with maintenance and more rapid development!</p>"},{"location":"blog/2023/12/18/hatch-v190/","title":"Hatch v1.9.0","text":"<p>Hatch v1.9.0 brings improvements to static analysis and important bug fixes.</p>"},{"location":"blog/2023/12/18/hatch-v190/#static-analysis","title":"Static analysis","text":"<p>The default version of Ruff has been increased to v0.1.8. This release brings formatting capabilities to docstrings and Hatch enables this by default with line length set to 80. This length was chosen as the default because it plays nicely with the rendering of the most popular themes for Python documentation, such as Material for MkDocs and Furo.</p> <p>Additionally, it is now possible for projects to pin to specific versions of Ruff for upgrading at a later time:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre> <pre><code>[envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre>"},{"location":"blog/2023/12/18/hatch-v190/#notable-fixes","title":"Notable fixes","text":"<ul> <li>Python resolution for environments that do not install the project is no longer bound by the project's Python requirement.</li> <li>Fixed an edge case for out-of-the-box static analysis when there was existing configuration.</li> <li>Compatibility checks for environments no longer occur if the environment is already created. This significantly increases the responsiveness of environment usage.</li> </ul>"},{"location":"cli/about/","title":"CLI usage","text":""},{"location":"cli/about/#verbosity","title":"Verbosity","text":"<p>The amount of displayed output is controlled solely by the <code>-v</code>/<code>--verbose</code> (environment variable <code>HATCH_VERBOSE</code>) and  <code>-q</code>/<code>--quiet</code> (environment variable <code>HATCH_QUIET</code>) root options.</p> <p>The levels are documented here.</p>"},{"location":"cli/about/#project-awareness","title":"Project awareness","text":"<p>No matter the mode, Hatch will always change to the project's root directory for entering or running commands in environments.</p>"},{"location":"cli/about/#tab-completion","title":"Tab completion","text":"<p>Completion is achieved by saving a script and then executing it as a part of your shell's startup sequence.</p> <p>Afterward, you'll need to start a new shell in order for the changes to take effect.</p> BashZ shellfish <p>Save the script somewhere:</p> <pre><code>_HATCH_COMPLETE=bash_source hatch &gt; ~/.hatch-complete.bash\n</code></pre> <p>Source the file in <code>~/.bashrc</code> (or <code>~/.bash_profile</code> if on macOS):</p> <pre><code>. ~/.hatch-complete.bash\n</code></pre> <p>Save the script somewhere:</p> <pre><code>_HATCH_COMPLETE=zsh_source hatch &gt; ~/.hatch-complete.zsh\n</code></pre> <p>Source the file in <code>~/.zshrc</code>:</p> <pre><code>. ~/.hatch-complete.zsh\n</code></pre> <p>Save the script in <code>~/.config/fish/completions</code>:</p> <pre><code>_HATCH_COMPLETE=fish_source hatch &gt; ~/.config/fish/completions/hatch.fish\n</code></pre>"},{"location":"cli/reference/","title":"hatch","text":"<p>Usage:</p> <pre><code>hatch [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--env</code>, <code>-e</code> text The name of the environment to use [env var: <code>HATCH_ENV</code>] <code>default</code> <code>--project</code>, <code>-p</code> text The name of the project to work on [env var: <code>HATCH_PROJECT</code>] None <code>--verbose</code>, <code>-v</code> integer range (<code>0</code> and above) Increase verbosity (can be used additively) [env var: <code>HATCH_VERBOSE</code>] <code>0</code> <code>--quiet</code>, <code>-q</code> integer range (<code>0</code> and above) Decrease verbosity (can be used additively) [env var: <code>HATCH_QUIET</code>] <code>0</code> <code>--color</code> / <code>--no-color</code> boolean Whether or not to display colored output (default is auto-detection) [env vars: <code>FORCE_COLOR</code>/<code>NO_COLOR</code>] None <code>--interactive</code> / <code>--no-interactive</code> boolean Whether or not to allow features like prompts and progress bars (default is auto-detection) [env var: <code>HATCH_INTERACTIVE</code>] None <code>--data-dir</code> text The path to a custom directory used to persist data [env var: <code>HATCH_DATA_DIR</code>] None <code>--cache-dir</code> text The path to a custom directory used to cache data [env var: <code>HATCH_CACHE_DIR</code>] None <code>--config</code> text The path to a custom config file to use [env var: <code>HATCH_CONFIG</code>] None <code>--version</code> boolean Show the version and exit. <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-build","title":"hatch build","text":"<p>Build a project.</p> <p>Usage:</p> <pre><code>hatch build [OPTIONS] [LOCATION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--target</code>, <code>-t</code> text The target to build, overriding project defaults. This may be selected multiple times e.g. <code>-t sdist -t wheel</code> None <code>--hooks-only</code> boolean Whether or not to only execute build hooks [env var: <code>HATCH_BUILD_HOOKS_ONLY</code>] <code>False</code> <code>--no-hooks</code> boolean Whether or not to disable build hooks [env var: <code>HATCH_BUILD_NO_HOOKS</code>] <code>False</code> <code>--ext</code> boolean Whether or not to only execute build hooks for distributing binary Python packages, such as compiling extensions. Equivalent to <code>--hooks-only -t wheel</code> <code>False</code> <code>--clean</code>, <code>-c</code> boolean Whether or not existing artifacts should first be removed [env var: <code>HATCH_BUILD_CLEAN</code>] <code>False</code> <code>--clean-hooks-after</code> boolean Whether or not build hook artifacts should be removed after each build [env var: <code>HATCH_BUILD_CLEAN_HOOKS_AFTER</code>] <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-clean","title":"hatch clean","text":"<p>Remove build artifacts.</p> <p>Usage:</p> <pre><code>hatch clean [OPTIONS] [LOCATION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--target</code>, <code>-t</code> text The target with which to remove artifacts, overriding project defaults. This may be selected multiple times e.g. <code>-t sdist -t wheel</code> None <code>--hooks-only</code> boolean Whether or not to only remove artifacts from build hooks [env var: <code>HATCH_BUILD_HOOKS_ONLY</code>] <code>False</code> <code>--no-hooks</code> boolean Whether or not to ignore artifacts from build hooks [env var: <code>HATCH_BUILD_NO_HOOKS</code>] <code>False</code> <code>--ext</code> boolean Whether or not to only remove artifacts from build hooks for distributing binary Python packages, such as compiled extensions. Equivalent to <code>--hooks-only -t wheel</code> <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config","title":"hatch config","text":"<p>Manage the config file</p> <p>Usage:</p> <pre><code>hatch config [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-explore","title":"hatch config explore","text":"<p>Open the config location in your file manager.</p> <p>Usage:</p> <pre><code>hatch config explore [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-find","title":"hatch config find","text":"<p>Show the location of the config file.</p> <p>Usage:</p> <pre><code>hatch config find [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-restore","title":"hatch config restore","text":"<p>Restore the config file to default settings.</p> <p>Usage:</p> <pre><code>hatch config restore [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-set","title":"hatch config set","text":"<p>Assign values to config file entries. If the value is omitted, you will be prompted, with the input hidden if it is sensitive.</p> <p>Usage:</p> <pre><code>hatch config set [OPTIONS] KEY [VALUE]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-show","title":"hatch config show","text":"<p>Show the contents of the config file.</p> <p>Usage:</p> <pre><code>hatch config show [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--all</code>, <code>-a</code> boolean Do not scrub secret fields <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-update","title":"hatch config update","text":"<p>Update the config file with any new fields.</p> <p>Usage:</p> <pre><code>hatch config update [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep","title":"hatch dep","text":"<p>Manage environment dependencies</p> <p>Usage:</p> <pre><code>hatch dep [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-hash","title":"hatch dep hash","text":"<p>Output a hash of the currently defined dependencies.</p> <p>Usage:</p> <pre><code>hatch dep hash [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--project-only</code>, <code>-p</code> boolean Whether or not to exclude environment dependencies <code>False</code> <code>--env-only</code>, <code>-e</code> boolean Whether or not to exclude project dependencies <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-show","title":"hatch dep show","text":"<p>Display dependencies in various formats</p> <p>Usage:</p> <pre><code>hatch dep show [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-show-requirements","title":"hatch dep show requirements","text":"<p>Enumerate dependencies as a list of requirements.</p> <p>Usage:</p> <pre><code>hatch dep show requirements [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--project-only</code>, <code>-p</code> boolean Whether or not to exclude environment dependencies <code>False</code> <code>--env-only</code>, <code>-e</code> boolean Whether or not to exclude project dependencies <code>False</code> <code>--feature</code>, <code>-f</code> text Whether or not to only show the dependencies of the specified features None <code>--all</code> boolean Whether or not to include the dependencies of all features <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-show-table","title":"hatch dep show table","text":"<p>Enumerate dependencies in a tabular format.</p> <p>Usage:</p> <pre><code>hatch dep show table [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--project-only</code>, <code>-p</code> boolean Whether or not to exclude environment dependencies <code>False</code> <code>--env-only</code>, <code>-e</code> boolean Whether or not to exclude project dependencies <code>False</code> <code>--lines</code>, <code>-l</code> boolean Whether or not to show lines between table rows <code>False</code> <code>--ascii</code> boolean Whether or not to only use ASCII characters <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env","title":"hatch env","text":"<p>Manage project environments</p> <p>Usage:</p> <pre><code>hatch env [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-create","title":"hatch env create","text":"<p>Create environments.</p> <p>Usage:</p> <pre><code>hatch env create [OPTIONS] [ENV_NAME]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-find","title":"hatch env find","text":"<p>Locate environments.</p> <p>Usage:</p> <pre><code>hatch env find [OPTIONS] [ENV_NAME]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-prune","title":"hatch env prune","text":"<p>Remove all environments.</p> <p>Usage:</p> <pre><code>hatch env prune [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-remove","title":"hatch env remove","text":"<p>Remove environments.</p> <p>Usage:</p> <pre><code>hatch env remove [OPTIONS] [ENV_NAME]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-run","title":"hatch env run","text":"<p>Run commands within project environments.</p> <p>The <code>-e</code>/<code>--env</code> option overrides the equivalent root option and the <code>HATCH_ENV</code> environment variable.</p> <p>The <code>-i</code>/<code>--include</code> and <code>-x</code>/<code>--exclude</code> options may be used to include or exclude certain variables, optionally followed by specific comma-separated values, and may be selected multiple times. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <p>then running:</p> <pre><code>hatch env run -i py=3.10 -x version=9000 test:pytest\n</code></pre> <p>would execute <code>pytest</code> in the environments <code>test.py3.10-42</code> and <code>test.py3.10-3.14</code>. Note that <code>py</code> may be used as an alias for <code>python</code>.</p> <p>Usage:</p> <pre><code>hatch env run [OPTIONS] ARGS...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--env</code>, <code>-e</code> text The environments to target None <code>--include</code>, <code>-i</code> text The matrix variables to include None <code>--exclude</code>, <code>-x</code> text The matrix variables to exclude None <code>--filter</code>, <code>-f</code> text The JSON data used to select environments None <code>--force-continue</code> boolean Run every command and if there were any errors exit with the first code <code>False</code> <code>--ignore-compat</code> boolean Ignore incompatibility when selecting specific environments <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-show","title":"hatch env show","text":"<p>Show the available environments.</p> <p>Usage:</p> <pre><code>hatch env show [OPTIONS] [ENVS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--ascii</code> boolean Whether or not to only use ASCII characters <code>False</code> <code>--json</code> boolean Whether or not to output in JSON format <code>False</code> <code>--internal</code>, <code>-i</code> boolean Show internal environments <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-fmt","title":"hatch fmt","text":"<p>Format and lint source code.</p> <p>Usage:</p> <pre><code>hatch fmt [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--check</code> boolean Only check for errors rather than fixing them <code>False</code> <code>--linter</code>, <code>-l</code> boolean Only run the linter <code>False</code> <code>--formatter</code>, <code>-f</code> boolean Only run the formatter <code>False</code> <code>--sync</code> boolean Sync the default config file with the current version of Hatch <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-new","title":"hatch new","text":"<p>Create or initialize a project.</p> <p>Usage:</p> <pre><code>hatch new [OPTIONS] [NAME] [LOCATION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--interactive</code>, <code>-i</code> boolean Interactively choose details about the project <code>False</code> <code>--cli</code> boolean Give the project a command line interface <code>False</code> <code>--init</code> boolean Initialize an existing project <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-project","title":"hatch project","text":"<p>View project information</p> <p>Usage:</p> <pre><code>hatch project [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-project-metadata","title":"hatch project metadata","text":"<p>Display project metadata.</p> <p>If you want to view the raw readme file without rendering, you can use a JSON parser like jq:</p> <pre><code>hatch project metadata | jq -r .readme\n</code></pre> <p>Usage:</p> <pre><code>hatch project metadata [OPTIONS] [FIELD]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-publish","title":"hatch publish","text":"<p>Publish build artifacts.</p> <p>Usage:</p> <pre><code>hatch publish [OPTIONS] [ARTIFACTS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--repo</code>, <code>-r</code> text The repository with which to publish artifacts [env var: <code>HATCH_INDEX_REPO</code>] None <code>--user</code>, <code>-u</code> text The user with which to authenticate [env var: <code>HATCH_INDEX_USER</code>] None <code>--auth</code>, <code>-a</code> text The credentials to use for authentication [env var: <code>HATCH_INDEX_AUTH</code>] None <code>--ca-cert</code> text The path to a CA bundle [env var: <code>HATCH_INDEX_CA_CERT</code>] None <code>--client-cert</code> text The path to a client certificate, optionally containing the private key [env var: <code>HATCH_INDEX_CLIENT_CERT</code>] None <code>--client-key</code> text The path to the client certificate's private key [env var: <code>HATCH_INDEX_CLIENT_KEY</code>] None <code>--no-prompt</code>, <code>-n</code> boolean Disable prompts, such as for missing required fields <code>False</code> <code>--initialize-auth</code> boolean Save first-time authentication information even if nothing was published <code>False</code> <code>--publisher</code>, <code>-p</code> text The publisher plugin to use (default is <code>index</code>) [env var: <code>HATCH_PUBLISHER</code>] <code>index</code> <code>--option</code>, <code>-o</code> text Options to pass to the publisher plugin. This may be selected multiple times e.g. <code>-o foo=bar -o baz=23</code> [env var: <code>HATCH_PUBLISHER_OPTIONS</code>] None <code>--yes</code>, <code>-y</code> boolean Confirm without prompting when the plugin is disabled <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python","title":"hatch python","text":"<p>Manage Python installations</p> <p>Usage:</p> <pre><code>hatch python [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-find","title":"hatch python find","text":"<p>Locate Python binaries.</p> <p>Usage:</p> <pre><code>hatch python find [OPTIONS] NAME\n</code></pre> <p>Options:</p> Name Type Description Default <code>-p</code>, <code>--parent</code> boolean Show the parent directory of the Python binary <code>False</code> <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-install","title":"hatch python install","text":"<p>Install Python distributions.</p> <p>You may select <code>all</code> to install all compatible distributions:</p> <pre><code>hatch python install all\n</code></pre> <p>Usage:</p> <pre><code>hatch python install [OPTIONS] NAMES...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--private</code> boolean Do not add distributions to the user PATH <code>False</code> <code>--update</code>, <code>-u</code> boolean Update existing installations <code>False</code> <code>--dir</code>, <code>-d</code> text The directory in which to install distributions, overriding configuration None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-remove","title":"hatch python remove","text":"<p>Remove Python distributions.</p> <p>You may select <code>all</code> to remove all installed distributions:</p> <pre><code>hatch python remove all\n</code></pre> <p>Usage:</p> <pre><code>hatch python remove [OPTIONS] NAMES...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-show","title":"hatch python show","text":"<p>Show the available Python distributions.</p> <p>Usage:</p> <pre><code>hatch python show [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--ascii</code> boolean Whether or not to only use ASCII characters <code>False</code> <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-update","title":"hatch python update","text":"<p>Update Python distributions.</p> <p>You may select <code>all</code> to update all installed distributions:</p> <pre><code>hatch python update all\n</code></pre> <p>Usage:</p> <pre><code>hatch python update [OPTIONS] NAMES...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-run","title":"hatch run","text":"<p>Run commands within project environments. This is a convenience wrapper around the <code>env run</code> command.</p> <p>If the first argument contains a colon, then the preceding component will be interpreted as the name of the environment to target, overriding the <code>-e</code>/<code>--env</code> root option and the <code>HATCH_ENV</code> environment variable.</p> <p>If the environment provides matrices, then you may also provide leading arguments starting with a <code>+</code> or <code>-</code> to select or exclude certain variables, optionally followed by specific comma-separated values. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <p>then running:</p> <pre><code>hatch run +py=3.10 -version=9000 test:pytest\n</code></pre> <p>would execute <code>pytest</code> in the environments <code>test.py3.10-42</code> and <code>test.py3.10-3.14</code>. Note that <code>py</code> may be used as an alias for <code>python</code>.</p> <p>Usage:</p> <pre><code>hatch run [OPTIONS] [ENV:]ARGS...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self","title":"hatch self","text":"<p>Manage Hatch</p> <p>Usage:</p> <pre><code>hatch self [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self-report","title":"hatch self report","text":"<p>Generate a pre-populated GitHub issue.</p> <p>Usage:</p> <pre><code>hatch self report [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--no-open</code>, <code>-n</code> boolean Show the URL instead of opening it <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self-restore","title":"hatch self restore","text":"<p>Restore the installation</p> <p>Usage:</p> <pre><code>hatch self restore [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self-update","title":"hatch self update","text":"<p>Install the latest version</p> <p>Usage:</p> <pre><code>hatch self update [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-shell","title":"hatch shell","text":"<p>Enter a shell within a project's environment.</p> <p>Usage:</p> <pre><code>hatch shell [OPTIONS] [SHELL_NAME] [SHELL_PATH] [SHELL_ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-status","title":"hatch status","text":"<p>Show information about the current environment.</p> <p>Usage:</p> <pre><code>hatch status [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-test","title":"hatch test","text":"<p>Run tests using the <code>hatch-test</code> environment matrix.</p> <p>If no filtering options are selected, then tests will be run in the first compatible environment found in the matrix with priority given to those matching the current interpreter.</p> <p>The <code>-i</code>/<code>--include</code> and <code>-x</code>/<code>--exclude</code> options may be used to include or exclude certain variables, optionally followed by specific comma-separated values, and may be selected multiple times. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <p>then running:</p> <pre><code>hatch test -i py=3.10 -x version=9000\n</code></pre> <p>would run tests in the environments <code>hatch-test.py3.10-42</code> and <code>hatch-test.py3.10-3.14</code>.</p> <p>The <code>-py</code>/<code>--python</code> option is a shortcut for specifying the inclusion <code>-i py=...</code>.</p> <p>Usage:</p> <pre><code>hatch test [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--randomize</code>, <code>-r</code> boolean Randomize the order of test execution <code>False</code> <code>--parallel</code>, <code>-p</code> boolean Parallelize test execution <code>False</code> <code>--retries</code> integer Number of times to retry failed tests None <code>--retry-delay</code> float Seconds to wait between retries None <code>--cover</code>, <code>-c</code> boolean Measure code coverage <code>False</code> <code>--cover-quiet</code> boolean Disable coverage reporting after tests, implicitly enabling --cover <code>False</code> <code>--all</code>, <code>-a</code> boolean Test all environments in the matrix <code>False</code> <code>--python</code>, <code>-py</code> text The Python versions to test, equivalent to: -i py=... None <code>--include</code>, <code>-i</code> text The matrix variables to include None <code>--exclude</code>, <code>-x</code> text The matrix variables to exclude None <code>--show</code>, <code>-s</code> boolean Show information about environments in the matrix <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-version","title":"hatch version","text":"<p>View or set a project's version.</p> <p>Usage:</p> <pre><code>hatch version [OPTIONS] [DESIRED_VERSION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"community/contributing/","title":"Contributing","text":"<p>The usual process to make a contribution is to:</p> <ol> <li>Check for existing related issues</li> <li>Fork the repository and create a new branch</li> <li>Make your changes</li> <li>Make sure formatting, linting and tests passes.</li> <li>Add tests if possible to cover the lines you added.</li> <li>Commit, and send a Pull Request.</li> </ol>"},{"location":"community/contributing/#clone-the-repository","title":"Clone the repository","text":"<p>Clone the <code>hatch</code> repository, <code>cd</code> into it, and create a new branch for your contribution:</p> <pre><code>cd hatch\ngit checkout -b add-my-contribution\n</code></pre>"},{"location":"community/contributing/#run-the-tests","title":"Run the tests","text":"<p>Run the test suite while developing:</p> <pre><code>hatch run dev\n</code></pre> <p>Run the test suite with coverage report:</p> <pre><code>hatch run cov\n</code></pre> <p>Run the extended test suite with coverage:</p> <pre><code>hatch run full\n</code></pre>"},{"location":"community/contributing/#lint","title":"Lint","text":"<p>Run automated formatting:</p> <pre><code>hatch run lint:fmt\n</code></pre> <p>Run full linting and type checking:</p> <pre><code>hatch run lint:all\n</code></pre>"},{"location":"community/contributing/#docs","title":"Docs","text":"<p>Start the documentation in development:</p> <pre><code>hatch run docs:serve\n</code></pre> <p>Build and validate the documentation website:</p> <pre><code>hatch run docs:build-check\n</code></pre>"},{"location":"community/highlights/","title":"Community highlights","text":""},{"location":"community/highlights/#integration","title":"Integration","text":"<ul> <li>Project Jupyter - https://blog.jupyter.org/packaging-for-jupyter-in-2022-c7be64c38926</li> </ul>"},{"location":"community/highlights/#adoption","title":"Adoption","text":"<ul> <li>Black - https://ichard26.github.io/blog/2022/10/black-22.10.0/#goodbye-python-36-and-hello-hatchling</li> <li>\"Switching to Hatch\" - https://andrich.me/2023/08/switching-to-hatch/</li> </ul>"},{"location":"community/users/","title":"Users","text":"<p>The following is not intended to be a complete enumeration. Be sure to view the development version of this page for an up-to-date listing.</p>"},{"location":"community/users/#projects","title":"Projects","text":"<p>aiogram | Apache Airflow | argon2-cffi | attrs | Black | coffea | Colorama | Django Anymail | Django Debug Toolbar | Django Wiki | FastAPI | filelock | github3.py | Gradio | HTTPX | iCalendar for Humans | LinkChecker | Material for MkDocs | MkDocs | openSUSE | Nox | Packit | pipx | platformdirs | Pydantic | Pygments | PyHamcrest | PyMdown Extensions | Python JSON Schema | Rye | SALib | Spack | Starlette | structlog | tox | Twisted | urllib3 | Uvicorn | virtualenv | Voil\u00e0 | XGBoost | Ypy</p>"},{"location":"community/users/#industry","title":"Industry","text":"<ul> <li>Anaconda <sup>[1|2|3|4|5|6]</sup></li> <li>Astronomer <sup>[1]</sup></li> <li>Bloomberg <sup>[1|2]</sup></li> <li>Blue Robotics <sup>[1]</sup></li> <li>Cars.com <sup>[1]</sup></li> <li>Databricks <sup>[1|2]</sup></li> <li>Datadog <sup>[1|2|3|4]</sup></li> <li>deepset <sup>[1|2]</sup></li> <li>Elastic <sup>[1|2|3]</sup></li> <li>Google <sup>[1|2|3|4|5]</sup></li> <li>IBM <sup>[1]</sup></li> <li>JPMorgan Chase <sup>[1]</sup></li> <li>Intel Corporation <sup>[1|2|3]</sup></li> <li>Meta <sup>[1|2]</sup></li> <li>Microsoft <sup>[1|2|3|4|5]</sup></li> <li>OpenAI <sup>[1]</sup></li> <li>Oracle <sup>[1]</sup></li> <li>Palo Alto Networks <sup>[1]</sup></li> <li>Red Hat <sup>[1|2|3|4|5]</sup></li> <li>Snowflake <sup>[1]</sup></li> <li>Splunk <sup>[1]</sup></li> <li>Virtru <sup>[1|2]</sup></li> <li>VMware <sup>[1|2|3]</sup></li> <li>Volvo Group <sup>[1]</sup></li> </ul>"},{"location":"community/users/#organizations","title":"Organizations","text":"<ul> <li>Greater Paris University Hospitals (AP-HP) <sup>[1]</sup></li> <li>OpenTelemetry <sup>[1|2]</sup></li> <li>Smithsonian Institution <sup>[1]</sup></li> <li>The New York Public Library <sup>[1]</sup></li> </ul>"},{"location":"community/users/#government","title":"Government","text":"<ul> <li>European Molecular Biology Laboratory<ul> <li>European Bioinformatics Institute <sup>[1]</sup></li> </ul> </li> <li>Germany<ul> <li>Berlin Institute of Health <sup>[1]</sup></li> <li>Helmholtz Munich <sup>[1|2]</sup></li> </ul> </li> <li>Norway<ul> <li>Statistics Norway <sup>[1]</sup></li> </ul> </li> <li>United Kingdom<ul> <li>The Alan Turing Institute <sup>[1]</sup></li> <li>Department for Business and Trade <sup>[1]</sup></li> <li>The National Archives <sup>[1]</sup></li> </ul> </li> <li>United States<ul> <li>NASA <sup>[1]</sup></li> <li>National Security Agency <sup>[1|2]</sup></li> <li>National Telecommunications and Information Administration <sup>[1|2|3|4]</sup></li> </ul> </li> </ul>"},{"location":"community/users/#academia","title":"Academia","text":"<ul> <li>Brown University<ul> <li>Carney Institute for Brain Science <sup>[1]</sup></li> </ul> </li> <li>Chinese Academy of Sciences<ul> <li>Academy of Mathematics and Systems Science <sup>[1]</sup></li> </ul> </li> <li>Georgia Institute of Technology<ul> <li>Georgia Tech Database Group <sup>[1]</sup></li> </ul> </li> <li>Harvard University<ul> <li>Department of Molecular and Cellular Biology <sup>[1]</sup></li> </ul> </li> <li>Heidelberg University<ul> <li>Center for Molecular Biology <sup>[1]</sup></li> </ul> </li> <li>Leiden University<ul> <li>Leiden University Libraries <sup>[1|2]</sup></li> </ul> </li> <li>Maastricht University<ul> <li>Institute of Data Science <sup>[1|2|3|4|5|6|7]</sup></li> </ul> </li> <li>Massachusetts Institute of Technology<ul> <li>Computer Science and Artificial Intelligence Laboratory <sup>[1]</sup></li> <li>Digital Humanities <sup>[1]</sup></li> </ul> </li> <li>Medical University of Innsbruck<ul> <li>Institute of Bioinformatics <sup>[1]</sup></li> </ul> </li> <li>Polytechnique Montr\u00e9al<ul> <li>Department of Computer Engineering and Software Engineering <sup>[1]</sup></li> </ul> </li> <li>Siberian Branch of the Russian Academy of Sciences<ul> <li>Institute of Cytology and Genetics <sup>[1|2|3|4]</sup></li> </ul> </li> <li>Stanford University<ul> <li>Empirical Security Research Group <sup>[1]</sup></li> </ul> </li> <li>University of British Columbia<ul> <li>Department of Earth, Ocean and Atmospheric Sciences <sup>[1|2|3]</sup></li> </ul> </li> <li>University of California, Berkeley<ul> <li>Center for Computational Biology <sup>[1]</sup></li> </ul> </li> <li>University of Freiburg<ul> <li>Freiburg Center for Data Analysis and Modeling <sup>[1]</sup></li> </ul> </li> <li>University of Illinois Urbana-Champaign<ul> <li>Grainger College of Engineering <sup>[1]</sup></li> </ul> </li> <li>University of Lausanne<ul> <li>Department of Computational Biology <sup>[1]</sup></li> </ul> </li> <li>University of Ljubljana<ul> <li>Faculty of Mechanical Engineering <sup>[1]</sup></li> </ul> </li> <li>University of Oxford<ul> <li>Oxford Research Software Engineering <sup>[1]</sup></li> </ul> </li> <li>University of Pennsylvania<ul> <li>Lifespan Informatics and Neuroimaging Center <sup>[1]</sup></li> </ul> </li> <li>University of Sussex<ul> <li>Predictive Analytics Lab <sup>[1]</sup></li> </ul> </li> <li>University of Toronto Scarborough<ul> <li>utsc-networking <sup>[1|2|3|4]</sup></li> </ul> </li> <li>University of Washington<ul> <li>Interactive Data Lab <sup>[1]</sup></li> <li>Virtual Brain Lab <sup>[1]</sup></li> </ul> </li> <li>Waseda University<ul> <li>Tackeuchi Laboratory <sup>[1|2|3|4|5]</sup></li> </ul> </li> <li>Wellcome Sanger Institute <sup>[1]</sup></li> </ul>"},{"location":"community/users/#research","title":"Research","text":"<ul> <li>Clariah <sup>[1]</sup></li> <li>CloudDrift <sup>[1]</sup></li> <li>GAMA <sup>[1]</sup></li> <li>IPython <sup>[1|2|3]</sup></li> <li>MNE <sup>[1|2|3]</sup></li> <li>NIPY <sup>[1|2]</sup></li> <li>Project Jupyter<ul> <li>Jupyter <sup>[1|2|3|4]</sup></li> <li>JupyterLab <sup>[1|2|3|4|5]</sup></li> <li>Jupyter Server <sup>[1|2|3|4]</sup></li> </ul> </li> <li>Scikit-HEP <sup>[1|2|3|4|5|6|7|8|9|10]</sup></li> <li>scverse <sup>[1|2|3]</sup></li> <li>Spyder <sup>[1]</sup></li> </ul>"},{"location":"community/users/#security","title":"Security","text":"<ul> <li>Armory</li> <li>in-toto</li> <li>The Update Framework</li> </ul>"},{"location":"community/users/#crypto","title":"Crypto","text":"<ul> <li>Ocean Protocol <sup>[1]</sup></li> </ul>"},{"location":"config/build/","title":"Build configuration","text":"<p>Build targets are defined as sections within <code>tool.hatch.build.targets</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;TARGET_NAME&gt;]\n</code></pre> <pre><code>[build.targets.&lt;TARGET_NAME&gt;]\n</code></pre> <p>Tip</p> <p>Although not recommended, you may define global configuration in the <code>tool.hatch.build</code> table. Keys may then be overridden by target config.</p>"},{"location":"config/build/#build-system","title":"Build system","text":"<p>To be compatible with the broader Python packaging ecosystem, you must define the build system as follows:</p>  pyproject.toml <pre><code>[build-system]\nrequires = [\"hatchling\"]\nbuild-backend = \"hatchling.build\"\n</code></pre> <p>The version of <code>hatchling</code> defined here will be used to build all targets.</p> <p>Hatchling is a standards-compliant<sup>1</sup> build backend and is a dependency of Hatch itself.</p>"},{"location":"config/build/#file-selection","title":"File selection","text":""},{"location":"config/build/#vcs","title":"VCS","text":"<p>By default, Hatch will respect the first <code>.gitignore</code> or <code>.hgignore</code> file found in your project's root directory or parent directories. Set <code>ignore-vcs</code> to <code>true</code> to disable this behavior:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\nignore-vcs = true\n</code></pre> <pre><code>[build.targets.sdist]\nignore-vcs = true\n</code></pre> <p>Note</p> <p>For <code>.hgignore</code> files only glob syntax is supported.</p>"},{"location":"config/build/#patterns","title":"Patterns","text":"<p>You can set the <code>include</code> and <code>exclude</code> options to select exactly which files will be shipped in each build, with <code>exclude</code> taking precedence. Every entry represents a Git-style glob pattern.</p> <p>For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\ninclude = [\n  \"pkg/*.py\",\n  \"/tests\",\n]\nexclude = [\n  \"*.json\",\n  \"pkg/_compat.py\",\n]\n</code></pre> <pre><code>[build.targets.sdist]\ninclude = [\n  \"pkg/*.py\",\n  \"/tests\",\n]\nexclude = [\n  \"*.json\",\n  \"pkg/_compat.py\",\n]\n</code></pre> <p>will exclude every file with a <code>.json</code> extension, and will include everything under a <code>tests</code> directory located at the root and every file with a <code>.py</code> extension that is directly under a <code>pkg</code> directory located at the root except for <code>_compat.py</code>.</p>"},{"location":"config/build/#artifacts","title":"Artifacts","text":"<p>If you want to include files that are ignored by your VCS, such as those that might be created by build hooks, you can use the <code>artifacts</code> option. This option is semantically equivalent to <code>include</code>.</p> <p>Note that artifacts are not affected by the <code>exclude</code> option. Artifacts can be excluded by using more explicit paths or by using the <code>!</code> negation operator. When using the <code>!</code> operator, the negated pattern(s) must come after the more generic ones.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nartifacts = [\n  \"*.so\",\n  \"*.dll\",\n  \"!/foo/*.so\",\n]\n</code></pre> <pre><code>[build.targets.wheel]\nartifacts = [\n  \"*.so\",\n  \"*.dll\",\n  \"!/foo/*.so\",\n]\n</code></pre>"},{"location":"config/build/#explicit-selection","title":"Explicit selection","text":""},{"location":"config/build/#generic","title":"Generic","text":"<p>You can use the <code>only-include</code> option to prevent directory traversal starting at the project root and only select specific relative paths to directories or files. Using this option ignores any defined <code>include</code> patterns.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\nonly-include = [\"pkg\", \"tests/unit\"]\n</code></pre> <pre><code>[build.targets.sdist]\nonly-include = [\"pkg\", \"tests/unit\"]\n</code></pre>"},{"location":"config/build/#packages","title":"Packages","text":"<p>The <code>packages</code> option is semantically equivalent to <code>only-include</code> (which takes precedence) except that the shipped path will be collapsed to only include the final component.</p> <p>So for example, if you want to ship a package <code>foo</code> that is stored in a directory <code>src</code> you would do:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre> <pre><code>[build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre>"},{"location":"config/build/#forced-inclusion","title":"Forced inclusion","text":"<p>The <code>force-include</code> option allows you to select specific files or directories from anywhere on the file system that should be included and map them to the desired relative distribution path.</p> <p>For example, if there was a directory alongside the project root named <code>artifacts</code> containing a file named <code>lib.so</code> and a file named <code>lib.h</code> in your home directory, you could ship both files in a <code>pkg</code> directory with the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel.force-include]\n\"../artifacts\" = \"pkg\"\n\"~/lib.h\" = \"pkg/lib.h\"\n</code></pre> <pre><code>[build.targets.wheel.force-include]\n\"../artifacts\" = \"pkg\"\n\"~/lib.h\" = \"pkg/lib.h\"\n</code></pre> <p>Note</p> <ul> <li>Files must be mapped exactly to their desired paths, not to directories.</li> <li>The contents of directory sources are recursively included.</li> <li>To map directory contents directly to the root use <code>/</code> (a forward slash).</li> <li>Sources that do not exist will raise an error.</li> </ul> <p>Warning</p> <p>Files included using this option will overwrite any file path that was already included by other file selection options.</p>"},{"location":"config/build/#default-file-selection","title":"Default file selection","text":"<p>If no file selection options are provided, then what gets included is determined by each build target.</p>"},{"location":"config/build/#excluding-files-outside-packages","title":"Excluding files outside packages","text":"<p>If you want to exclude non-artifact files that do not reside within a Python package, set <code>only-packages</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nonly-packages = true\n</code></pre> <pre><code>[build.targets.wheel]\nonly-packages = true\n</code></pre>"},{"location":"config/build/#rewriting-paths","title":"Rewriting paths","text":"<p>You can rewrite relative paths to directories with the <code>sources</code> option. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel.sources]\n\"src/foo\" = \"bar\"\n</code></pre> <pre><code>[build.targets.wheel.sources]\n\"src/foo\" = \"bar\"\n</code></pre> <p>would distribute the file <code>src/foo/file.ext</code> as <code>bar/file.ext</code>.</p> <p>If you want to remove path prefixes entirely, rather than setting each to an empty string, you can define <code>sources</code> as an array:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nsources = [\"src\"]\n</code></pre> <pre><code>[build.targets.wheel]\nsources = [\"src\"]\n</code></pre> <p>If you want to add a prefix to paths, you can use an empty string. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel.sources]\n\"\" = \"foo\"\n</code></pre> <pre><code>[build.targets.wheel.sources]\n\"\" = \"foo\"\n</code></pre> <p>would distribute the file <code>bar/file.ext</code> as <code>foo/bar/file.ext</code>.</p> <p>The packages option itself relies on sources. Defining <code>packages = [\"src/foo\"]</code> for the <code>wheel</code> target is equivalent to the following:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nonly-include = [\"src/foo\"]\nsources = [\"src\"]\n</code></pre> <pre><code>[build.targets.wheel]\nonly-include = [\"src/foo\"]\nsources = [\"src\"]\n</code></pre>"},{"location":"config/build/#performance","title":"Performance","text":"<p>All encountered directories are traversed by default. To skip non-artifact directories that are excluded, set <code>skip-excluded-dirs</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\nskip-excluded-dirs = true\n</code></pre> <pre><code>[build]\nskip-excluded-dirs = true\n</code></pre> <p>Warning</p> <p>This may result in not shipping desired files. For example, if you want to include the file <code>a/b/c.txt</code> but your VCS ignores <code>a/b</code>, the file <code>c.txt</code> will not be seen because its parent directory will not be entered. In such cases you can use the <code>force-include</code> option.</p>"},{"location":"config/build/#reproducible-builds","title":"Reproducible builds","text":"<p>By default, build targets will build in a reproducible manner provided that they support that behavior. To disable this, set <code>reproducible</code> to <code>false</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\nreproducible = false\n</code></pre> <pre><code>[build]\nreproducible = false\n</code></pre> <p>When enabled, the SOURCE_DATE_EPOCH environment variable will be used for all build timestamps. If not set, then Hatch will use an unchanging default value.</p>"},{"location":"config/build/#output-directory","title":"Output directory","text":"<p>When the output directory is not provided to the <code>build</code> command, the <code>dist</code> directory will be used by default. You can change the default to a different directory using a relative or absolute path like so:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\ndirectory = \"&lt;PATH&gt;\"\n</code></pre> <pre><code>[build]\ndirectory = \"&lt;PATH&gt;\"\n</code></pre>"},{"location":"config/build/#dev-mode","title":"Dev mode","text":"<p>By default for dev mode environment installations or editable installs, the <code>wheel</code> target will determine which directories should be added to Python's search path based on the selected files.</p> <p>If you want to override this detection or perhaps instruct other build targets as well, you can use the <code>dev-mode-dirs</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\ndev-mode-dirs = [\".\"]\n</code></pre> <pre><code>[build]\ndev-mode-dirs = [\".\"]\n</code></pre> <p>If you don't want to add entire directories to Python's search path, you can enable a more targeted mechanism with the mutually exclusive <code>dev-mode-exact</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\ndev-mode-exact = true\n</code></pre> <pre><code>[build]\ndev-mode-exact = true\n</code></pre> <p>Warning</p> <p>The <code>dev-mode-exact</code> mechanism is not supported by static analysis tools &amp; IDEs, therefore functionality such as autocompletion is unlikely to work.</p>"},{"location":"config/build/#build-targets","title":"Build targets","text":"<p>A build target can be provided by any builder plugin. There are three built-in build targets: wheel, sdist, and custom.</p>"},{"location":"config/build/#dependencies","title":"Dependencies","text":"<p>You can specify additional dependencies that will be installed in each build environment, such as for third party builders:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.your-target-name]\ndependencies = [\n  \"your-builder-plugin\"\n]\n</code></pre> <pre><code>[build.targets.your-target-name]\ndependencies = [\n  \"your-builder-plugin\"\n]\n</code></pre> <p>You can also declare dependence on the project's runtime dependencies with the <code>require-runtime-dependencies</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.your-target-name]\nrequire-runtime-dependencies = true\n</code></pre> <pre><code>[build.targets.your-target-name]\nrequire-runtime-dependencies = true\n</code></pre> <p>Additionally, you may declare dependence on specific runtime features of the project with the <code>require-runtime-features</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.your-target-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre> <pre><code>[build.targets.your-target-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre>"},{"location":"config/build/#versions","title":"Versions","text":"<p>If a build target supports multiple build strategies or if there are major changes over time, you can specify exactly which versions you want to build using the <code>versions</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;TARGET_NAME&gt;]\nversions = [\n  \"v1\",\n  \"beta-feature\",\n]\n</code></pre> <pre><code>[build.targets.&lt;TARGET_NAME&gt;]\nversions = [\n  \"v1\",\n  \"beta-feature\",\n]\n</code></pre> <p>See the wheel target for a real world example.</p>"},{"location":"config/build/#build-hooks","title":"Build hooks","text":"<p>A build hook defines code that will be executed at various stages of the build process and can be provided by any build hook plugin. There is one built-in build hook: custom.</p> <p>Build hooks can be applied either globally:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.&lt;HOOK_NAME&gt;]\n</code></pre> <pre><code>[build.hooks.&lt;HOOK_NAME&gt;]\n</code></pre> <p>or to specific build targets:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;HOOK_NAME&gt;]\n</code></pre> <pre><code>[build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;HOOK_NAME&gt;]\n</code></pre>"},{"location":"config/build/#dependencies_1","title":"Dependencies","text":"<p>You can specify additional dependencies that will be installed in each build environment, such as for third party build hooks:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.your-hook-name]\ndependencies = [\n  \"your-build-hook-plugin\"\n]\n</code></pre> <pre><code>[build.hooks.your-hook-name]\ndependencies = [\n  \"your-build-hook-plugin\"\n]\n</code></pre> <p>You can also declare dependence on the project's runtime dependencies with the <code>require-runtime-dependencies</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.your-hook-name]\nrequire-runtime-dependencies = true\n</code></pre> <pre><code>[build.hooks.your-hook-name]\nrequire-runtime-dependencies = true\n</code></pre> <p>Additionally, you may declare dependence on specific runtime features of the project with the <code>require-runtime-features</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.your-hook-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre> <pre><code>[build.hooks.your-hook-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre>"},{"location":"config/build/#order-of-execution","title":"Order of execution","text":"<p>For each build target, build hooks execute in the order in which they are defined, starting with global hooks.</p> <p>As an example, for the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.foo.hooks.hook2]\n\n[tool.hatch.build.hooks.hook3]\n[tool.hatch.build.hooks.hook1]\n</code></pre> <pre><code>[build.targets.foo.hooks.hook2]\n\n[build.hooks.hook3]\n[build.hooks.hook1]\n</code></pre> <p>When target <code>foo</code> is built, build hook <code>hook3</code> will be executed first, followed by <code>hook1</code>, and then finally <code>hook2</code>.</p>"},{"location":"config/build/#conditional-execution","title":"Conditional execution","text":"<p>If you want to disable a build hook by default and control its use by environment variables, you can do so by setting the <code>enable-by-default</code> option to <code>false</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.&lt;HOOK_NAME&gt;]\nenable-by-default = false\n</code></pre> <pre><code>[build.hooks.&lt;HOOK_NAME&gt;]\nenable-by-default = false\n</code></pre>"},{"location":"config/build/#environment-variables","title":"Environment variables","text":"Variable Default Description <code>HATCH_BUILD_CLEAN</code> <code>false</code> Whether or not existing artifacts should first be removed <code>HATCH_BUILD_CLEAN_HOOKS_AFTER</code> <code>false</code> Whether or not build hook artifacts should be removed after each build <code>HATCH_BUILD_HOOKS_ONLY</code> <code>false</code> Whether or not to only execute build hooks <code>HATCH_BUILD_NO_HOOKS</code> <code>false</code> Whether or not to disable all build hooks; this takes precedence over other options <code>HATCH_BUILD_HOOKS_ENABLE</code> <code>false</code> Whether or not to enable all build hooks <code>HATCH_BUILD_HOOK_ENABLE_&lt;HOOK_NAME&gt;</code> <code>false</code> Whether or not to enable the build hook named <code>&lt;HOOK_NAME&gt;</code> <code>HATCH_BUILD_LOCATION</code> <code>dist</code> The location with which to build the targets; only used by the <code>build</code> command <ol> <li> <p>Support for PEP 517 and PEP 660 guarantees interoperability with other build tools.\u00a0\u21a9</p> </li> </ol>"},{"location":"config/context/","title":"Context formatting","text":"<p>You can populate configuration with the values of certain supported fields using the syntax of Python's format strings. Each field interprets the modifier part after the colon differently, if at all.</p>"},{"location":"config/context/#global-fields","title":"Global fields","text":"<p>Any configuration that declares support for context formatting will always support these fields.</p>"},{"location":"config/context/#paths","title":"Paths","text":"Field Description <code>root</code> The root project directory <code>home</code> The user's home directory <p>All paths support the following modifiers:</p> Modifier Description <code>uri</code> The normalized absolute URI path prefixed by <code>file:</code> <code>real</code> The path with all symbolic links resolved <code>parent</code> The parent of the preceding path <p>Tip</p> <p>The <code>parent</code> modifier can be chained and may be combined with either the <code>uri</code> or <code>real</code> modifier, with the latter placed at the end. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n    \"example-project @ {root:parent:parent:uri}/example-project\",\n]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n    \"example-project @ {root:parent:parent:uri}/example-project\",\n]\n</code></pre>"},{"location":"config/context/#system-separators","title":"System separators","text":"Field Description <code>/</code> <code>\\</code> on Windows, <code>/</code> otherwise <code>;</code> <code>;</code> on Windows, <code>:</code> otherwise"},{"location":"config/context/#environment-variables","title":"Environment variables","text":"<p>The <code>env</code> field and its modifier allow you to select the value of an environment variable. If the environment variable is not set, you must specify a default value as an additional modifier e.g. <code>{env:PATH:DEFAULT}</code>.</p>"},{"location":"config/context/#field-nesting","title":"Field nesting","text":"<p>You can insert fields within others. For example, if you wanted a script that displays the value of the environment variable <code>FOO</code>, with a fallback to the environment variable <code>BAR</code>, with its own fallback to the user's home directory, you could do the following:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.scripts]\ndisplay = \"echo {env:FOO:{env:BAR:{home}}}\"\n</code></pre> <pre><code>[envs.test.scripts]\ndisplay = \"echo {env:FOO:{env:BAR:{home}}}\"\n</code></pre>"},{"location":"config/dependency/","title":"Dependency configuration","text":"<p>Project dependencies are defined with PEP 508 strings using optional PEP 440 version specifiers.</p>"},{"location":"config/dependency/#version-specifiers","title":"Version specifiers","text":"<p>A version specifier consists of a series of version clauses, separated by commas. For example:</p>  pyproject.toml <pre><code>[project]\n...\ndependencies = [\n  \"cryptography\",\n  \"click&gt;=7, &lt;9, != 8.0.0\",\n  \"python-dateutil==2.8.*\",\n  \"numpy~=1.21.4\",\n]\n</code></pre> <p>The comma is equivalent to a logical <code>AND</code> operator: a candidate version must match all given version clauses in order to match the specifier as a whole.</p>"},{"location":"config/dependency/#operators","title":"Operators","text":"Operators Function <code>~=</code> Compatible release <code>==</code> Version matching <code>!=</code> Version exclusion <code>&lt;=</code>, <code>&gt;=</code> Inclusive ordered comparison <code>&lt;</code>, <code>&gt;</code> Exclusive ordered comparison <code>===</code> Arbitrary equality"},{"location":"config/dependency/#version-matching","title":"Version matching","text":"<p>A version matching clause includes the version matching operator <code>==</code> and a version identifier.</p> <p>By default, the version matching operator is based on a strict equality comparison: the specified version must be exactly the same as the requested version.</p> Clause Allowed versions <code>==1</code> <code>1.0.0</code> <code>==1.2</code> <code>1.2.0</code> <p>Prefix matching may be requested instead of strict comparison, by appending a trailing <code>.*</code> to the version identifier in the version matching clause. This means that additional trailing segments will be ignored when determining whether or not a version identifier matches the clause.</p> Clause Allowed versions <code>==1.*</code> <code>&gt;=1.0.0, &lt;2.0.0</code> <code>==1.2.*</code> <code>&gt;=1.2.0, &lt;1.3.0</code>"},{"location":"config/dependency/#compatible-release","title":"Compatible release","text":"<p>A compatible release clause consists of the compatible release operator <code>~=</code> and a version identifier. It matches any candidate version that is expected to be compatible with the specified version.</p> <p>For a given release identifier <code>V.N</code>, the compatible release clause is approximately equivalent to the following pair of comparison clauses:</p> <pre><code>&gt;= V.N, == V.*\n</code></pre> <p>This operator cannot be used with a single segment version number such as <code>~=1</code>.</p> Clause Allowed versions <code>~=1.2</code> <code>&gt;=1.2.0, &lt;2.0.0</code> <code>~=1.2.3</code> <code>&gt;=1.2.3, &lt;1.3.0</code>"},{"location":"config/dependency/#version-exclusion","title":"Version exclusion","text":"<p>A version exclusion clause includes the version exclusion operator <code>!=</code> and a version identifier.</p> <p>The allowed version identifiers and comparison semantics are the same as those of the Version matching operator, except that the sense of any match is inverted.</p>"},{"location":"config/dependency/#ordered-comparison","title":"Ordered comparison","text":"<p>Inclusive comparisons allow for the version identifier part of clauses whereas exclusive comparisons do not. For example, <code>&gt;=1.2</code> allows for version <code>1.2.0</code> while <code>&gt;1.2</code> does not.</p> <p>Unlike the inclusive ordered comparisons <code>&lt;=</code> and <code>&gt;=</code>, the exclusive ordered comparisons <code>&lt;</code> and <code>&gt;</code> specifically exclude pre-releases, post-releases, and local versions of the specified version.</p>"},{"location":"config/dependency/#arbitrary-equality","title":"Arbitrary equality","text":"<p>Though heavily discouraged, arbitrary equality comparisons allow for simple string matching without any version semantics, for example <code>===foobar</code>.</p>"},{"location":"config/dependency/#environment-markers","title":"Environment markers","text":"<p>Environment markers allow for dependencies to only be installed when certain conditions are met.</p> <p>For example, if you need to install the latest version of <code>cryptography</code> that is available for a given Python major version you could define the following:</p> <pre><code>cryptography==3.3.2; python_version &lt; \"3\"\ncryptography&gt;=35.0; python_version &gt; \"3\"\n</code></pre> <p>Alternatively, if you only need it on Python 3 when running on Windows you could do:</p> <pre><code>cryptography; python_version ~= \"3.0\" and platform_system == \"Windows\"\n</code></pre> <p>The available environment markers are as follows.</p> Marker Python equivalent Examples <code>os_name</code> <code>import os</code><code>os.name</code> <ul><li>posix</li><li>java</li></ul> <code>sys_platform</code> <code>import sys</code><code>sys.platform</code> <ul><li>linux</li><li>win32</li><li>darwin</li></ul> <code>platform_machine</code> <code>import platform</code><code>platform.machine()</code> <ul><li>x86_64</li></ul> <code>platform_python_implementation</code> <code>import platform</code><code>platform.python_implementation()</code> <ul><li>CPython</li><li>Jython</li></ul> <code>platform_release</code> <code>import platform</code><code>platform.release()</code> <ul><li>1.8.0_51</li><li>3.14.1-x86_64-linode39</li></ul> <code>platform_system</code> <code>import platform</code><code>platform.system()</code> <ul><li>Linux</li><li>Windows</li><li>Darwin</li></ul> <code>platform_version</code> <code>import platform</code><code>platform.version()</code> <ul><li>10.0.19041</li><li>#1 SMP Fri Apr 2 22:23:49 UTC 2021</li></ul> <code>python_version</code> <code>import platform</code><code>'.'.join(platform.python_version_tuple()[:2])</code> <ul><li>2.7</li><li>3.10</li></ul> <code>python_full_version</code> <code>import platform</code><code>platform.python_version()</code> <ul><li>2.7.18</li><li>3.11.0b1</li></ul> <code>implementation_name</code> <code>import sys</code><code>sys.implementation.name</code> <ul><li>cpython</li></ul> <code>implementation_version</code> See here <ul><li>2.7.18</li><li>3.11.0b1</li></ul>"},{"location":"config/dependency/#features","title":"Features","text":"<p>You can select groups of optional dependencies to install using the extras syntax. For example, if a dependency named <code>foo</code> defined the following:</p>  pyproject.toml <pre><code>[project.optional-dependencies]\ncrypto = [\n  \"PyJWT\",\n  \"cryptography\",\n]\nfastjson = [\n  \"orjson\",\n]\ncli = [\n  \"prompt-toolkit\",\n  \"colorama; platform_system == 'Windows'\",\n]\n</code></pre> <p>You can select the <code>cli</code> and <code>crypto</code> features like so:</p> <pre><code>foo[cli,crypto]==1.*\n</code></pre> <p>Note that the features come immediately after the package name, before any version specifiers.</p>"},{"location":"config/dependency/#self-referential","title":"Self-referential","text":"<p>Feature groups can self-referentially extend others. For example, for a project called <code>awesome-project</code>, the <code>dev</code> feature group in the following <code>pyproject.toml</code> file would select everything in the <code>crypto</code> feature group, plus <code>black</code>:</p>  pyproject.toml <pre><code>[project]\nname = \"awesome-project\"\n\n[project.optional-dependencies]\ncrypto = [\n  \"PyJWT\",\n  \"cryptography\",\n]\ndev = [\n  \"awesome-project[crypto]\",\n  \"black\",\n]\n</code></pre>"},{"location":"config/dependency/#direct-references","title":"Direct references","text":"<p>Instead of using normal version specifiers and fetching packages from an index like PyPI, you can define exact sources using direct references with an explicit URI.</p> <p>Direct references are usually not meant to be used for dependencies of a published project but rather are used for defining dependencies for an environment.</p> <p>All direct reference types are prefixed by the package name like:</p> <pre><code>&lt;NAME&gt; @ &lt;REFERENCE&gt;\n</code></pre>"},{"location":"config/dependency/#version-control-systems","title":"Version control systems","text":"<p>Various version control systems (VCS) are supported as long as the associated executable is available along your <code>PATH</code>.</p> <p>VCS direct references are defined using one of the following formats:</p> <pre><code>&lt;NAME&gt; @ &lt;SCHEME&gt;://&lt;PATH&gt;\n&lt;NAME&gt; @ &lt;SCHEME&gt;://&lt;PATH&gt;@&lt;REVISION&gt;\n</code></pre> <p>You may also append a <code>#subdirectory=&lt;PATH&gt;</code> component for specifying the relative path to the Python package when it is not located at the root e.g. <code>#subdirectory=lib/foo</code>.</p> <p>For more information, refer to this.</p>"},{"location":"config/dependency/#supported-vcs","title":"Supported VCS","text":"GitMercurialSubversionBazaar Executable Schemes Revisions Example <code>git</code> <ul><li><code>git+file</code></li><li><code>git+https</code></li><li><code>git+ssh</code></li><li><code>git+http</code> </li><li><code>git+git</code> </li><li><code>git</code> </li></ul> <ul><li>Commit hash</li><li>Tag name</li><li>Branch name</li></ul> <code>proj @ git+https://github.com/org/proj.git@v1</code> Executable Schemes Revisions Example <code>hg</code> <ul><li><code>hg+file</code></li><li><code>hg+https</code></li><li><code>hg+ssh</code></li><li><code>hg+http</code> </li><li><code>hg+static-http</code> </li></ul> <ul><li>Revision hash</li><li>Revision number</li><li>Tag name</li><li>Branch name</li></ul> <code>proj @ hg+file:///path/to/proj@v1</code> Executable Schemes Revisions Example <code>svn</code> <ul><li><code>svn+https</code></li><li><code>svn+ssh</code></li><li><code>svn+http</code> </li><li><code>svn+svn</code> </li><li><code>svn</code> </li></ul> <ul><li>Revision number</li></ul> <code>proj @ svn+file:///path/to/proj</code> Executable Schemes Revisions Example <code>bzr</code> <ul><li><code>bzr+https</code></li><li><code>bzr+ssh</code></li><li><code>bzr+sftp</code></li><li><code>bzr+lp</code></li><li><code>bzr+http</code> </li><li><code>bzr+ftp</code> </li></ul> <ul><li>Revision number</li><li>Tag name</li></ul> <code>proj @ bzr+lp:proj@v1</code>"},{"location":"config/dependency/#local","title":"Local","text":"<p>You can install local packages with the <code>file</code> scheme in the following format:</p> <pre><code>&lt;NAME&gt; @ file://&lt;HOST&gt;/&lt;PATH&gt;\n</code></pre> <p>The <code>&lt;HOST&gt;</code> is only used on Windows systems, where it can refer to a network share. If omitted it is assumed to be <code>localhost</code> and the third slash must still be present.</p> <p>The <code>&lt;PATH&gt;</code> can refer to a source archive, a wheel, or a directory containing a Python package.</p> Type Unix Windows Source archive <code>proj @ file:///path/to/pkg.tar.gz</code> <code>proj @ file:///c:/path/to/pkg.tar.gz</code> Wheel <code>proj @ file:///path/to/pkg.whl</code> <code>proj @ file:///c:/path/to/pkg.whl</code> Directory <code>proj @ file:///path/to/pkg</code> <code>proj @ file:///c:/path/to/pkg</code> <p>Tip</p> <p>You may also specify paths relative to your project's root directory on all platforms by using context formatting:</p> <pre><code>&lt;NAME&gt; @ {root:uri}/pkg_inside_project\n&lt;NAME&gt; @ {root:uri}/../pkg_alongside_project\n</code></pre>"},{"location":"config/dependency/#remote","title":"Remote","text":"<p>You can install source archives and wheels by simply referring to a URL:</p> <pre><code>black @ https://github.com/psf/black/archive/refs/tags/21.10b0.zip\npytorch @ https://download.pytorch.org/whl/cu102/torch-1.10.0%2Bcu102-cp39-cp39-linux_x86_64.whl\n</code></pre> <p>An expected hash value may be specified by appending a <code>#&lt;HASH_ALGORITHM&gt;=&lt;EXPECTED_HASH&gt;</code> component:</p> <pre><code>requests @ https://github.com/psf/requests/archive/refs/tags/v2.26.0.zip#sha256=eb729a757f01c10546ebd179ae2aec852dd0d7f8ada2328ccf4558909d859985\n</code></pre> <p>If the hash differs from the expected hash, the installation will fail.</p> <p>It is recommended that only hashes which are unconditionally provided by the latest version of the standard library's hashlib module be used for hashes. As of Python 3.10, that list consists of:</p> <ul> <li><code>md5</code></li> <li><code>sha1</code></li> <li><code>sha224</code></li> <li><code>sha256</code></li> <li><code>sha384</code></li> <li><code>sha512</code></li> <li><code>blake2b</code></li> <li><code>blake2s</code></li> </ul>"},{"location":"config/dependency/#complex-syntax","title":"Complex syntax","text":"<p>The following is an example that uses features and environment markers:</p> <pre><code>pkg[feature1,feature2] @ &lt;REFERENCE&gt; ; python_version &lt; \"3.7\"\n</code></pre> <p>Note that the space before the semicolon is required.</p>"},{"location":"config/hatch/","title":"Hatch configuration","text":"<p>Configuration for Hatch itself is stored in a <code>config.toml</code> file located by default in one of the following platform-specific directories.</p> Platform Path macOS <code>~/Library/Application Support/hatch</code> Windows <code>%USERPROFILE%\\AppData\\Local\\hatch</code> Unix <code>$XDG_CONFIG_HOME/hatch</code> (the XDG_CONFIG_HOME environment variable default is <code>~/.config</code>) <p>You can select a custom path to the file using the <code>--config</code> root option or by setting the <code>HATCH_CONFIG</code> environment variable.</p> <p>The file can be managed by the <code>config</code> command group.</p>"},{"location":"config/hatch/#mode","title":"Mode","text":"<p>The <code>mode</code> key controls how Hatch selects the project to work on.</p>"},{"location":"config/hatch/#local","title":"Local","text":"config.toml <pre><code>mode = \"local\"\n</code></pre> <p>By default, Hatch will look for a <code>pyproject.toml</code> file in the current working directory and any parent directories. The directory storing the first found file will be considered the project root.</p>"},{"location":"config/hatch/#project","title":"Project","text":"config.toml <pre><code>mode = \"project\"\nproject = \"proj1\"\n\n[projects]\nproj1 = \"/path/to/project1\"\nproj2 = {\"location\": \"/path/to/project2\"}\n\n[dirs]\nproject = [\"/path/to/monorepo1\", \"/path/to/monorepo2\"]\n</code></pre> <p>In this mode, Hatch will only work on the selected <code>project</code>. The project is located using multiple heuristics:</p> <ol> <li>If the project is defined in the <code>projects</code> table then it must be a string, or an inline table with a <code>location</code> key, that is the full path to the project.</li> <li>If the project matches a subdirectory in any of the directories listed in <code>dirs.project</code>, then that will be used as the project root.</li> </ol> <p>An error will occur if the project cannot be found.</p> <p>You can use the <code>config set</code> command to change the project you are working on:</p> <pre><code>$ hatch config set project proj2\nNew setting:\nproject = \"proj2\"\n</code></pre> <p>The project can be selected on a per-command basis with the <code>-p</code>/<code>--project</code> (environment variable <code>HATCH_PROJECT</code>) root option.</p>"},{"location":"config/hatch/#aware","title":"Aware","text":"config.toml <pre><code>mode = \"aware\"\n</code></pre> <p>This is essentially the <code>local</code> mode with a fallback to the <code>project</code> mode.</p>"},{"location":"config/hatch/#shell","title":"Shell","text":"<p>You can control the shell used to enter environments with the <code>shell</code> key.</p> <p>If defined as a string, it must be the name of one of the supported shells and be available along your <code>PATH</code>.</p>  config.toml <pre><code>shell = \"fish\"\n</code></pre> <p>If the executable name of your shell differs from the supported name, you can define the <code>shell</code> as a table with <code>name</code> and <code>path</code> keys.</p>  config.toml <pre><code>[shell]\nname = \"bash\"\npath = \"/bin/ash\"\n</code></pre> <p>You can change the default arguments used to spawn most shells with the <code>args</code> key. The default for such supported shells is usually <code>[\"-i\"]</code>.</p>  config.toml <pre><code>[shell]\nname = \"bash\"\nargs = [\"--login\"]\n</code></pre>"},{"location":"config/hatch/#supported","title":"Supported","text":"Shell Name Arguments macOS Windows Unix Almquist shell <code>ash</code> <code>[\"-i\"]</code> Bash <code>bash</code> <code>[\"-i\"]</code> Command Prompt <code>cmd</code> C shell <code>csh</code> <code>[\"-i\"]</code> fish <code>fish</code> <code>[\"-i\"]</code> Nushell <code>nu</code> <code>[]</code> PowerShell <code>pwsh</code>, <code>powershell</code> tcsh <code>tcsh</code> <code>[\"-i\"]</code> xonsh <code>xonsh</code> <code>[\"-i\"]</code> Z shell <code>zsh</code> <code>[\"-i\"]</code>"},{"location":"config/hatch/#default","title":"Default","text":"<p>Hatch will attempt to use the current shell based on parent processes. If the shell cannot be determined, then on Windows systems Hatch will use the <code>SHELL</code> environment variable, if present, followed by the <code>COMSPEC</code> environment variable, defaulting to <code>cmd</code>. On all other platforms only the <code>SHELL</code> environment variable will be used, defaulting to <code>bash</code>.</p>"},{"location":"config/hatch/#directories","title":"Directories","text":""},{"location":"config/hatch/#data","title":"Data","text":"config.toml <pre><code>[dirs]\ndata = \"...\"\n</code></pre> <p>This is the directory that is used to persist data. By default it is set to one of the following platform-specific directories.</p> Platform Path macOS <code>~/Library/Application Support/hatch</code> Windows <code>%USERPROFILE%\\AppData\\Local\\hatch</code> Unix <code>$XDG_DATA_HOME/hatch</code> (the XDG_DATA_HOME environment variable default is <code>~/.local/share</code>) <p>You can select a custom path to the directory using the <code>--data-dir</code> root option or by setting the <code>HATCH_DATA_DIR</code> environment variable.</p>"},{"location":"config/hatch/#cache","title":"Cache","text":"config.toml <pre><code>[dirs]\ncache = \"...\"\n</code></pre> <p>This is the directory that is used to cache data. By default it is set to one of the following platform-specific directories.</p> Platform Path macOS <code>~/Library/Caches/hatch</code> Windows <code>%USERPROFILE%\\AppData\\Local\\hatch\\Cache</code> Unix <code>$XDG_CACHE_HOME/hatch</code> (the XDG_CACHE_HOME environment variable default is <code>~/.cache</code>) <p>You can select a custom path to the directory using the <code>--cache-dir</code> root option or by setting the <code>HATCH_CACHE_DIR</code> environment variable.</p>"},{"location":"config/hatch/#environments","title":"Environments","text":"config.toml <pre><code>[dirs.env]\n&lt;ENV_TYPE&gt; = \"...\"\n</code></pre> <p>This determines where to store environments, with every key being the type of environment and the value being the desired storage location.</p> <p>For example, if you wanted to store virtual environments in a <code>.virtualenvs</code> directory within your home directory, you could specify the following:</p>  config.toml <pre><code>[dirs.env]\nvirtual = \"~/.virtualenvs\"\n</code></pre> <p>Any environment variables are also expanded.</p> <p>If the path is not absolute, then it will be relative to the project root. So if you wanted to use a directory named <code>.hatch</code> in each project directory, you could do:</p>  config.toml <pre><code>[dirs.env]\nvirtual = \".hatch\"\n</code></pre> <p>Any type of environment that is not explicitly defined will default to <code>&lt;DATA_DIR&gt;/env/&lt;ENV_TYPE&gt;</code>.</p>"},{"location":"config/hatch/#python-installations","title":"Python installations","text":"config.toml <pre><code>[dirs]\npython = \"...\"\n</code></pre> <p>This determines where to install specific versions of Python.</p> <p>The following values have special meanings:</p> Value Path <code>isolated</code> (default) <code>&lt;DATA_DIR&gt;/pythons</code>"},{"location":"config/hatch/#terminal","title":"Terminal","text":"<p>You can configure how all output is displayed using the <code>terminal.styles</code> table. These settings are also applied to all plugins.</p>  config.toml <pre><code>[terminal.styles]\nerror = \"...\"\n...\n</code></pre> <p>Cross-platform terminal capabilities are provided by Rich.</p>"},{"location":"config/hatch/#output-levels","title":"Output levels","text":"<p>The levels of output are as follows. Note that the verbosity indicates the minimum level at which the output is displayed.</p> Level Default Verbosity Description <code>debug</code> <code>bold</code> 1 - 3 Messages that are not useful for most user experiences <code>error</code> <code>bold red</code> -2 Messages indicating some unrecoverable error <code>info</code> <code>bold</code> 0 Messages conveying basic information <code>success</code> <code>bold cyan</code> 0 Messages indicating some positive outcome <code>waiting</code> <code>bold magenta</code> 0 Messages shown before potentially time consuming operations <code>warning</code> <code>bold yellow</code> -1 Messages conveying important information <p>See the documentation and color reference for guidance on valid values.</p>"},{"location":"config/hatch/#spinner","title":"Spinner","text":"<p>You can select the sequence used for waiting animations with the <code>spinner</code> option.</p>  config.toml <pre><code>[terminal.styles]\nspinner = \"...\"\n</code></pre>"},{"location":"config/metadata/","title":"Configuring project metadata","text":"<p>Project metadata is stored in a <code>pyproject.toml</code> file located at the root of a project's tree and is based entirely on the standard.</p>"},{"location":"config/metadata/#name","title":"Name (required)","text":"<p>The name of the project.</p>  pyproject.toml <pre><code>[project]\nname = \"your-app\"\n</code></pre>"},{"location":"config/metadata/#version","title":"Version (required)","text":"pyproject.toml DynamicStatic <p>See the dedicated versioning section.</p> <pre><code>[project]\n...\ndynamic = [\"version\"]\n\n[tool.hatch.version]\npath = \"...\"\n</code></pre> <pre><code>[project]\n...\nversion = \"0.0.1\"\n</code></pre>"},{"location":"config/metadata/#description","title":"Description","text":"<p>A brief summary of the project.</p>  pyproject.toml <pre><code>[project]\n...\ndescription = '...'\n</code></pre>"},{"location":"config/metadata/#readme","title":"Readme","text":"<p>The full description of the project.</p>  pyproject.toml SimpleComplex <p>The file extension must be <code>.md</code>, <code>.rst</code>, or <code>.txt</code>.</p> <pre><code>[project]\n...\nreadme = \"README.md\"\n</code></pre> <p>The <code>content-type</code> field must be set to <code>text/markdown</code>, <code>text/x-rst</code>, or <code>text/plain</code>.</p> FileText <p>A <code>charset</code> field may also be set to instruct which encoding to use for reading the file, defaulting to <code>utf-8</code>.</p> <pre><code>[project]\n...\nreadme = {\"file\" = \"README.md\", \"content-type\" = \"text/markdown\"}\n</code></pre> <p>The <code>content-type</code> field must be set to <code>text/markdown</code> or <code>text/x-rst</code>.</p> <pre><code>[project]\n...\nreadme = {\"text\" = \"...\", \"content-type\" = \"text/markdown\"}\n</code></pre> <p>Note</p> <p>If this is defined as a file, then it will always be included in source distributions for consistent builds.</p>"},{"location":"config/metadata/#python-support","title":"Python support","text":"<p>The Python version requirements of the project.</p>  pyproject.toml <pre><code>[project]\n...\nrequires-python = \"&gt;=3.8\"\n</code></pre>"},{"location":"config/metadata/#license","title":"License","text":"<p>For more information, see PEP 639.</p>  pyproject.toml SPDX expressionFiles <pre><code>[project]\n...\nlicense = \"Apache-2.0 OR MIT\"\n</code></pre> PathsGlobs <pre><code>[project]\n...\nlicense-files = { paths = [\"LICENSE.txt\"] }\n</code></pre> <pre><code>[project]\n...\nlicense-files = { globs = [\"LICENSES/*\"] }\n</code></pre>"},{"location":"config/metadata/#ownership","title":"Ownership","text":"<p>The people or organizations considered to be the <code>authors</code> or <code>maintainers</code> of the project. The exact meaning is open to interpretation; it may list the original or primary authors, current maintainers, or owners of the package. If the values are the same, prefer only the use of the <code>authors</code> field.</p>  pyproject.toml <pre><code>[project]\n...\nauthors = [\n  { name = \"...\", email = \"...\" },\n]\nmaintainers = [\n  { name = \"...\", email = \"...\" },\n]\n</code></pre>"},{"location":"config/metadata/#keywords","title":"Keywords","text":"<p>The keywords used to assist in the discovery of the project.</p>  pyproject.toml <pre><code>[project]\n...\nkeywords = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#classifiers","title":"Classifiers","text":"<p>The trove classifiers that apply to the project.</p>  pyproject.toml <pre><code>[project]\n...\nclassifiers = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#urls","title":"URLs","text":"<p>A table of URLs where the key is the URL label and the value is the URL itself.</p>  pyproject.toml <pre><code>[project.urls]\nDocumentation = \"...\"\n\"Source code\" = \"...\"\n</code></pre>"},{"location":"config/metadata/#dependencies","title":"Dependencies","text":"<p>See the dependency specification page for more information.</p> <p>Entries support context formatting and disallow direct references by default.</p>"},{"location":"config/metadata/#required","title":"Required","text":"pyproject.toml <pre><code>[project]\n...\ndependencies = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#optional","title":"Optional","text":"pyproject.toml <pre><code>[project.optional-dependencies]\noption1 = [\n  \"...\",\n]\noption2 = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#entry-points","title":"Entry points","text":"<p>Entry points are a mechanism for the project to advertise components it provides to be discovered and used by other code.</p>"},{"location":"config/metadata/#cli","title":"CLI","text":"<p>After installing projects that define CLI scripts, each key will be available along your <code>PATH</code> as a command that will call its associated object.</p>  pyproject.toml <pre><code>[project.scripts]\ncli-name = \"pkg.subpkg:func\"\n</code></pre> <p>Using the above example, running <code>cli-name</code> would essentially execute the following Python script:</p> <pre><code>import sys\n\nfrom pkg.subpkg import func\n\nsys.exit(func())\n</code></pre>"},{"location":"config/metadata/#gui","title":"GUI","text":"<p>GUI scripts are exactly the same as CLI scripts except on Windows, where they are handled specially so that they can be started without a console.</p>  pyproject.toml <pre><code>[project.gui-scripts]\ngui-name = \"pkg.subpkg:func\"\n</code></pre>"},{"location":"config/metadata/#plugins","title":"Plugins","text":"pyproject.toml <pre><code>[project.entry-points.plugin-namespace]\nplugin-name1 = \"pkg.subpkg1\"\nplugin-name2 = \"pkg.subpkg2:func\"\n</code></pre>"},{"location":"config/metadata/#dynamic","title":"Dynamic","text":"<p>If any metadata fields are set dynamically, like the <code>version</code> may be, then they must be listed here.</p>  pyproject.toml <pre><code>[project]\n...\ndynamic = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#metadata-options","title":"Metadata options","text":""},{"location":"config/metadata/#allowing-direct-references","title":"Allowing direct references","text":"<p>By default, dependencies are not allowed to define direct references. To disable this check, set <code>allow-direct-references</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata]\nallow-direct-references = true\n</code></pre> <pre><code>[metadata]\nallow-direct-references = true\n</code></pre>"},{"location":"config/metadata/#allowing-ambiguous-features","title":"Allowing ambiguous features","text":"<p>By default, names of optional dependencies are normalized to prevent ambiguity. To disable this normalization, set <code>allow-ambiguous-features</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata]\nallow-ambiguous-features = true\n</code></pre> <pre><code>[metadata]\nallow-ambiguous-features = true\n</code></pre> <p>Deprecated</p> <p>This option temporarily exists to provide better interoperability with tools that do not yet support PEP 685 and will be removed in the first minor release after Jan 1, 2024.</p>"},{"location":"config/project-templates/","title":"Project templates","text":"<p>You can control how new projects are created by the new command using Hatch's config file.</p>"},{"location":"config/project-templates/#author","title":"Author","text":"config.toml <pre><code>[template]\nname = \"...\"\nemail = \"...\"\n</code></pre>"},{"location":"config/project-templates/#licenses","title":"Licenses","text":"config.toml <pre><code>[template.licenses]\nheaders = true\ndefault = [\n  \"MIT\",\n]\n</code></pre> <p>The list of licenses should be composed of SPDX identifiers. If multiple licenses are specified, then they will be placed in a LICENSES directory.</p>"},{"location":"config/project-templates/#options","title":"Options","text":""},{"location":"config/project-templates/#tests","title":"Tests","text":"<p>This adds a <code>tests</code> directory with environments for testing and linting.</p>  config.toml <pre><code>[template.plugins.default]\ntests = true\n</code></pre>"},{"location":"config/project-templates/#ci","title":"CI","text":"<p>This adds a GitHub Actions workflow that runs tests on all platforms using modern versions of Python.</p>  config.toml <pre><code>[template.plugins.default]\nci = false\n</code></pre>"},{"location":"config/project-templates/#src-layout","title":"<code>src</code> layout","text":"<p>See this blog post.</p>  config.toml <pre><code>[template.plugins.default]\nsrc-layout = true\n</code></pre>"},{"location":"config/project-templates/#feature-flags","title":"Feature flags","text":""},{"location":"config/project-templates/#command-line-interface","title":"Command line interface","text":"<p>The <code>--cli</code> flag adds a CLI backed by Click that can also be invoked with <code>python -m &lt;PKG_NAME&gt;</code>.</p>"},{"location":"config/environment/advanced/","title":"Advanced environment configuration","text":""},{"location":"config/environment/advanced/#context-formatting","title":"Context formatting","text":"<p>All environments support the following extra context formatting fields:</p> Field Description <code>env_name</code> The name of the environment <code>env_type</code> The type of environment <code>matrix</code> Its modifier selects the value of that matrix variable. If the environment is not part of a matrix or was not generated with the variable, you must specify a default value as an additional modifier e.g. <code>{matrix:version:v1.0.0}</code>. <code>verbosity</code> The integer verbosity value of Hatch. A <code>flag</code> modifier is supported that will render the value as a CLI flag e.g. <code>-2</code> becomes <code>-qq</code>, <code>1</code> becomes <code>-v</code>, and <code>0</code> becomes an empty string. An additional flag integer modifier may be used to adjust the verbosity level. For example, if you wanted to make a command quiet by default, you could use <code>{verbosity:flag:-1}</code> within the command. <code>args</code> For executed commands only, any extra command line arguments with an optional default modifier if none were provided"},{"location":"config/environment/advanced/#matrix","title":"Matrix","text":"<p>Environments can define a series of matrices with the <code>matrix</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>Doing so will result in the product of each variable combination being its own environment.</p>"},{"location":"config/environment/advanced/#naming","title":"Naming","text":"<p>The name of the generated environments will be the variable values of each combination separated by hyphens, altogether prefixed by <code>&lt;ENV_NAME&gt;.</code>. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>would indicate the following unique environments:</p> <pre><code>test.42-foo\ntest.42-bar\n</code></pre> <p>The exceptions to this format are described below.</p>"},{"location":"config/environment/advanced/#python-variables","title":"Python variables","text":"<p>If the variables <code>py</code> or <code>python</code> are specified, then they will rank first in the product result and will be prefixed by <code>py</code> if the value is not. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\nversion = [\"42\"]\npython = [\"3.9\", \"pypy3\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\nversion = [\"42\"]\npython = [\"3.9\", \"pypy3\"]\n</code></pre> <p>would generate the following environments:</p> <pre><code>test.py3.9-42\ntest.pypy3-42\n</code></pre> <p>Note</p> <p>The value of this variable sets the Python version.</p>"},{"location":"config/environment/advanced/#name-formatting","title":"Name formatting","text":"<p>You can set the <code>matrix-name-format</code> option to modify how each variable part is formatted which recognizes the placeholders <code>{variable}</code> and <code>{value}</code>. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\nmatrix-name-format = \"{variable}_{value}\"\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.test]\nmatrix-name-format = \"{variable}_{value}\"\n\n[[envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>would produce the following environments:</p> <pre><code>test.version_42-feature_foo\ntest.version_42-feature_bar\n</code></pre> <p>By default this option is set to <code>{value}</code>.</p>"},{"location":"config/environment/advanced/#default-environment","title":"Default environment","text":"<p>If the <code>default</code> environment defines matrices, then the generated names will not be prefixed by the environment name. This can be useful for projects that only need a single series of matrices without any standalone environments.</p>"},{"location":"config/environment/advanced/#selection","title":"Selection","text":"<p>Rather than selecting a single generated environment, you can select the root environment to target all of them. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[tool.hatch.envs.test.scripts]\ncov = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[envs.test.scripts]\ncov = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n</code></pre> <p>you could then run your tests consecutively in all 4 environments with:</p> <pre><code>hatch run test:cov\n</code></pre>"},{"location":"config/environment/advanced/#option-overrides","title":"Option overrides","text":"<p>You can modify options based on the conditions of different sources like matrix variables with the <code>overrides</code> table, using dotted key syntax for each declaration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;.overrides]\n&lt;SOURCE&gt;.&lt;CONDITION&gt;.&lt;OPTION&gt; = &lt;VALUE&gt;\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;.overrides]\n&lt;SOURCE&gt;.&lt;CONDITION&gt;.&lt;OPTION&gt; = &lt;VALUE&gt;\n</code></pre> <p>The type of the selected option determines the types of values.</p>"},{"location":"config/environment/advanced/#platform-overrides","title":"Platform overrides","text":"<p>Options can be modified based on the current platform using the <code>platform</code> source.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nplatform.windows.scripts = [\n  'run=pytest -m \"not io_uring\"',\n]\n</code></pre> <pre><code>[envs.test.overrides]\nplatform.windows.scripts = [\n  'run=pytest -m \"not io_uring\"',\n]\n</code></pre> <p>The following platforms are supported:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul>"},{"location":"config/environment/advanced/#environment-variable-overrides","title":"Environment variable overrides","text":"<p>Environment variables can modify options using the <code>env</code> source.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nenv.GITHUB_ACTIONS.dev-mode = { value = false, if = [\"true\"] }\n</code></pre> <pre><code>[envs.test.overrides]\nenv.GITHUB_ACTIONS.dev-mode = { value = false, if = [\"true\"] }\n</code></pre>"},{"location":"config/environment/advanced/#matrix-variable-overrides","title":"Matrix variable overrides","text":"<p>The matrix variables used to generate each environment can be used to modify options within using the <code>matrix</code> source.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.auth.features = [\n  { value = \"oauth\", if = [\"oauth2\"] },\n  { value = \"kerberos\", if = [\"kerberos\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"legacy\", \"latest\"]\nauth = [\"oauth2\", \"kerberos\", \"noauth\"]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.auth.features = [\n  { value = \"oauth\", if = [\"oauth2\"] },\n  { value = \"kerberos\", if = [\"kerberos\"] },\n]\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"legacy\", \"latest\"]\nauth = [\"oauth2\", \"kerberos\", \"noauth\"]\n</code></pre>"},{"location":"config/environment/advanced/#name-overrides","title":"Name overrides","text":"<p>When a matrix is defined, the <code>name</code> source can be used for regular expression matching on the generated name, minus the prefix for non-default environments.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nname.\"^0\".env-vars = \"TESTING_UNSTABLE=true\"\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"0.1.0\", \"0.2.0\", \"1.0.0\"]\n</code></pre> <pre><code>[envs.test.overrides]\nname.\"^0\".env-vars = \"TESTING_UNSTABLE=true\"\n\n[[envs.test.matrix]]\nversion = [\"0.1.0\", \"0.2.0\", \"1.0.0\"]\n</code></pre>"},{"location":"config/environment/advanced/#types","title":"Types","text":"<ul> <li> <p>Literal types like strings for the Python version or booleans for skipping installation can be set using the value itself, an inline table, or an array. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.python = \"3.10\"\nmatrix.bar.skip-install = { value = true, if = [\"...\"] }\nenv.CI.dev-mode = [\n  { value = false, if = [\"...\"] },\n  true,\n]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.python = \"3.10\"\nmatrix.bar.skip-install = { value = true, if = [\"...\"] }\nenv.CI.dev-mode = [\n  { value = false, if = [\"...\"] },\n  true,\n]\n</code></pre> <p>For arrays, the first allowed value will be used.</p> </li> <li> <p>Array types like dependencies or commands can be appended to using an array of strings or inline tables. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.dependencies = [\n  \"httpx\",\n  { value = \"cryptography\" },\n]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.dependencies = [\n  \"httpx\",\n  { value = \"cryptography\" },\n]\n</code></pre> </li> <li> <p>Mapping types like environment variables or scripts can have keys set using a string, or an array of strings or inline tables. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.env-vars = \"KEY=VALUE\"\nmatrix.bar.env-vars = [\n  \"KEY1=VALUE1\",\n  { key = \"KEY2\", value = \"VALUE2\" },\n]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.env-vars = \"KEY=VALUE\"\nmatrix.bar.env-vars = [\n  \"KEY1=VALUE1\",\n  { key = \"KEY2\", value = \"VALUE2\" },\n]\n</code></pre> <p>If the value is missing (no <code>=</code> for strings, no <code>value</code> key for inline tables), then the value will be set to the value of the source condition.</p> </li> </ul>"},{"location":"config/environment/advanced/#overwriting","title":"Overwriting","text":"<p>Rather than supplementing the values within mapping types or array types, you can overwrite the option as a whole by prefixing the name with <code>set-</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.set-platforms = [\"macos\", \"linux\"]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.set-platforms = [\"macos\", \"linux\"]\n</code></pre> <p>When overwriting entire options or keys within mappings, override sources are applied in the following order:</p> <ol> <li>platform</li> <li>environment variables</li> <li>matrix variables</li> <li>names</li> </ol>"},{"location":"config/environment/advanced/#conditions","title":"Conditions","text":"<p>You may specify certain extra keys for any inline table that will determine whether or not to apply that entry. These modifiers may be combined with others and any negative evaluation will immediately cause the entry to be skipped.</p>"},{"location":"config/environment/advanced/#allowed-values","title":"Allowed values","text":"<p>The <code>if</code> key represents the allowed values for that condition. If the value of the condition is not listed, then that entry will not be applied:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.version.python = { value = \"pypy\", if = [\"3.14\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.version.python = { value = \"pypy\", if = [\"3.14\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre>"},{"location":"config/environment/advanced/#specific-platforms","title":"Specific platforms","text":"<p>The <code>platform</code> key represents the desired platforms. If the current platform is not listed, then that entry will not be applied:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nenv.EXPERIMENTAL.python = { value = \"pypy\", if = [\"1\"], platform = [\"macos\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], platform = [\"linux\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test.overrides]\nenv.EXPERIMENTAL.python = { value = \"pypy\", if = [\"1\"], platform = [\"macos\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], platform = [\"linux\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre>"},{"location":"config/environment/advanced/#required-environment-variables","title":"Required environment variables","text":"<p>The <code>env</code> key represents the required environment variables. If any of the listed environment variables are not set or the defined value does not match, then that entry will not be applied:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nplatform.windows.python = { value = \"pypy\", env = [\"EXPERIMENTAL\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], env = [\"FOO\", \"BAR=BAZ\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test.overrides]\nplatform.windows.python = { value = \"pypy\", env = [\"EXPERIMENTAL\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], env = [\"FOO\", \"BAR=BAZ\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre>"},{"location":"config/environment/overview/","title":"Environment configuration","text":"<p>All environments are defined as sections within the <code>tool.hatch.envs</code> table.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\n</code></pre> <p>The storage location for environments is completely configurable.</p> <p>Unless an environment is explicitly selected on the command line, the <code>default</code> environment will be used. The type of this environment defaults to <code>virtual</code>.</p> <p>Info</p> <p>Environments prefixed by <code>hatch-</code> are used for special purposes e.g. testing.</p>"},{"location":"config/environment/overview/#inheritance","title":"Inheritance","text":"<p>All environments inherit from the environment defined by its <code>template</code> option, which defaults to <code>default</code>.</p> <p>So for the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.foo]\ntype = \"baz\"\nskip-install = true\n\n[tool.hatch.envs.bar]\ntemplate = \"foo\"\nskip-install = false\n</code></pre> <pre><code>[envs.foo]\ntype = \"baz\"\nskip-install = true\n\n[envs.bar]\ntemplate = \"foo\"\nskip-install = false\n</code></pre> <p>the environment <code>bar</code> will be of type <code>baz</code> with <code>skip-install</code> set to <code>false</code>.</p> <p>Note</p> <p>Environments do not inherit matrices.</p>"},{"location":"config/environment/overview/#self-referential-environments","title":"Self-referential environments","text":"<p>You can disable inheritance by setting <code>template</code> to the environment's own name:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.foo]\ntemplate = \"foo\"\n</code></pre> <pre><code>[envs.foo]\ntemplate = \"foo\"\n</code></pre>"},{"location":"config/environment/overview/#detached-environments","title":"Detached environments","text":"<p>A common use case is standalone environments that do not require inheritance nor the installation of the project, such as for linting or sometimes building documentation. Enabling the <code>detached</code> option will make the environment self-referential and will skip project installation:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.lint]\ndetached = true\n</code></pre> <pre><code>[envs.lint]\ndetached = true\n</code></pre>"},{"location":"config/environment/overview/#dependencies","title":"Dependencies","text":"<p>You can install dependencies in addition to the ones defined by your project's metadata. Entries support context formatting.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n</code></pre> <p>If you define environments with dependencies that only slightly differ from their inherited environments, you can use the <code>extra-dependencies</code> option to avoid redeclaring the <code>dependencies</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"foo\",\n  \"bar\",\n]\n\n[tool.hatch.envs.experimental]\nextra-dependencies = [\n  \"baz\",\n]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"foo\",\n  \"bar\",\n]\n\n[envs.experimental]\nextra-dependencies = [\n  \"baz\",\n]\n</code></pre> <p>Tip</p> <p>Hatch uses pip to install dependencies so any configuration it supports Hatch does as well. For example, if you wanted to only use a private repository you could set the <code>PIP_INDEX_URL</code> environment variable.</p>"},{"location":"config/environment/overview/#installation","title":"Installation","text":""},{"location":"config/environment/overview/#features","title":"Features (extras)","text":"<p>If your project defines optional dependencies, you can select which groups to install using the <code>features</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.nightly]\nfeatures = [\n  \"server\",\n  \"grpc\",\n]\n</code></pre> <pre><code>[envs.nightly]\nfeatures = [\n  \"server\",\n  \"grpc\",\n]\n</code></pre> <p>Note</p> <p>Features/optional dependencies are also known as <code>extras</code> in other tools.</p>"},{"location":"config/environment/overview/#dev-mode","title":"Dev mode","text":"<p>By default, environments will always reflect the current state of your project on disk. Set <code>dev-mode</code> to <code>false</code> to disable this behavior:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.static]\ndev-mode = false\n</code></pre> <pre><code>[envs.static]\ndev-mode = false\n</code></pre>"},{"location":"config/environment/overview/#skip-install","title":"Skip install","text":"<p>By default, environments will install your project during creation. To ignore this step, set <code>skip-install</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.lint]\nskip-install = true\n</code></pre> <pre><code>[envs.lint]\nskip-install = true\n</code></pre>"},{"location":"config/environment/overview/#environment-variables","title":"Environment variables","text":""},{"location":"config/environment/overview/#defined","title":"Defined","text":"<p>You can define environment variables with the <code>env-vars</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[tool.hatch.envs.docs.env-vars]\nSOURCE_DATE_EPOCH = \"1580601600\"\n</code></pre> <pre><code>[envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[envs.docs.env-vars]\nSOURCE_DATE_EPOCH = \"1580601600\"\n</code></pre> <p>Values support context formatting.</p>"},{"location":"config/environment/overview/#filters","title":"Filters","text":"<p>By default, environments will have access to all environment variables. You can filter with wildcard patterns using the <code>env-include</code>/<code>env-exclude</code> options:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nenv-include = [\n  \"FOO*\",\n]\nenv-exclude = [\n  \"BAR\",\n]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nenv-include = [\n  \"FOO*\",\n]\nenv-exclude = [\n  \"BAR\",\n]\n</code></pre> <p>Exclusion patterns take precedence but will never affect defined environment variables.</p>"},{"location":"config/environment/overview/#scripts","title":"Scripts","text":"<p>You can define named scripts that may be executed or referenced at the beginning of other scripts. Context formatting is supported.</p> <p>For example, in the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n[tool.hatch.envs.test.scripts]\nrun-coverage = \"pytest --cov-config=pyproject.toml --cov=pkg --cov=tests\"\nrun = \"run-coverage --no-cov\"\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n[envs.test.scripts]\nrun-coverage = \"pytest --cov-config=pyproject.toml --cov=pkg --cov=tests\"\nrun = \"run-coverage --no-cov\"\n</code></pre> <p>the <code>run</code> script would be expanded to:</p> <pre><code>pytest --cov-config=pyproject.toml --cov=pkg --cov=tests --no-cov\n</code></pre> <p>Scripts can also be defined as an array of strings.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.style]\ndetached = true\ndependencies = [\n  \"flake8\",\n  \"black\",\n  \"isort\",\n]\n[tool.hatch.envs.style.scripts]\ncheck = [\n  \"flake8 .\",\n  \"black --check --diff .\",\n  \"isort --check-only --diff .\",\n]\nfmt = [\n  \"isort .\",\n  \"black .\",\n  \"check\",\n]\n</code></pre> <pre><code>[envs.style]\ndetached = true\ndependencies = [\n  \"flake8\",\n  \"black\",\n  \"isort\",\n]\n[envs.style.scripts]\ncheck = [\n  \"flake8 .\",\n  \"black --check --diff .\",\n  \"isort --check-only --diff .\",\n]\nfmt = [\n  \"isort .\",\n  \"black .\",\n  \"check\",\n]\n</code></pre> <p>Similar to make, you can ignore the exit code of commands that start with <code>-</code> (a hyphen). For example, the script <code>error</code> defined by the following configuration would halt after the second command with <code>3</code> as the exit code:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.scripts]\nerror = [\n  \"- exit 1\",\n  \"exit 3\",\n  \"exit 0\",\n]\n</code></pre> <pre><code>[envs.test.scripts]\nerror = [\n  \"- exit 1\",\n  \"exit 3\",\n  \"exit 0\",\n]\n</code></pre> <p>Tip</p> <p>Individual scripts inherit from parent environments just like options.</p>"},{"location":"config/environment/overview/#commands","title":"Commands","text":"<p>All commands are able to use any defined scripts. Also like scripts, context formatting is supported and the exit code of commands that start with a hyphen will be ignored.</p>"},{"location":"config/environment/overview/#pre-install","title":"Pre-install","text":"<p>You can run commands immediately before environments install your project.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\npre-install-commands = [\n  \"...\",\n]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\npre-install-commands = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/environment/overview/#post-install","title":"Post-install","text":"<p>You can run commands immediately after environments install your project.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\npost-install-commands = [\n  \"...\",\n]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\npost-install-commands = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/environment/overview/#python-version","title":"Python version","text":"<p>The <code>python</code> option specifies which version of Python to use, or an absolute path to a Python interpreter:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\npython = \"3.10\"\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\npython = \"3.10\"\n</code></pre> <p>All environment types should respect this option.</p>"},{"location":"config/environment/overview/#supported-platforms","title":"Supported platforms","text":"<p>The <code>platforms</code> option indicates the operating systems with which the environment is compatible:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nplatforms = [\"linux\", \"windows\", \"macos\"]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nplatforms = [\"linux\", \"windows\", \"macos\"]\n</code></pre> <p>The following platforms are supported:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul> <p>If unspecified, the environment is assumed to be compatible with all platforms.</p>"},{"location":"config/environment/overview/#description","title":"Description","text":"<p>The <code>description</code> option is purely informational and is displayed in the output of the <code>env show</code> command:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ndescription = \"\"\"\nLorem ipsum ...\n\"\"\"\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ndescription = \"\"\"\nLorem ipsum ...\n\"\"\"\n</code></pre>"},{"location":"config/environment/overview/#type","title":"Type","text":"<p>An environment's <code>type</code> determines which environment plugin will be used for management. The only built-in environment type is <code>virtual</code>, which uses virtual Python environments.</p>"},{"location":"config/internal/static-analysis/","title":"Static analysis configuration","text":"<p>Static analysis performed by the <code>fmt</code> command is (by default) backed entirely by Ruff.</p> <p>Hatch provides default settings that user configuration can extend.</p>"},{"location":"config/internal/static-analysis/#extending-config","title":"Extending config","text":"<p>When defining your configuration, be sure to use options that are prefixed by <code>extend-</code> such as <code>extend-select</code>, for example:</p>  pyproject.toml ruff.toml <pre><code>[tool.ruff.format]\npreview = true\nquote-style = \"single\"\n\n[tool.ruff.lint]\npreview = true\nextend-select = [\"C901\"]\n\n[tool.ruff.lint.extend-per-file-ignores]\n\"docs/.hooks/*\" = [\"INP001\", \"T201\"]\n\n[tool.ruff.lint.isort]\nknown-first-party = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[format]\npreview = true\nquote-style = \"single\"\n\n[lint]\npreview = true\nextend-select = [\"C901\"]\n\n[lint.extend-per-file-ignores]\n\"docs/.hooks/*\" = [\"INP001\", \"T201\"]\n\n[lint.isort]\nknown-first-party = [\"foo\", \"bar\"]\n</code></pre> <p>Note</p> <p>When not persisting config, there is no need to explicitly extend the defaults as Hatch automatically handles that.</p>"},{"location":"config/internal/static-analysis/#persistent-config","title":"Persistent config","text":"<p>If you want to store the default configuration in the project, set an explicit path like so:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\nconfig-path = \"ruff_defaults.toml\"\n</code></pre> <pre><code>[envs.hatch-static-analysis]\nconfig-path = \"ruff_defaults.toml\"\n</code></pre> <p>Then instruct Ruff to consider your configuration as an extension of the default file:</p>  pyproject.toml ruff.toml <pre><code>[tool.ruff]\nextend = \"ruff_defaults.toml\"\n</code></pre> <pre><code>extend = \"ruff_defaults.toml\"\n</code></pre> <p>Anytime you wish to update the defaults (such as when upgrading Hatch), you must run the <code>fmt</code> command once with the <code>--sync</code> flag e.g.:</p> <pre><code>hatch fmt --check --sync\n</code></pre> <p>Tip</p> <p>This is the recommended approach since it allows other tools like IDEs to use the default configuration.</p>"},{"location":"config/internal/static-analysis/#no-config","title":"No config","text":"<p>If you don't want Hatch to use any of its default configuration and rely entirely on yours, set the path to anything and then simply don't <code>extend</code> in your Ruff config:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\nconfig-path = \"none\"\n</code></pre> <pre><code>[envs.hatch-static-analysis]\nconfig-path = \"none\"\n</code></pre>"},{"location":"config/internal/static-analysis/#customize-behavior","title":"Customize behavior","text":"<p>You can fully alter the behavior of the environment used by the <code>fmt</code> command. See the how-to for a detailed example.</p>"},{"location":"config/internal/static-analysis/#dependencies","title":"Dependencies","text":"<p>Pin the particular version of Ruff by explicitly defining the environment dependencies:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre> <pre><code>[envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre>"},{"location":"config/internal/static-analysis/#scripts","title":"Scripts","text":"<p>If you want to change the default commands that are executed, you can override the scripts. The following four scripts must be defined:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis.scripts]\nformat-check = \"...\"\nformat-fix = \"...\"\nlint-check = \"...\"\nlint-fix = \"...\"\n</code></pre> <pre><code>[envs.hatch-static-analysis.scripts]\nformat-check = \"...\"\nformat-fix = \"...\"\nlint-check = \"...\"\nlint-fix = \"...\"\n</code></pre> <p>The <code>format-*</code> scripts correspond to the <code>--formatter</code>/<code>-f</code> flag while the <code>lint-*</code> scripts correspond to the <code>--linter</code>/<code>-l</code> flag. The <code>*-fix</code> scripts run by default while the <code>*-check</code> scripts correspond to the <code>--check</code> flag.</p> <p>Reminder</p> <p>If you choose to use different tools for static analysis, be sure to update the required dependencies.</p>"},{"location":"config/internal/static-analysis/#default-settings","title":"Default settings","text":""},{"location":"config/internal/static-analysis/#non-rule-settings","title":"Non-rule settings","text":"<ul> <li>Line length set to 120</li> <li>Docstring formatting enabled with line length set to 80</li> <li>Only absolute imports are allowed, except for tests</li> <li>The normalized project name is a known first party import</li> </ul>"},{"location":"config/internal/static-analysis/#per-file-ignored-rules","title":"Per-file ignored rules","text":"<ul> <li><code>**/scripts/*</code>: INP001, T201</li> <li><code>**/tests/**/*</code>: PLC1901, PLR2004, PLR6301, S, TID252</li> </ul>"},{"location":"config/internal/static-analysis/#selected-rules","title":"Selected rules","text":"<p>The following rules are based on version 0.3.1 of Ruff. Rules with a <sup>P</sup> are only selected when preview mode is enabled.</p> <ul> <li>A001, A002, A003</li> <li>ARG001, ARG002, ARG003, ARG004, ARG005</li> <li>ASYNC100, ASYNC101, ASYNC102</li> <li>B002, B003, B004, B005, B006, B007, B008, B009, B010, B011, B012, B013, B014, B015, B016, B017, B018, B019, B020, B021, B022, B023, B024, B025, B026, B028, B029, B030, B031, B032, B033, B034, B035, B904, B905</li> <li>BLE001</li> <li>C400, C401, C402, C403, C404, C405, C406, C408, C409, C410, C411, C413, C414, C415, C416, C417, C418, C419</li> <li>COM818</li> <li>DTZ001, DTZ002, DTZ003, DTZ004, DTZ005, DTZ006, DTZ007, DTZ011, DTZ012</li> <li>E101, E112<sup>P</sup>, E113<sup>P</sup>, E115<sup>P</sup>, E116<sup>P</sup>, E201<sup>P</sup>, E202<sup>P</sup>, E203<sup>P</sup>, E211<sup>P</sup>, E221<sup>P</sup>, E222<sup>P</sup>, E223<sup>P</sup>, E224<sup>P</sup>, E225<sup>P</sup>, E226<sup>P</sup>, E227<sup>P</sup>, E228<sup>P</sup>, E231<sup>P</sup>, E241<sup>P</sup>, E242<sup>P</sup>, E251<sup>P</sup>, E252<sup>P</sup>, E261<sup>P</sup>, E262<sup>P</sup>, E265<sup>P</sup>, E266<sup>P</sup>, E271<sup>P</sup>, E272<sup>P</sup>, E273<sup>P</sup>, E274<sup>P</sup>, E275<sup>P</sup>, E401, E402, E501, E701, E702, E703, E711, E712, E713, E714, E721, E722, E731, E741, E742, E743, E902, E999</li> <li>EM101, EM102, EM103</li> <li>EXE001, EXE002, EXE003, EXE004, EXE005</li> <li>F401, F402, F403, F404, F405, F406, F407, F501, F502, F503, F504, F505, F506, F507, F508, F509, F521, F522, F523, F524, F525, F541, F601, F602, F621, F622, F631, F632, F633, F634, F701, F702, F704, F706, F707, F722, F811, F821, F822, F823, F841, F842, F901</li> <li>FA100, FA102</li> <li>FBT001, FBT002</li> <li>FLY002</li> <li>FURB105<sup>P</sup>, FURB113<sup>P</sup>, FURB118<sup>P</sup>, FURB129<sup>P</sup>, FURB131<sup>P</sup>, FURB132<sup>P</sup>, FURB136<sup>P</sup>, FURB145<sup>P</sup>, FURB148<sup>P</sup>, FURB152<sup>P</sup>, FURB161<sup>P</sup>, FURB163<sup>P</sup>, FURB167<sup>P</sup>, FURB168<sup>P</sup>, FURB169<sup>P</sup>, FURB171<sup>P</sup>, FURB177<sup>P</sup>, FURB180<sup>P</sup>, FURB181<sup>P</sup></li> <li>G001, G002, G003, G004, G010, G101, G201, G202</li> <li>I001, I002</li> <li>ICN001, ICN002, ICN003</li> <li>INP001</li> <li>INT001, INT002, INT003</li> <li>ISC003</li> <li>LOG001, LOG002, LOG007, LOG009</li> <li>N801, N802, N803, N804, N805, N806, N807, N811, N812, N813, N814, N815, N816, N817, N818, N999</li> <li>PERF101, PERF102, PERF401, PERF402, PERF403<sup>P</sup></li> <li>PGH005</li> <li>PIE790, PIE794, PIE796, PIE800, PIE804, PIE807, PIE808, PIE810</li> <li>PLC0105, PLC0131, PLC0132, PLC0205, PLC0208, PLC0414, PLC0415<sup>P</sup>, PLC1901<sup>P</sup>, PLC2401<sup>P</sup>, PLC2403<sup>P</sup>, PLC2701<sup>P</sup>, PLC2801<sup>P</sup>, PLC3002</li> <li>PLE0100, PLE0101, PLE0116, PLE0117, PLE0118, PLE0237, PLE0241, PLE0302, PLE0307, PLE0604, PLE0605, PLE0643<sup>P</sup>, PLE0704<sup>P</sup>, PLE1132<sup>P</sup>, PLE1141<sup>P</sup>, PLE1142, PLE1205, PLE1206, PLE1300, PLE1307, PLE1310, PLE1507, PLE1519<sup>P</sup>, PLE1700, PLE2502, PLE2510, PLE2512, PLE2513, PLE2514, PLE2515</li> <li>PLR0124, PLR0133, PLR0202<sup>P</sup>, PLR0203<sup>P</sup>, PLR0206, PLR0402, PLR1701, PLR1704<sup>P</sup>, PLR1711, PLR1714, PLR1722, PLR1733<sup>P</sup>, PLR1736<sup>P</sup>, PLR2004, PLR2044<sup>P</sup>, PLR5501, PLR6201<sup>P</sup>, PLR6301<sup>P</sup></li> <li>PLW0108<sup>P</sup>, PLW0120, PLW0127, PLW0129, PLW0131, PLW0133<sup>P</sup>, PLW0245<sup>P</sup>, PLW0406, PLW0602, PLW0603, PLW0604<sup>P</sup>, PLW0711, PLW1501<sup>P</sup>, PLW1508, PLW1509, PLW1510, PLW1514<sup>P</sup>, PLW1641<sup>P</sup>, PLW2101<sup>P</sup>, PLW2901, PLW3201<sup>P</sup>, PLW3301</li> <li>PT001, PT002, PT003, PT006, PT007, PT008, PT009, PT010, PT011, PT012, PT013, PT014, PT015, PT016, PT017, PT018, PT019, PT020, PT021, PT022, PT023, PT024, PT025, PT026, PT027</li> <li>PYI001, PYI002, PYI003, PYI004, PYI005, PYI006, PYI007, PYI008, PYI009, PYI010, PYI011, PYI012, PYI013, PYI014, PYI015, PYI016, PYI017, PYI018, PYI019, PYI020, PYI021, PYI024, PYI025, PYI026, PYI029, PYI030, PYI032, PYI033, PYI034, PYI035, PYI036, PYI041, PYI042, PYI043, PYI044, PYI045, PYI046, PYI047, PYI048, PYI049, PYI050, PYI051, PYI052, PYI053, PYI054, PYI055, PYI056, PYI058</li> <li>RET503, RET504, RET505, RET506, RET507, RET508</li> <li>RSE102</li> <li>RUF001, RUF002, RUF003, RUF005, RUF006, RUF007, RUF008, RUF009, RUF010, RUF012, RUF013, RUF015, RUF016, RUF017, RUF018, RUF019, RUF020, RUF021<sup>P</sup>, RUF022<sup>P</sup>, RUF023<sup>P</sup>, RUF024<sup>P</sup>, RUF025<sup>P</sup>, RUF026<sup>P</sup>, RUF027<sup>P</sup>, RUF028<sup>P</sup>, RUF100, RUF200</li> <li>S101, S102, S103, S104, S105, S106, S107, S108, S110, S112, S113, S201, S202, S301, S302, S303, S304, S305, S306, S307, S308, S310, S311, S312, S313, S314, S315, S316, S317, S318, S319, S320, S321, S323, S324, S401<sup>P</sup>, S402<sup>P</sup>, S403<sup>P</sup>, S405<sup>P</sup>, S406<sup>P</sup>, S407<sup>P</sup>, S408<sup>P</sup>, S409<sup>P</sup>, S411<sup>P</sup>, S412<sup>P</sup>, S413<sup>P</sup>, S415<sup>P</sup>, S501, S502, S503, S504, S505, S506, S507, S508, S509, S601, S602, S604, S605, S606, S607, S608, S609, S611, S612, S701, S702</li> <li>SIM101, SIM102, SIM103, SIM105, SIM107, SIM108, SIM109, SIM110, SIM112, SIM113, SIM114, SIM115, SIM116, SIM117, SIM118, SIM201, SIM202, SIM208, SIM210, SIM211, SIM212, SIM220, SIM221, SIM222, SIM223, SIM300, SIM910, SIM911</li> <li>SLF001</li> <li>SLOT000, SLOT001, SLOT002</li> <li>T100, T201, T203</li> <li>TCH001, TCH002, TCH003, TCH004, TCH005, TCH010</li> <li>TD004, TD005, TD006, TD007</li> <li>TID251, TID252, TID253</li> <li>TRIO100, TRIO105, TRIO109, TRIO110, TRIO115</li> <li>TRY002, TRY003, TRY004, TRY201, TRY300, TRY301, TRY302, TRY400, TRY401</li> <li>UP001, UP003, UP004, UP005, UP006, UP007, UP008, UP009, UP010, UP011, UP012, UP013, UP014, UP015, UP017, UP018, UP019, UP020, UP021, UP022, UP023, UP024, UP025, UP026, UP027, UP028, UP029, UP030, UP031, UP032, UP033, UP034, UP035, UP036, UP037, UP038, UP039, UP040, UP041</li> <li>W291, W292, W293, W505, W605</li> <li>YTT101, YTT102, YTT103, YTT201, YTT202, YTT203, YTT204, YTT301, YTT302, YTT303</li> </ul>"},{"location":"config/internal/testing/","title":"Testing configuration","text":"<p>Check out the testing overview tutorial for a more comprehensive walk-through.</p>"},{"location":"config/internal/testing/#settings","title":"Settings","text":"<p>If an option has a corresponding <code>test</code> command flag, the flag will always take precedence.</p>"},{"location":"config/internal/testing/#default-arguments","title":"Default arguments","text":"<p>You can define default arguments for the <code>test</code> command by setting the <code>default-args</code> option, which must be an array of strings. The following is the default configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\ndefault-args = [\"tests\"]\n</code></pre> <pre><code>[envs.hatch-test]\ndefault-args = [\"tests\"]\n</code></pre>"},{"location":"config/internal/testing/#extra-arguments","title":"Extra arguments","text":"<p>You can define extra internal arguments for test scripts by setting the <code>extra-args</code> option, which must be an array of strings. For example, if you wanted to increase the verbosity of <code>pytest</code>, you could set the following:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nextra-args = [\"-vv\"]\n</code></pre> <pre><code>[envs.hatch-test]\nextra-args = [\"-vv\"]\n</code></pre>"},{"location":"config/internal/testing/#randomize-test-order","title":"Randomize test order","text":"<p>You can randomize the order of tests by enabling the <code>randomize</code> option which corresponds to the <code>--randomize</code>/<code>-r</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nrandomize = true\n</code></pre> <pre><code>[envs.hatch-test]\nrandomize = true\n</code></pre>"},{"location":"config/internal/testing/#parallelize-test-execution","title":"Parallelize test execution","text":"<p>You can parallelize test execution by enabling the <code>parallel</code> option which corresponds to the <code>--parallel</code>/<code>-p</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nparallel = true\n</code></pre> <pre><code>[envs.hatch-test]\nparallel = true\n</code></pre>"},{"location":"config/internal/testing/#retry-failed-tests","title":"Retry failed tests","text":"<p>You can retry failed tests by setting the <code>retries</code> option which corresponds to the <code>--retries</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nretries = 2\n</code></pre> <pre><code>[envs.hatch-test]\nretries = 2\n</code></pre> <p>You can also set the number of seconds to wait between retries by setting the <code>retry-delay</code> option which corresponds to the <code>--retry-delay</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nretry-delay = 1\n</code></pre> <pre><code>[envs.hatch-test]\nretry-delay = 1\n</code></pre>"},{"location":"config/internal/testing/#customize-environment","title":"Customize environment","text":"<p>You can fully alter the behavior of the environment used by the <code>test</code> command.</p>"},{"location":"config/internal/testing/#dependencies","title":"Dependencies","text":"<p>You can define extra dependencies that your tests may require:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nextra-dependencies = [\n  \"pyfakefs\",\n  \"pytest-asyncio\",\n  \"pytest-benchmark\",\n  \"pytest-memray\",\n  \"pytest-playwright\",\n  \"pytest-print\",\n]\n</code></pre> <pre><code>[envs.hatch-test]\nextra-dependencies = [\n  \"pyfakefs\",\n  \"pytest-asyncio\",\n  \"pytest-benchmark\",\n  \"pytest-memray\",\n  \"pytest-playwright\",\n  \"pytest-print\",\n]\n</code></pre> <p>The following is the default configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\ndependencies = [\n  \"coverage-enable-subprocess==1.0\",\n  \"coverage[toml]~=7.4\",\n  \"pytest~=8.1\",\n  \"pytest-mock~=3.12\",\n  \"pytest-randomly~=3.15\",\n  \"pytest-rerunfailures~=14.0\",\n  \"pytest-xdist[psutil]~=3.5\",\n]\n</code></pre> <pre><code>[envs.hatch-test]\ndependencies = [\n  \"coverage-enable-subprocess==1.0\",\n  \"coverage[toml]~=7.4\",\n  \"pytest~=8.1\",\n  \"pytest-mock~=3.12\",\n  \"pytest-randomly~=3.15\",\n  \"pytest-rerunfailures~=14.0\",\n  \"pytest-xdist[psutil]~=3.5\",\n]\n</code></pre>"},{"location":"config/internal/testing/#matrix","title":"Matrix","text":"<p>You can override the default series of matrices:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\", \"3.10\", \"3.9\", \"3.8\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\", \"3.10\", \"3.9\", \"3.8\"]\n</code></pre>"},{"location":"config/internal/testing/#scripts","title":"Scripts","text":"<p>If you want to change the default commands that are executed, you can override the scripts. The following default scripts must be redefined:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test.scripts]\nrun = \"pytest{env:HATCH_TEST_ARGS:} {args}\"\nrun-cov = \"coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}\"\ncov-combine = \"coverage combine\"\ncov-report = \"coverage report\"\n</code></pre> <pre><code>[envs.hatch-test.scripts]\nrun = \"pytest{env:HATCH_TEST_ARGS:} {args}\"\nrun-cov = \"coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}\"\ncov-combine = \"coverage combine\"\ncov-report = \"coverage report\"\n</code></pre> <p>The <code>run</code> script is the default behavior while the <code>run-cov</code> script is used instead when measuring code coverage. The <code>cov-combine</code> script runs after all tests complete when measuring code coverage, as well as the <code>cov-report</code> script when not using the <code>--cover-quiet</code> flag.</p> <p>Note</p> <p>The <code>HATCH_TEST_ARGS</code> environment variable is how the <code>test</code> command's flags are translated and internally populated without affecting the user's arguments. This is also the way that extra arguments are passed.</p>"},{"location":"history/hatch/","title":"Hatch history","text":"<p>All notable changes to Hatch will be documented in this file.</p> <p>The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.</p>"},{"location":"history/hatch/#unreleased","title":"Unreleased","text":"<p>Added:</p> <ul> <li>Add <code>test</code> command</li> <li>Add <code>self report</code> command for submitting pre-populated bug reports to GitHub</li> <li>The reserved environment used for static analysis is now completely configurable</li> <li>Add the following methods to the <code>environment</code> interface for complete control over output during life cycle management: <code>app_status_creation</code>, <code>app_status_pre_installation</code>, <code>app_status_post_installation</code>, <code>app_status_project_installation</code>, <code>app_status_dependency_state_check</code>, <code>app_status_dependency_installation_check</code>, <code>app_status_dependency_synchronization</code></li> <li>Add binaries for 32-bit versions of Windows</li> <li>Read configuration from any <code>~/.pypirc</code> file for the <code>index</code> publisher</li> <li>Use the Git user as the default username for new project URL metadata</li> <li>Add <code>HATCH_DEBUG</code> environment variable that when enabled will show local variables in the case of unhandled tracebacks</li> <li>Upgrade default CPython distributions to 20240224</li> <li>Upgrade Ruff to 0.3.1</li> <li>Upgrade PyApp to 0.15.1 for binary builds</li> <li>Bump the minimum supported version of Hatchling to 1.22.2</li> </ul> <p>Fixed:</p> <ul> <li>When projects derive dependencies from metadata hooks, there is now by default a status indicator for when the hooks are executed for better responsiveness</li> <li>Fix dependency inheritance for the template of the <code>types</code> environment for new projects</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.4","title":"1.9.4 - 2024-03-12","text":"<p>Fixed:</p> <ul> <li>Limit the maximum version of Hatchling in anticipation of backward incompatible changes</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.3","title":"1.9.3 - 2024-01-25","text":"<p>Fixed:</p> <ul> <li>Fix loading of local plugins to account for newly released versions of a dependency</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.2","title":"1.9.2 - 2024-01-21","text":"<p>Fixed:</p> <ul> <li>Fix the default token variable name for publishing to PyPI</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.1","title":"1.9.1 - 2023-12-25","text":"<p>Fixed:</p> <ul> <li>Ensure that the <code>dependency_hash</code> method of the <code>environment</code> interface is called after <code>sync_dependencies</code> for cases where the hash is only known at that point, such as for dependency lockers</li> <li>Only acknowledge the <code>HATCH_PYTHON_VARIANT_*</code> environment variables for Python resolution for supported platforms and architectures</li> <li>Fix Python resolution when there are metadata hooks with unsatisfied dependencies</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.0","title":"1.9.0 - 2023-12-19","text":"<p>Changed:</p> <ul> <li>Environments prefixed by <code>hatch-</code> are now considered internal and used for special purposes such as configuration for static analysis</li> </ul> <p>Added:</p> <ul> <li>Enable docstring formatting by default for static analysis</li> <li>Allow for overriding config of internal environments</li> <li>Concretely state the expected API contract for the environment interface methods <code>find</code> and <code>check_compatibility</code></li> <li>Upgrade Ruff to 0.1.8</li> <li>Bump the minimum supported version of Hatchling to 1.21.0</li> </ul> <p>Fixed:</p> <ul> <li>Ignore a project's Python requirement for environments where the project is not installed</li> <li>When not persisting config for static analysis, properly manage internal settings when Ruff's top level table already exists</li> <li>Ignore compatibility checks when environments have already been created, significantly improving performance of environment usage</li> <li>Properly allow overriding of the <code>path</code> option for the <code>virtual</code> environment type</li> <li>Fix nushell activation on non-Windows systems</li> </ul>"},{"location":"history/hatch/#hatch-v1.8.1","title":"1.8.1 - 2023-12-14","text":"<p>Fixed:</p> <ul> <li>Fix regression in calling subprocesses with updated PATH</li> <li>Fix automatic installation of environment plugins when running as a standalone binary</li> <li>Change default location of Python installations</li> </ul>"},{"location":"history/hatch/#hatch-v1.8.0","title":"1.8.0 - 2023-12-11","text":"<p>Changed:</p> <ul> <li>Drop support for Python 3.7</li> <li>The <code>get_build_process</code> method of the <code>environment</code> interface has been removed; plugins should use the new <code>run_builder</code> method instead</li> <li>Remove <code>pyperclip</code> dependency and the <code>--copy</code> flag of the <code>config find</code> command</li> <li>When running the <code>build</code> command all output from builders is now displayed as-is in real time without the stripping of ANSI codes</li> <li>Version information (for Hatch itself) is now derived from Git</li> </ul> <p>Added:</p> <ul> <li>Support Python 3.12</li> <li>Add installers and standalone binaries</li> <li>Add the ability to manage Python installations</li> <li>Add <code>fmt</code> command</li> <li>The <code>virtual</code> environment type can now automatically download requested versions of Python that are not installed</li> <li>Add <code>dependency_hash</code> method to the <code>environment</code> interface</li> <li>The state of installed dependencies for environments is saved as metadata so if dependency definitions have not changed then no checking is performed, which can be computationally expensive</li> <li>The <code>build</code> command now supports backends other than Hatchling</li> <li>Allow the use of <code>features</code> for environments when <code>skip-install</code> is enabled</li> <li>The default is now <code>__token__</code> when prompting for a username for the <code>publish</code> command</li> <li>Add a new <code>run_builder</code> method to the <code>environment</code> interface</li> <li>Bump the minimum supported version of Hatchling to 1.19.0</li> <li>Bump the minimum supported version of <code>click</code> to 8.0.6</li> </ul> <p>Fixed:</p> <ul> <li>Fix nushell activation</li> <li>Better handling of flat storage directory hierarchies for the <code>virtual</code> environment type</li> <li>Display useful information when running the <code>version</code> command outside of a project rather than erroring</li> <li>Fix the <code>project metadata</code> command by only capturing stdout from the backend</li> <li>Properly support Google Artifact Registry</li> <li>Fix parsing dependencies for environments when warnings are emitted</li> </ul>"},{"location":"history/hatch/#hatch-v1.7.0","title":"1.7.0 - 2023-04-03","text":"<p>Changed:</p> <ul> <li>The <code>src-layout</code> project template option is now enabled by default</li> <li>Non-critical output now goes to stderr</li> </ul> <p>Added:</p> <ul> <li>Add <code>tool.hatch.env.requires</code> configuration to automatically install dependencies for environment and environment collector plugins</li> <li>Add <code>custom</code> environment collector</li> <li>Improve syncing of dependencies provided through Git direct references</li> <li>Add <code>isolated_data_directory</code> attribute to the environment interface</li> <li>Increase the timeout for and add retries to the <code>index</code> publisher</li> <li>Expand home and environment variables in configured cache and data directories</li> <li>Improve readability of exceptions</li> <li>Update project templates</li> <li>Bump the minimum supported version of Hatchling to 1.14.0</li> </ul> <p>Fixed:</p> <ul> <li>Fix displaying the version with the <code>version</code> command when the version is static and build dependencies are unmet</li> <li>Fix build environments for the <code>virtual</code> environment type when storing within a relative path</li> <li>Work around System Integrity Protection on macOS when running commands</li> <li>Allow setuptools metadata migration for projects without <code>setup.py</code> if <code>setup.cfg</code> is present</li> <li>Handle additional edge cases for setuptools metadata migration</li> <li>Support boolean values for the <code>config set</code> command</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.3","title":"1.6.3 - 2022-10-24","text":"<p>Fixed:</p> <ul> <li>Fix <code>version</code> command when the version is dynamic and build dependencies are unmet</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.2","title":"1.6.2 - 2022-10-20","text":"<p>Fixed:</p> <ul> <li>Fix getting dynamic metadata from hooks for environments when dependencies are not dynamic</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.1","title":"1.6.1 - 2022-10-16","text":"<p>Fixed:</p> <ul> <li>Computing the path to the user's home directory now gracefully falls back to <code>~</code> when it cannot be determined</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.0","title":"1.6.0 - 2022-10-08","text":"<p>Changed:</p> <ul> <li>The <code>run_shell_command</code> environment interface method now accepts arbitrary <code>subprocess.Popen</code> keyword arguments. This is not strictly breaking, but will be utilized in upcoming features.</li> <li>The internal directory structure for storing <code>virtual</code> environments is now more nested. This is not breaking, but any local environments will be created anew.</li> </ul> <p>Added:</p> <ul> <li>Add <code>project</code> command group to view details about the project like PEP 621 metadata</li> <li>Better support for auto-detection of environments by tools like Visual Studio Code now that the storage directory of <code>virtual</code> environments will be flat if Hatch's configured <code>virtual</code> environment directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory</li> <li>Build environments for the <code>virtual</code> environment type are now cached for improved performance</li> <li>Add <code>build_environment_exists</code> method to the environment interface for implementations that cache the build environment</li> <li>Add <code>path</code> option to the <code>virtual</code> environment type</li> <li>Add <code>--initialize-auth</code> flag to the <code>index</code> publisher to allow for the saving of authentication information before publishing</li> <li>Support Bash on Windows for the <code>shell</code> command</li> <li>The <code>setuptools</code> migration script no longer modifies the formatting of existing <code>pyproject.toml</code> configuration</li> <li>Bump the minimum supported version of Hatchling to 1.11.0</li> </ul> <p>Fixed:</p> <ul> <li>Environments now respect dynamically defined project dependencies</li> <li>The <code>dep hash</code> and all <code>dep show</code> commands now respect dynamically defined project dependencies</li> <li>The <code>env show</code>, <code>dep hash</code>, and all <code>dep show</code> commands now honor context formatting</li> <li>Fix matrix variable inclusion filtering of the <code>run</code> and <code>env run</code> commands when there are multiple possible variables</li> <li>Build environment compatibility is now checked before use</li> <li>Decreasing verbosity now has no affect on output that should always be displayed</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> <li>Environments now respect user defined environment variables for context formatting</li> <li>Update the scripts in the generated test environment template for new projects to reflect the documentation</li> <li>Allow <code>extra-dependencies</code> in environment overrides</li> <li>Depend on <code>packaging</code> explicitly rather than relying on it being a transitive dependency of Hatchling</li> </ul>"},{"location":"history/hatch/#hatch-v1.5.0","title":"1.5.0 - 2022-08-28","text":"<p>Added:</p> <ul> <li>The <code>index</code> publisher now recognizes repository-specific options</li> <li>Add the <code>--ignore-compat</code> flag to the <code>env run</code> command</li> <li>Setting the <code>HATCH_PYTHON</code> environment variable to <code>self</code> will now force the use of the Python executable Hatch is running on for <code>virtual</code> environment creation</li> </ul> <p>Fixed:</p> <ul> <li>Fix the <code>--force-continue</code> flag of the <code>env run</code> command</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> </ul>"},{"location":"history/hatch/#hatch-v1.4.2","title":"1.4.2 - 2022-08-16","text":"<p>Fixed:</p> <ul> <li>Fix check for updating static versions with the <code>version</code> command when metadata hooks are in use</li> </ul>"},{"location":"history/hatch/#hatch-v1.4.1","title":"1.4.1 - 2022-08-13","text":"<p>Fixed:</p> <ul> <li>Fix non-detached inheritance disabling for environments</li> </ul>"},{"location":"history/hatch/#hatch-v1.4.0","title":"1.4.0 - 2022-08-06","text":"<p>Added:</p> <ul> <li>The default Python for <code>virtual</code> environments now checks PATH before using the one Hatch is running on</li> <li>Values for environment <code>env-vars</code> now support context formatting</li> <li>Add <code>name</code> override for environments to allow for regular expression matching</li> <li>The <code>index</code> publisher now better supports non-PyPI indices</li> <li>Add certificate options to the <code>index</code> publisher</li> <li>Display waiting text when checking dependencies and removing environments</li> <li>Display help text the first time the <code>shell</code> command is executed</li> <li>Update project templates with Python 3.11 and the latest versions of various GitHub Actions</li> <li>Add support for Almquist (<code>ash</code>) shells</li> <li>Add <code>hyperlink</code> as a dependency for better handling of package index URLs</li> <li>Bump the minimum supported version of <code>virtualenv</code> to 20.16.2</li> <li>Bump the minimum supported version of <code>tomlkit</code> to 0.11.1</li> </ul> <p>Fixed:</p> <ul> <li>Acknowledge <code>extra-dependencies</code> for the <code>env show</code> command</li> <li>Fix locating executables within virtual environments on Debian</li> <li>Fix managing the terminal size inside the <code>shell</code> command</li> <li>Fix default code coverage file omission for the <code>src-layout</code> project template option</li> </ul>"},{"location":"history/hatch/#hatch-v1.3.1","title":"1.3.1 - 2022-07-11","text":"<p>Fixed:</p> <ul> <li>Support <code>-h</code>/<code>--help</code> flag for the <code>run</code> command</li> </ul>"},{"location":"history/hatch/#hatch-v1.3.0","title":"1.3.0 - 2022-07-10","text":"<p>Changed:</p> <ul> <li>Rename the default publishing plugin from <code>pypi</code> to the more generic <code>index</code></li> </ul> <p>Added:</p> <ul> <li>Support the absence of <code>pyproject.toml</code> files, as is the case for apps and non-Python projects</li> <li>Hide scripts that start with an underscore for the <code>env show</code> command by default</li> <li>Ignoring the exit codes of commands by prefixing with hyphens now works with entire named scripts</li> <li>Add a way to require confirmation for publishing</li> <li>Add <code>--force-continue</code> flag to the <code>env run</code> command</li> <li>Make tracebacks colorful and less verbose</li> <li>When shell configuration has not been defined, attempt to use the current shell based on parent processes before resorting to the defaults</li> <li>The shell name <code>pwsh</code> is now an alias for <code>powershell</code></li> <li>Remove <code>atomicwrites</code> dependency</li> <li>Relax constraint on <code>userpath</code> dependency</li> <li>Bump the minimum supported version of Hatchling to 1.4.1</li> </ul> <p>Fixed:</p> <ul> <li>Keep environments in sync with the dependencies of the selected features</li> <li>Use <code>utf-8</code> for all files generated for new projects</li> <li>Escape special characters Git may return in the user name when writing generated files for new projects</li> <li>Normalize the package name to lowercase in <code>setuptools</code> migration script</li> <li>Fix parsing of source distributions during publishing</li> </ul>"},{"location":"history/hatch/#hatch-v1.2.1","title":"1.2.1 - 2022-05-30","text":"<p>Fixed:</p> <ul> <li>Fix handling of top level <code>data_files</code> in <code>setuptools</code> migration script</li> </ul>"},{"location":"history/hatch/#hatch-v1.2.0","title":"1.2.0 - 2022-05-22","text":"<p>Changed:</p> <ul> <li>The <code>enter_shell</code> environment plugin method now accepts an additional <code>args</code> parameter</li> </ul> <p>Added:</p> <ul> <li>Allow context string formatting for environment dependencies</li> <li>Add environment context string formatting fields <code>env_name</code>, <code>env_type</code>, <code>matrix</code>, <code>verbosity</code>, and <code>args</code></li> <li>Support overriding the default arguments used to spawn shells on non-Windows systems</li> <li>Bump the minimum supported version of Hatchling to 1.3.0</li> </ul> <p>Fixed:</p> <ul> <li>Improve <code>setuptools</code> migration script</li> </ul>"},{"location":"history/hatch/#hatch-v1.1.2","title":"1.1.2 - 2022-05-20","text":"<p>Fixed:</p> <ul> <li>Bump the minimum supported version of Hatchling to 1.2.0</li> <li>Update project metadata to reflect support for Python 3.11</li> </ul>"},{"location":"history/hatch/#hatch-v1.1.1","title":"1.1.1 - 2022-05-12","text":"<p>Fixed:</p> <ul> <li>Fix <code>setuptools</code> migration script for non-Windows systems</li> </ul>"},{"location":"history/hatch/#hatch-v1.1.0","title":"1.1.0 - 2022-05-12","text":"<p>Changed:</p> <ul> <li>In order to simplify the implementation of command execution for environment plugins, the <code>run_shell_commands</code> method has been replaced by the singular <code>run_shell_command</code>. A new <code>command_context</code> method has been added to more easily satisfy complex use cases.</li> <li>The <code>finalize_command</code> environment plugin method has been removed in favor of the newly introduced context formatting functionality.</li> </ul> <p>Added:</p> <ul> <li>Add context formatting functionality i.e. the ability to insert values into configuration like environment variables and command line arguments</li> <li>Any verbosity for command execution will now always display headers, even for single environments</li> <li>Every executed command is now displayed when running multiple commands or when verbosity is enabled</li> <li>Similar to <code>make</code>, ignore the exit code of executed commands that start with <code>-</code> (a hyphen)</li> <li>Add ability for the <code>--init</code> flag of the <code>new</code> command to automatically migrate <code>setuptools</code> configuration</li> <li>Update project metadata to reflect the adoption by PyPA and production stability</li> </ul>"},{"location":"history/hatch/#hatch-v1.0.0","title":"1.0.0 - 2022-04-28","text":"<p>This is the first stable release of Hatch v1, a complete rewrite. Enjoy!</p>"},{"location":"history/hatchling/","title":"Hatchling history","text":"<p>All notable changes to Hatchling will be documented in this file.</p> <p>The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.</p>"},{"location":"history/hatchling/#unreleased","title":"Unreleased","text":""},{"location":"history/hatchling/#hatchling-v1.22.5","title":"1.22.5 - 2024-04-04","text":"<p>Fixed:</p> <ul> <li>Fix reading metadata from source distributions when fields are dynamic but not part of core metadata like entry points</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.4","title":"1.22.4 - 2024-03-23","text":"<p>Fixed:</p> <ul> <li>Only read source distribution metadata for fields that are explicitly defined as dynamic</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.3","title":"1.22.3 - 2024-03-19","text":"<p>Fixed:</p> <ul> <li>Fix the <code>custom</code> build hook when using dynamic dependencies</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.2","title":"1.22.2 - 2024-03-16","text":"<p>Fixed:</p> <ul> <li>Fix regression when loading metadata from source distributions</li> <li>Fix metadata hooks when building wheels from source distributions</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.1","title":"1.22.1 - 2024-03-16","text":"<p>Fixed:</p> <ul> <li>Update the default version of core metadata to 2.3</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.0","title":"1.22.0 - 2024-03-16","text":"<p>Deprecated:</p> <ul> <li>The <code>app</code> build target has been renamed to <code>binary</code> to reduce ambiguity with the name of an upcoming feature. The former name will still be usable for several minor releases.</li> </ul> <p>Added:</p> <ul> <li>Metadata for the <code>wheel</code> target now defaults to the <code>PKG-INFO</code> metadata within source distributions</li> <li>Add <code>dependencies</code> method to the build hook interface so that hooks can themselves dynamically define dependencies</li> <li>Update the default version of core metadata to 2.2</li> <li>Update SPDX license information to version 3.23</li> <li>Improve error message for when the default heuristics for wheel file inclusion fail</li> </ul> <p>Fixed:</p> <ul> <li>Properly support core metadata version 2.2</li> <li>Remove <code>editables</code> as a direct dependency</li> <li>Fix default wheel tag when the supported Python version declaration is strict</li> <li>Load VCS ignore patterns first so that whitelisted patterns can be excluded by project configuration</li> <li>Don't consider VCS ignore files that are outside of the VCS boundary</li> <li>The <code>sdist</code> build target now gracefully ignores UNIX socket files</li> <li>Begin ignoring certain files ubiquitously, like <code>.DS_Store</code> on macOS</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.21.1","title":"1.21.1 - 2024-01-25","text":"<p>Fixed:</p> <ul> <li>Fix loading of local plugins to account for newly released versions of a dependency</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.21.0","title":"1.21.0 - 2023-12-18","text":"<p>Added:</p> <ul> <li>Add <code>parent</code> context modifier for path fields</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.20.0","title":"1.20.0 - 2023-12-13","text":"<p>Added:</p> <ul> <li>Add <code>bypass-selection</code> option to the <code>wheel</code> build target to allow for empty (metadata-only) wheels</li> </ul> <p>Fixed:</p> <ul> <li>Fix regression in 1.19.1 that allowed <code>exclude</code> to count toward inclusion selection, thus bypassing the default inclusion selection heuristics</li> <li>Fix writing optional dependency core metadata in situations where there are multiple environment markers</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.19.1","title":"1.19.1 - 2023-12-12","text":"<p>Fixed:</p> <ul> <li>Add better error message when the <code>wheel</code> build target cannot determine what to ship</li> <li>Consider forced inclusion patterns and build-time artifacts as file selection since some build hooks generate the entire wheel contents without user configuration</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.19.0","title":"1.19.0 - 2023-12-11","text":"<p>Changed:</p> <ul> <li>An error will now be raised if a force-included path does not exist</li> <li>An error will now be raised for the <code>wheel</code> build target if no file selection options are defined</li> </ul> <p>Added:</p> <ul> <li>Officially support Python 3.12</li> <li>Allow using an empty string for the <code>sources</code> option to add a prefix to distribution paths</li> </ul> <p>Fixed:</p> <ul> <li>Properly handle non-zero version epoch for the <code>standard</code> version scheme</li> <li>Fix the <code>wheel</code> build target for case insensitive file systems when the project metadata name does not match the directory name on disk</li> <li>The <code>app</code> build target no longer has suppressed output</li> <li>Prevent duplicate paths when projects require the <code>sources</code> option while build hooks overwrite included paths</li> <li>Properly escape spaces for URI context formatting</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.18.0","title":"1.18.0 - 2023-06-12","text":"<p>Changed:</p> <ul> <li>Drop support for Python 3.7</li> </ul> <p>Added:</p> <ul> <li>Update the list of directories that are always excluded for builds</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.17.1","title":"1.17.1 - 2023-06-03","text":"<p>Fixed:</p> <ul> <li>Fix dev mode when the project has symlinks and file inclusion is defined with the <code>packages</code> or <code>only-include</code> options</li> <li>Change the name of generated PTH files for dev mode so they come first lexicographically and therefore load first</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.17.0","title":"1.17.0 - 2023-05-12","text":"<p>Added:</p> <ul> <li>The <code>app</code> build target now embeds the project version in the name of binaries</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.16.1","title":"1.16.1 - 2023-05-11","text":"<p>Fixed:</p> <ul> <li>Fix determining the built executable path for the <code>app</code> build target option when using a local copy of PyApp when there is an explicit target triple set</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.16.0","title":"1.16.0 - 2023-05-11","text":"<p>Added:</p> <ul> <li>Add <code>app</code> build target option to build using a local copy of the PyApp repository</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.15.0","title":"1.15.0 - 2023-05-09","text":"<p>Added:</p> <ul> <li>Add <code>app</code> build target</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.14.1","title":"1.14.1 - 2023-04-23","text":"<p>Fixed:</p> <ul> <li>Fix internal archive root naming for the <code>sdist</code> target when <code>strict-naming</code> is disabled to match the file name in order to support the expectation of some frontends</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.14.0","title":"1.14.0 - 2023-04-02","text":"<p>Added:</p> <ul> <li>Add <code>trove-classifiers</code> as a dependency</li> </ul> <p>Fixed:</p> <ul> <li>Properly normalize metadata descriptions that contain line breaks</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.13.0","title":"1.13.0 - 2023-02-09","text":"<p>Added:</p> <ul> <li>Update the set of known trove classifiers to version 2023.2.8</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.12.2","title":"1.12.2 - 2023-01-05","text":"<p>Fixed:</p> <ul> <li>Add <code>macos-max-compat</code> option to the <code>wheel</code> target that is enabled by default to support the latest version 22.0 of the <code>packaging</code> library</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.12.1","title":"1.12.1 - 2022-12-31","text":"<p>Fixed:</p> <ul> <li>Fix minor regression in the PEP 517/660 function signatures that was discovered by Fedora</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.12.0","title":"1.12.0 - 2022-12-30","text":"<p>Added:</p> <ul> <li>Improve readability of exceptions</li> <li>Add <code>extra_metadata</code> build data to the <code>wheel</code> target</li> <li>Retroactively support <code>License-Expression</code> core metadata starting at version 2.1</li> <li>Add more type hints</li> <li>Update the set of known trove classifiers to version 2022.12.22</li> <li>Update SPDX license information to version 3.19</li> <li>Store Hatchling's metadata in <code>pyproject.toml</code></li> </ul> <p>Fixed:</p> <ul> <li>Acknowledge the <code>ARCHFLAGS</code> environment variable on macOS for the <code>wheel</code> target when build hooks set the <code>infer_tag</code> build data to <code>true</code></li> <li>Fix dependency checking when encountering broken distributions</li> <li>Fix the <code>support-legacy</code> option for the <code>sdist</code> target when using a src-layout project structure</li> <li>Remove unnecessary encoding declaration in the default template for the <code>version</code> build hook</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.11.1","title":"1.11.1 - 2022-10-19","text":"<p>Fixed:</p> <ul> <li>Fix default file selection behavior of the <code>wheel</code> target when there is a single top-level module</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.11.0","title":"1.11.0 - 2022-10-08","text":"<p>Added:</p> <ul> <li>Add <code>env</code> version source to retrieve the version from an environment variable</li> <li>Add <code>validate-bump</code> option to the <code>standard</code> version scheme</li> </ul> <p>Fixed:</p> <ul> <li>Use proper CSV formatting for the <code>RECORD</code> metadata file of the <code>wheel</code> target to avoid warnings during installation by <code>pip</code> if, for example, file names contain commas</li> <li>Fix installations with pip for build hooks that modify runtime dependencies</li> <li>Decreasing verbosity now has no affect on output that should always be displayed</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.10.0","title":"1.10.0 - 2022-09-18","text":"<p>Added:</p> <ul> <li>Add the following to the list of directories that cannot be traversed: <code>__pypackages__</code>, <code>.hg</code>, <code>.hatch</code>, <code>.tox</code>, <code>.nox</code></li> <li>Add deprecated option to allow ambiguous features</li> </ul> <p>Fixed:</p> <ul> <li>Improve tracking of dynamic metadata</li> <li>Fix core metadata for entries in <code>project.optional-dependencies</code> that use direct references</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.9.0","title":"1.9.0 - 2022-09-09","text":"<p>Changed:</p> <ul> <li>File pattern matching now more closely resembles Git's behavior</li> </ul> <p>Added:</p> <ul> <li>Implement a minimal version of <code>prepare_metadata_for_build_wheel</code> and <code>prepare_metadata_for_build_editable</code> for non-frontend tools that only need to inspect a project's metadata</li> <li>Add <code>metadata</code> command to view PEP 621 project metadata</li> <li>Improve error messages for SPDX license errors</li> <li>Retroactively support <code>License-File</code> for core metadata starting at version 2.1</li> <li>Bump the minimum supported version of <code>pathspec</code> to 0.10.1</li> </ul> <p>Fixed:</p> <ul> <li>Allow the valid non-SPDX <code>license</code> values <code>LicenseRef-Public-Domain</code> and <code>LicenseRef-Proprietary</code></li> <li>Show the help text of the CLI when no subcommand is selected</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.8.1","title":"1.8.1 - 2022-08-25","text":"<p>Fixed:</p> <ul> <li>Fix default file inclusion for <code>wheel</code> build targets when both the project name and package directory name are not normalized</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.8.0","title":"1.8.0 - 2022-08-16","text":"<p>Added:</p> <ul> <li>Add <code>get_known_classifiers</code> method to metadata hooks</li> </ul> <p>Fixed:</p> <ul> <li>Fix check for updating static versions with the <code>version</code> command when metadata hooks are in use</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.7.1","title":"1.7.1 - 2022-08-13","text":"<p>Fixed:</p> <ul> <li>Fix the value of the <code>relative_path</code> attribute of included files, that some build plugins may use, when selecting explicit paths</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.7.0","title":"1.7.0 - 2022-08-12","text":"<p>Added:</p> <ul> <li>Add <code>require-runtime-features</code> option for builders and build hooks</li> <li>Check for unknown trove classifiers</li> <li>Update SPDX license information to version 3.18</li> </ul> <p>Fixed:</p> <ul> <li>Add better error message for <code>wheel</code> target dev mode installations that define path rewrites with the <code>sources</code> option</li> <li>Note the <code>allow-direct-references</code> option in the relevant error messages</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.6.0","title":"1.6.0 - 2022-07-23","text":"<p>Changed:</p> <ul> <li>When no build targets are specified on the command line, now default to <code>sdist</code> and <code>wheel</code> targets rather than what happens to be defined in config</li> <li>The <code>code</code> version source now only supports files with known extensions</li> <li>Global build hooks now run before target-specific build hooks to better match expected behavior</li> </ul> <p>Added:</p> <ul> <li>The <code>code</code> version source now supports loading extension modules</li> <li>Add <code>search-paths</code> option for the <code>code</code> version source</li> </ul> <p>Fixed:</p> <ul> <li>Fix removing <code>sources</code> using an empty string value in the mapping</li> <li>The <code>strict-naming</code> option now also applies to the metadata directory of <code>wheel</code> targets</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.5.0","title":"1.5.0 - 2022-07-11","text":"<p>Added:</p> <ul> <li>Support the final draft of PEP 639</li> <li>Add <code>strict-naming</code> option for <code>sdist</code> and <code>wheel</code> targets</li> </ul> <p>Fixed:</p> <ul> <li>Project names are now stored in <code>sdist</code> and <code>wheel</code> target core metadata exactly as defined in <code>pyproject.toml</code> without normalization to allow control of how PyPI displays them</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.4.1","title":"1.4.1 - 2022-07-04","text":"<p>Fixed:</p> <ul> <li>Fix forced inclusion of important files like licenses for <code>sdist</code> targets when using the explicit selection options</li> <li>Don't sort project URL metadata so that the rendered order on PyPI can be controlled</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.4.0","title":"1.4.0 - 2022-07-03","text":"<p>Changed:</p> <ul> <li>The <code>packages</code> option uses the new <code>only-include</code> option to provide targeted inclusion, since that is desired most of the time. You can retain the old behavior by using the <code>include</code> and <code>sources</code> options together.</li> </ul> <p>Added:</p> <ul> <li>Support PEP 561 type hinting</li> <li>Add <code>version</code> build hook</li> <li>Add <code>only-include</code> option</li> <li>The <code>editable</code> version of <code>wheel</code> targets now respects the <code>force-include</code> option by default</li> <li>The <code>force-include</code> option now supports path rewriting with the <code>sources</code> option</li> <li>The <code>wheel</code> target <code>shared-data</code> and <code>extra-metadata</code> options now respect file selection options</li> <li>The <code>wheel</code> target now auto-detects single module layouts</li> <li>Improve performance by never entering directories that are guaranteed to be undesirable like <code>__pycache__</code> rather than excluding individual files within</li> <li>Update SPDX license information to version 3.17</li> </ul> <p>Fixed:</p> <ul> <li>Don't write empty entry points file for <code>wheel</code> targets if there are no entry points defined</li> <li>Allow metadata hooks to set the <code>version</code> in all cases</li> <li>Prevent duplicate file entries from inclusion when using the <code>force-include</code> option</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.3.1","title":"1.3.1 - 2022-05-30","text":"<p>Fixed:</p> <ul> <li>Better populate global variables for the <code>code</code> version source</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.3.0","title":"1.3.0 - 2022-05-22","text":"<p>Removed:</p> <ul> <li>Remove unused global <code>args</code> context string formatting field</li> </ul> <p>Added:</p> <ul> <li>Improve error messages for the <code>env</code> context string formatting field</li> </ul> <p>Fixed:</p> <ul> <li>Fix <code>uri</code> context string formatting modifier on Windows</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.2.0","title":"1.2.0 - 2022-05-20","text":"<p>Added:</p> <ul> <li>Allow context formatting for <code>project.dependencies</code> and <code>project.optional-dependencies</code></li> </ul>"},{"location":"history/hatchling/#hatchling-v1.1.0","title":"1.1.0 - 2022-05-19","text":"<p>Added:</p> <ul> <li>Add <code>uri</code> and <code>real</code> context string formatting modifiers for file system paths</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.0.0","title":"1.0.0 - 2022-05-17","text":"<p>Changed:</p> <ul> <li>Drop support for Python 2</li> </ul> <p>Added:</p> <ul> <li>Improve error messaging for invalid versions</li> <li>Update project metadata to reflect support for Python 3.11</li> </ul>"},{"location":"history/hatchling/#hatchling-v0.25.1","title":"0.25.1 - 2022-06-14","text":"<p>Fixed:</p> <ul> <li>Fix support for Windows on Python 2 by removing its support for symlinks</li> </ul>"},{"location":"history/hatchling/#hatchling-v0.25.0","title":"0.25.0 - 2022-05-15","text":"<p>Added:</p> <ul> <li>Add <code>skip-excluded-dirs</code> build option</li> <li>Allow build data to add additional project dependencies for <code>wheel</code> and <code>sdist</code> build targets</li> <li>Add <code>force_include_editable</code> build data for the <code>wheel</code> build target</li> <li>Add <code>build_hooks</code> build data</li> <li>Add support for Mercurial's <code>.hgignore</code> files when using glob syntax</li> <li>Update project metadata to reflect the adoption by PyPA</li> </ul> <p>Fixed:</p> <ul> <li>Properly use underscores for the name of <code>force_include</code> build data</li> <li>No longer greedily skip excluded directories by default</li> </ul>"},{"location":"history/hatchling/#hatchling-v0.24.0","title":"0.24.0 - 2022-04-28","text":"<p>This is the initial public release of the Hatchling build system. Support for Python 2 will be dropped in version 1.</p>"},{"location":"how-to/config/dynamic-metadata/","title":"How to configure custom dynamic metadata","text":"<p>If you have project metadata that is not appropriate for static entry into <code>pyproject.toml</code> you will need to provide a custom metadata hook to apply such data during builds.</p> <p>Alternatives</p> <p>Dynamic metadata is a way to have a single source of truth that will be available at build time and at run time. Another way to achieve that is to enter the build data statically and then look up the same information dynamically in the program or package, using importlib.metadata.</p> <p>If the version field is the only metadata of concern, Hatchling provides a few built-in ways such as the <code>regex</code> version source and also third-party plugins. The approach here will also work, but is more complex.</p>"},{"location":"how-to/config/dynamic-metadata/#update-project-metadata","title":"Update project metadata","text":"<p>Change the <code>[project]</code> section of <code>pyproject.toml</code>:</p> <ol> <li>Define the dynamic field as an array of all the fields you will set dynamically e.g. <code>dynamic = [\"version\", \"license\", \"authors\", \"maintainers\"]</code></li> <li>If any of those fields have static definitions in <code>pyproject.toml</code>, delete those definitions. It is verboten to define a field statically and dynamically.</li> </ol> <p>Add a section to trigger loading of dynamic metadata plugins: <code>[tool.hatch.metadata.hooks.custom]</code>. Use exactly that name, regardless of the name of the class you will use or its <code>PLUGIN_NAME</code>. There doesn't need to be anything in the section.</p> <p>If your plugin requires additional third-party packages to do its work, add them to the <code>requires</code> array in the <code>[build-system]</code> section of <code>pyproject.toml</code>.</p>"},{"location":"how-to/config/dynamic-metadata/#implement-hook","title":"Implement hook","text":"<p>The dynamic lookup must happen in a custom plugin that you write. The default expectation is that it is in a <code>hatch_build.py</code> file at the root of the project. Subclass <code>MetadataHookInterface</code> and implement <code>update()</code>; for example, here's plugin that reads metadata from a JSON file:</p>  hatch_build.py <pre><code>import json\nimport os\n\nfrom hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\nclass JSONMetaDataHook(MetadataHookInterface):\n    def update(self, metadata):\n        src_file = os.path.join(self.root, \"gnumeric\", \".constants.json\")\n        with open(src_file) as src:\n            constants = json.load(src)\n            metadata[\"version\"] = constants[\"__version__\"]\n            metadata[\"license\"] = constants[\"__license__\"]\n            metadata[\"authors\"] = [\n                {\"name\": constants[\"__author__\"], \"email\": constants[\"__author_email__\"]},\n            ]\n</code></pre> <ol> <li>You must import the MetadataHookInterface to subclass it.</li> <li>Do your operations inside the <code>update</code> method.</li> <li><code>metadata</code> refers to project metadata.</li> <li>When writing to metadata, use <code>list</code> for TOML arrays. Note that if a list is expected, it is required even if there is a single element.</li> <li>Use <code>dict</code> for TOML tables e.g. <code>authors</code>.</li> </ol> <p>If you want to store the hook in a different location, set the <code>path</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata.hooks.custom]\npath = \"some/where.py\"\n</code></pre> <pre><code>[metadata.hooks.custom]\npath = \"some/where.py\"\n</code></pre>"},{"location":"how-to/environment/package-indices/","title":"How to configure package indices","text":"<p>Most Hatch environment types, like the default virtual, simply use pip to install dependencies. Therefore, you can use the standard environment variables that influence <code>pip</code>'s behavior to choose where to search for packages.</p> <p>Here's an example of setting up the default environment to look at 2 private indices (using context formatting for authentication) before finally falling back to PyPI:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default.env-vars]\nPIP_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group1_path&gt;/-/packages/pypi/simple/\"\nPIP_EXTRA_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group2_path&gt;/-/packages/pypi/simple/ https://pypi.org/simple/\"\n</code></pre> <pre><code>[envs.default.env-vars]\nPIP_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group1_path&gt;/-/packages/pypi/simple/\"\nPIP_EXTRA_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group2_path&gt;/-/packages/pypi/simple/ https://pypi.org/simple/\"\n</code></pre>"},{"location":"how-to/meta/report-issues/","title":"How to report issues","text":"<p>All reports regarding unexpected behavior should be generated with the <code>self report</code> command:</p> <pre><code>$ hatch self report\n</code></pre> <p>By default, this will open a new tab in your default browser with pre-populated information about your environment.</p> <p>If Hatch is not installed alongside a web browser, you may also pass the <code>--no-open</code>/<code>-n</code> command which will output the URL with correct parameters for copying elsewhere:</p> <pre><code>$ hatch self report -n\nhttps://github.com/pypa/hatch/issues/new?body=%23%23+Current+behavior%0A%3C%21--+A+clear+and+concise+description+of+the+behavior.+--%3E%0A%0A%23%23+Expected+behavior%0A%3C%21--+A+clear+and+concise+description+of+what+you+expected+to+happen.+--%3E%0A%0A%23%23+Additional+context%0A%3C%21--+Add+any+other+context+about+the+problem+here.+If+applicable%2C+add+screenshots+to+help+explain.+--%3E%0A%0A%23%23+Debug%0A%0A%23%23%23+Installation%0A%0A-+Source%3A+pip%0A-+Version%3A+1.9.2.dev5%0A-+Platform%3A+Windows%0A-+Python+version%3A%0A++++%60%60%60%0A++++3.11.1+%28tags%2Fv3.11.1%3Aa7a450f%2C+Dec++6+2022%2C+19%3A58%3A39%29+%5BMSC+v.1934+64+bit+%28AMD64%29%5D%0A++++%60%60%60%0A%0A%23%23%23+Configuration%0A%0A%60%60%60toml%0Amode+%3D+%22local%22%0Ashell+%3D+%22nu%22%0A%60%60%60%0A\n</code></pre>"},{"location":"how-to/plugins/testing-builds/","title":"Testing build plugins","text":"<p>For testing Hatchling plugins, you'll usually want to generate a project to execute builds as a real user would. For example, as a minimal pytest fixture:</p> <pre><code>from pathlib import Path\n\nimport pytest\n\n\n@pytest.fixture\ndef new_project(tmp_path):\n    project_dir = tmp_path / 'my-app'\n    project_dir.mkdir()\n\n    project_file = project_dir / 'pyproject.toml'\n    project_file.write_text(\n        f\"\"\"\\\n[build-system]\nrequires = [\"hatchling\", \"hatch-plugin-name @ {Path.cwd().as_uri()}\"]\nbuild-backend = \"hatchling.build\"\n\n[project]\nname = \"my-app\"\nversion = \"0.1.0\"\n\"\"\",\n        encoding='utf-8',\n    )\n    ...\n</code></pre> <p>The issue with this is that after the first test session, the project will be forever cached by pip based on the file path. Therefore, subsequent tests runs will never use updated code.</p> <p>To invalidate the cache, copy your code to a new path for every test session:</p> <pre><code>import shutil\nfrom pathlib import Path\nfrom tempfile import TemporaryDirectory\n\nimport pytest\n\n\n@pytest.fixture(scope='session')\ndef plugin_dir():\n    with TemporaryDirectory() as d:\n        directory = Path(d, 'plugin')\n        shutil.copytree(\n            Path.cwd(), directory, ignore=shutil.ignore_patterns('.git')\n        )\n\n        yield directory.resolve()\n\n\n@pytest.fixture\ndef new_project(tmp_path, plugin_dir):\n    project_dir = tmp_path / 'my-app'\n    project_dir.mkdir()\n\n    project_file = project_dir / 'pyproject.toml'\n    project_file.write_text(\n        f\"\"\"\\\n[build-system]\nrequires = [\"hatchling\", \"hatch-plugin-name @ {plugin_dir.as_uri()}\"]\nbuild-backend = \"hatchling.build\"\n\n[project]\nname = \"my-app\"\nversion = \"0.1.0\"\n\"\"\",\n        encoding='utf-8',\n    )\n    ...\n</code></pre> <p>Note</p> <p>This example chooses to ignore copying <code>.git</code> for performance reasons. You may want to ignore more patterns, or copy only specific paths like this plugin does.</p>"},{"location":"how-to/publish/auth/","title":"How to authenticate for index publishing","text":"<p>The username is derived from the following sources, in order of precedence:</p> <ol> <li>The  <code>--user</code> / <code>-u</code> cli option.</li> <li>The <code>HATCH_INDEX_USER</code> environment variable.</li> <li>The <code>repos</code> tables.</li> <li>The <code>~/.pypirc</code> file.</li> <li>The input to an interactive prompt.</li> </ol> <p>As a fallback the value <code>__token__</code> is applied.</p> <p>The password is looked up in these:</p> <ol> <li>The <code>~/.pypirc</code> file    if the username was provided by it.</li> <li>The <code>--auth</code> / <code>-a</code> cli option.</li> <li>The <code>HATCH_INDEX_AUTH</code> environment variable.</li> <li>The <code>repos</code> tables.</li> <li>A variety of OS-level credentials services backed by keyring.</li> <li>The input to an interactive prompt.</li> </ol> <p>If interactively provided credentials were used, the username will be stored in Hatch's cache and the password stored in the available keyring backed credentials stores.</p> <p>For automated releasing to PyPI, it is recommended to use \"Trusted Publishing\" with OIDC (e.g. PyPA's <code>pypi-publish</code> GitHub Action) or per-project API tokens.</p>"},{"location":"how-to/publish/repo/","title":"How to configure repositories for index publishing","text":"<p>You can select the repository with which to upload using the <code>-r</code>/<code>--repo</code> option or by setting the <code>HATCH_INDEX_REPO</code> environment variable.</p> <p>Rather than specifying the full URL of a repository, you can use a named repository from a <code>publish.index.repos</code> table defined in Hatch's config file:</p>  config.toml <pre><code>[publish.index.repos.private]\nurl = \"...\"\n...\n</code></pre> <p>The following repository names are reserved by Hatch and cannot be overridden:</p> Name Repository <code>main</code> https://upload.pypi.org/legacy/ <code>test</code> https://test.pypi.org/legacy/ <p>The <code>main</code> repository is used by default.</p>"},{"location":"how-to/static-analysis/behavior/","title":"Customize static analysis behavior","text":"<p>You can fully alter the static analysis performed by the <code>fmt</code> command by modifing the reserved environment named <code>hatch-static-analysis</code>. For example, you could define the following if you wanted to replace the default behavior with a mix of Black, isort and basic flake8:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\ndependencies = [\"black\", \"flake8\", \"isort\"]\n\n[tool.hatch.envs.hatch-static-analysis.scripts]\nformat-check = [\n  \"black --check --diff {args:.}\",\n  \"isort --check-only --diff {args:.}\",\n]\nformat-fix = [\n  \"isort {args:.}\",\n  \"black {args:.}\",\n]\nlint-check = \"flake8 {args:.}\"\nlint-fix = \"lint-check\"\n</code></pre> <pre><code>[envs.hatch-static-analysis]\ndependencies = [\"black\", \"flake8\", \"isort\"]\n\n[envs.hatch-static-analysis.scripts]\nformat-check = [\n  \"black --check --diff {args:.}\",\n  \"isort --check-only --diff {args:.}\",\n]\nformat-fix = [\n  \"isort {args:.}\",\n  \"black {args:.}\",\n]\nlint-check = \"flake8 {args:.}\"\nlint-fix = \"lint-check\"\n</code></pre> <p>The <code>format-*</code> scripts correspond to the <code>--formatter</code>/<code>-f</code> flag while the <code>lint-*</code> scripts correspond to the <code>--linter</code>/<code>-l</code> flag. The <code>*-fix</code> scripts run by default while the <code>*-check</code> scripts correspond to the <code>--check</code> flag. Based on this example, the following shows how the various scripts influence behavior:</p> Command Expanded scripts <code>hatch fmt</code> <ul><li><code>flake8 .</code></li><li><code>isort .</code></li><li><code>black .</code></li></ul> <code>hatch fmt src tests</code> <ul><li><code>flake8 src tests</code></li><li><code>isort src tests</code></li><li><code>black src tests</code></li></ul> <code>hatch fmt -f</code> <ul><li><code>isort .</code></li><li><code>black .</code></li></ul> <code>hatch fmt -l</code> <ul><li><code>flake8 .</code></li></ul> <code>hatch fmt --check</code> <ul><li><code>flake8 .</code></li><li><code>black --check --diff .</code></li><li><code>isort --check-only --diff .</code></li></ul> <code>hatch fmt --check -f</code> <ul><li><code>black --check --diff .</code></li><li><code>isort --check-only --diff .</code></li></ul> <code>hatch fmt --check -l</code> <ul><li><code>flake8 .</code></li></ul>"},{"location":"meta/authors/","title":"Authors","text":""},{"location":"meta/authors/#maintainers","title":"Maintainers","text":"<ul> <li>Ofek Lev  </li> </ul>"},{"location":"meta/authors/#contributors","title":"Contributors","text":"<ul> <li>Amjith Ramanujam </li> <li>Arnaud Crowther </li> <li>Chaojie  </li> <li>Chris Warrick </li> <li>Lum\u00edr 'Frenzy' Balhar  </li> <li>Ofek Lev  </li> <li>Olga Matoula  </li> <li>Philip Blair </li> <li>Robert Rosca </li> </ul>"},{"location":"meta/faq/","title":"FAQ","text":""},{"location":"meta/faq/#interoperability","title":"Interoperability","text":"<p>Q: What is the risk of lock-in?</p> <p>A: Not much! Other than the plugin system, everything uses Python's established standards by default. Project metadata is based entirely on the standard, the build system is compatible with PEP 517/PEP 660, versioning uses the scheme specified by PEP 440, dependencies are defined with PEP 508 strings, and environments use virtualenv.</p> <p>Q: Must one use all features?</p> <p>A: No, all features are optional! You can use just the build system, publish wheels and source distributions that were built by other tools, only use the environment management, etc.</p>"},{"location":"meta/faq/#libraries-vs-applications","title":"Libraries vs applications","text":"<p>Q: Are workflows for both libraries and applications supported?</p> <p>A: Yes, mostly! Applications can utilize environment management just like libraries, and plugins can be used to build projects in arbitrary formats or publish artifacts to arbitrary destinations.</p> <p>The only caveat is that currently there is no support for re-creating an environment given a set of dependencies in a reproducible manner. Although a standard lock file format may be far off since PEP 665 was rejected, resolving capabilities are coming to pip. When that is stabilized, Hatch will add locking functionality and dedicated documentation for managing applications.</p>"},{"location":"meta/faq/#tool-migration","title":"Tool migration","text":"<p>Q: How to migrate to Hatch?</p>"},{"location":"meta/faq/#build-system","title":"Build system","text":"SetuptoolsHatch  setup.py MANIFEST.in <pre><code>import os\nfrom io import open\n\nfrom setuptools import find_packages, setup\n\nabout = {}\nwith open(os.path.join('src', 'foo', '__about__.py'), 'r', 'utf-8') as f:\n    exec(f.read(), about)\n\nwith open('README.md', 'r', 'utf-8') as f:\n    readme = f.read()\n\nsetup(\n    # Metadata\n    name='foo',\n    version=about['__version__'],\n    description='...',\n    long_description=readme,\n    long_description_content_type='text/markdown',\n    author='...',\n    author_email='...',\n    project_urls={\n        'Documentation': '...',\n        'Source': '...',\n    },\n    classifiers=[\n        '...',\n    ],\n    keywords=[\n        '...',\n    ],\n    python_requires='&gt;=3.8',\n    install_requires=[\n        '...',\n    ],\n    extras_require={\n        'feature': ['...'],\n    },\n\n    # Packaging\n    packages=find_packages(where='src'),\n    package_dir={'': 'src'},\n    package_data={\n        'foo': ['py.typed'],\n    },\n    zip_safe=False,\n    entry_points={\n        'console_scripts': [\n            'foo = foo.cli:main',\n        ],\n    },\n)\n</code></pre> <pre><code>graft tests\n\nglobal-exclude *.py[cod] __pycache__\n</code></pre>  pyproject.toml <pre><code>[build-system]\nrequires = [\"hatchling\"]\nbuild-backend = \"hatchling.build\"\n\n[project]\nname = \"foo\"\ndescription = \"...\"\nreadme = \"README.md\"\nauthors = [\n  { name = \"...\", email = \"...\" },\n]\nclassifiers = [\n  \"...\",\n]\nkeywords = [\n  \"...\",\n]\nrequires-python = \"&gt;=3.8\"\ndependencies = [\n  \"...\",\n]\ndynamic = [\"version\"]\n\n[project.urls]\nDocumentation = \"...\"\nSource = \"...\"\n\n[project.optional-dependencies]\nfeature = [\"...\"]\n\n[project.scripts]\nfoo = \"foo.cli:main\"\n\n[tool.hatch.version]\npath = \"src/foo/__about__.py\"\n\n[tool.hatch.build.targets.sdist]\ninclude = [\n  \"/src\",\n  \"/tests\",\n]\n</code></pre>"},{"location":"meta/faq/#environments","title":"Environments","text":"ToxHatch <p>Invocation:</p> <pre><code>tox\n</code></pre>  tox.ini <pre><code>[tox]\nenvlist =\n    py{27,38}-{42,3.14}\n    py{38,39}-{9000}-{foo,bar}\n\n[testenv]\nusedevelop = true\ndeps =\n    coverage[toml]\n    pytest\n    pytest-cov\n    foo: cryptography\ncommands =\n    pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests {posargs}\nsetenv =\n    3.14: PRODUCT_VERSION=3.14\n    42: PRODUCT_VERSION=42\n    9000: PRODUCT_VERSION=9000\n    {foo,bar}: EXPERIMENTAL=true\n</code></pre> <p>Invocation:</p> <pre><code>hatch run test\n</code></pre>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[tool.hatch.envs.default.scripts]\ntest = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[tool.hatch.envs.default.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.features.env-vars = \"EXPERIMENTAL=true\"\nmatrix.features.dependencies = [\n  { value = \"cryptography\", if = [\"foo\"] },\n]\n\n[[tool.hatch.envs.default.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[tool.hatch.envs.default.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[envs.default.scripts]\ntest = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[envs.default.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.features.env-vars = \"EXPERIMENTAL=true\"\nmatrix.features.dependencies = [\n  { value = \"cryptography\", if = [\"foo\"] },\n]\n\n[[envs.default.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[envs.default.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre>"},{"location":"meta/faq/#fast-cli","title":"Fast CLI?","text":"<p>The claim about being faster than other tools is based on timings that are always checked in CI.</p> <p>Hatch achieves this by using lazy imports, lazily performing computation manually and with functools.cached_property, using hacks like <code>not not ...</code> instead of <code>bool(...)</code>, etc.</p>"},{"location":"plugins/about/","title":"Plugins","text":"<p>Hatch utilizes pluggy for its plugin functionality.</p>"},{"location":"plugins/about/#overview","title":"Overview","text":"<p>All plugins provide registration hooks that return one or more classes that inherit from a particular type interface.</p> <p>Each registration hook must be decorated by Hatch's hook marker. For example, if you wanted to create a new kind of environment you could do:</p>  hooks.py <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialEnvironment\n\n\n@hookimpl\ndef hatch_register_environment():\n    return SpecialEnvironment\n</code></pre> <p>The hooks can return a single class or a list of classes.</p> <p>Every class must define an attribute called <code>PLUGIN_NAME</code> that users will select when they wish to use the plugin. So in the example above, the class might be defined like:</p>  plugin.py <pre><code>...\nclass SpecialEnvironment(...):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre>"},{"location":"plugins/about/#project-configuration","title":"Project configuration","text":""},{"location":"plugins/about/#naming","title":"Naming","text":"<p>It is recommended that plugin project names are prefixed with <code>hatch-</code>. For example, if you wanted to make a plugin that provides some functionality for a product named <code>foo</code> you might do:</p>  pyproject.toml <pre><code>[project]\nname = \"hatch-foo\"\n</code></pre>"},{"location":"plugins/about/#discovery","title":"Discovery","text":"<p>You'll need to define your project as a Python plugin for Hatch:</p>  pyproject.toml <pre><code>[project.entry-points.hatch]\nfoo = \"pkg.hooks\"\n</code></pre> <p>The name of the plugin should be the project name (excluding any <code>hatch-</code> prefix) and the path should represent the module that contains the registration hooks.</p>"},{"location":"plugins/about/#classifier","title":"Classifier","text":"<p>Add <code>Framework :: Hatch</code> to your project's classifiers to make it easy to search for Hatch plugins:</p>  pyproject.toml <pre><code>[project]\nclassifiers = [\n  ...\n  \"Framework :: Hatch\",\n  ...\n]\n</code></pre>"},{"location":"plugins/about/#types","title":"Types","text":""},{"location":"plugins/about/#hatchling","title":"Hatchling","text":"<p>These are all involved in building projects and therefore any defined dependencies are automatically installed in each build environment.</p> <ul> <li>Builder</li> <li>Build hook</li> <li>Metadata hook</li> <li>Version source</li> <li>Version scheme</li> </ul>"},{"location":"plugins/about/#hatch","title":"Hatch","text":"<p>These must be installed in the same environment as Hatch itself.</p> <ul> <li>Environment</li> <li>Environment collector</li> <li>Publisher</li> </ul>"},{"location":"plugins/utilities/","title":"Plugin utilities","text":""},{"location":"plugins/utilities/#hatchling.builders.utils.get_reproducible_timestamp","title":"<code>hatchling.builders.utils.get_reproducible_timestamp() -&gt; int</code>","text":"<p>Returns an <code>int</code> derived from the <code>SOURCE_DATE_EPOCH</code> environment variable; see https://reproducible-builds.org/specs/source-date-epoch/.</p> <p>The default value will always be: <code>1580601600</code></p> Source code in <code>backend/src/hatchling/builders/utils.py</code> <pre><code>def get_reproducible_timestamp() -&gt; int:\n    \"\"\"\n    Returns an `int` derived from the `SOURCE_DATE_EPOCH` environment variable; see\n    https://reproducible-builds.org/specs/source-date-epoch/.\n\n    The default value will always be: `1580601600`\n    \"\"\"\n    return int(os.environ.get('SOURCE_DATE_EPOCH', '1580601600'))\n</code></pre>"},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig","title":"<code>BuilderConfig</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.directory","title":"<code>directory: str</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.ignore_vcs","title":"<code>ignore_vcs: bool</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.reproducible","title":"<code>reproducible: bool</code>  <code>property</code>","text":"<p>Whether or not the target should be built in a reproducible manner, defaulting to true.</p>"},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.dev_mode_dirs","title":"<code>dev_mode_dirs: list[str]</code>  <code>property</code>","text":"<p>Directories which must be added to Python's search path in dev mode.</p>"},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.versions","title":"<code>versions: list[str]</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.dependencies","title":"<code>dependencies: list[str]</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_include","title":"<code>default_include() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_exclude","title":"<code>default_exclude() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_packages","title":"<code>default_packages() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_only_include","title":"<code>default_only_include() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.bridge.app.Application","title":"<code>Application</code>","text":"<p>The way output is displayed can be configured by users.</p> <p>Important</p> <p>Never import this directly; Hatch judiciously decides if a type of plugin requires the capabilities herein and will grant access via an attribute.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.verbosity","title":"<code>verbosity: int</code>  <code>property</code>","text":"<p>The verbosity level of the application, with 0 as the default.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.abort","title":"<code>abort(message: str = '', code: int = 1, **kwargs: Any) -&gt; None</code>","text":"<p>Terminate the program with the given return code.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_debug","title":"<code>display_debug(message: str = '', level: int = 1, **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages that are not useful for most user experiences. The <code>level</code> option must be between 1 and 3 (inclusive).</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_error","title":"<code>display_error(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages indicating some unrecoverable error.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_info","title":"<code>display_info(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages conveying basic information.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_success","title":"<code>display_success(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages indicating some positive outcome.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_waiting","title":"<code>display_waiting(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages shown before potentially time consuming operations.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_warning","title":"<code>display_warning(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages conveying important information.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform","title":"<code>Platform</code>","text":""},{"location":"plugins/utilities/#hatch.utils.platform.Platform.default_shell","title":"<code>default_shell: str</code>  <code>property</code>","text":"<p>Returns the default shell of the system.</p> <p>On Windows systems first try the <code>SHELL</code> environment variable, if present, followed by the <code>COMSPEC</code> environment variable, defaulting to <code>cmd</code>. On all other platforms only the <code>SHELL</code> environment variable will be used, defaulting to <code>bash</code>.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.modules","title":"<code>modules: LazilyLoadedModules</code>  <code>property</code>","text":"<p>Accessor for lazily loading modules that either take multiple milliseconds to import (like <code>shutil</code> and <code>subprocess</code>) or are not used on all platforms (like <code>shlex</code>).</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.home","title":"<code>home: Path</code>  <code>property</code>","text":"<p>The user's home directory as a path-like object.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.name","title":"<code>name: str</code>  <code>property</code>","text":"<p>One of the following:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.display_name","title":"<code>display_name: str</code>  <code>property</code>","text":"<p>One of the following:</p> <ul> <li><code>Linux</code></li> <li><code>Windows</code></li> <li><code>macOS</code></li> </ul>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.windows","title":"<code>windows: bool</code>  <code>property</code>","text":"<p>Indicates whether Hatch is running on Windows.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.macos","title":"<code>macos: bool</code>  <code>property</code>","text":"<p>Indicates whether Hatch is running on macOS.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.linux","title":"<code>linux: bool</code>  <code>property</code>","text":"<p>Indicates whether Hatch is running on neither Windows nor macOS.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.format_for_subprocess","title":"<code>format_for_subprocess(command: str | list[str], *, shell: bool) -&gt; str | list[str]</code>","text":"<p>Format the given command in a cross-platform manner for immediate consumption by subprocess utilities.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.run_command","title":"<code>run_command(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; CompletedProcess</code>","text":"<p>Equivalent to the standard library's subprocess.run, with the command first being properly formatted.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.check_command","title":"<code>check_command(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; CompletedProcess</code>","text":"<p>Equivalent to run_command, but non-zero exit codes will gracefully end program execution.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.check_command_output","title":"<code>check_command_output(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; str</code>","text":"<p>Equivalent to the output from the process returned by capture_process, but non-zero exit codes will gracefully end program execution.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.capture_process","title":"<code>capture_process(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; Popen</code>","text":"<p>Equivalent to the standard library's subprocess.Popen, with all output captured by <code>stdout</code> and the command first being properly formatted.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.exit_with_command","title":"<code>exit_with_command(command: list[str]) -&gt; None</code>","text":"<p>Run the given command and exit with its exit code. On non-Windows systems, this uses the standard library's os.execvp.</p>"},{"location":"plugins/utilities/#hatch.env.context.EnvironmentContextFormatter","title":"<code>EnvironmentContextFormatter</code>","text":""},{"location":"plugins/utilities/#hatch.env.context.EnvironmentContextFormatter.formatters","title":"<code>formatters()</code>","text":"<p>This returns a mapping of supported field names to their respective formatting functions. Each function accepts 2 arguments:</p> <ul> <li>the <code>value</code> that was passed to the format call, defaulting to <code>None</code></li> <li>the modifier <code>data</code>, defaulting to an empty string</li> </ul>"},{"location":"plugins/build-hook/custom/","title":"Custom build hook","text":"<p>This is a custom class in a given Python file that inherits from the BuildHookInterface.</p>"},{"location":"plugins/build-hook/custom/#configuration","title":"Configuration","text":"<p>The build hook plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.custom]\n[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.custom]\n</code></pre> <pre><code>[build.hooks.custom]\n[build.targets.&lt;TARGET_NAME&gt;.hooks.custom]\n</code></pre>"},{"location":"plugins/build-hook/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_build.py</code> The path of the Python file"},{"location":"plugins/build-hook/custom/#example","title":"Example","text":"hatch_build.py <pre><code>from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\nclass CustomBuildHook(BuildHookInterface):\n    ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_build_hook</code> that returns the desired build hook.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/build-hook/reference/","title":"Build hook plugins","text":"<p>A build hook provides code that will be executed at various stages of the build process. See the documentation for build hook configuration.</p>"},{"location":"plugins/build-hook/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-autorun - used to inject code into an installation that will automatically run before the first import</li> <li>hatch-build-scripts - run arbitrary shell commands that create artifacts</li> <li>hatch-jupyter-builder - used for packages in the Project Jupyter ecosystem</li> <li>hatch-mypyc - compiles code with Mypyc</li> <li>hatch-odoo - package Odoo add-ons into the appropriate namespace</li> </ul>"},{"location":"plugins/build-hook/reference/#overview","title":"Overview","text":"<p>Build hooks run for every selected version of build targets.</p> <p>The initialization stage occurs immediately before each build and the finalization stage occurs immediately after. Each stage has the opportunity to view or modify build data.</p>"},{"location":"plugins/build-hook/reference/#build-data","title":"Build data","text":"<p>Build data is a simple mapping whose contents can influence the behavior of builds. Which fields exist and are recognized depends on each build target.</p> <p>The following fields are always present and recognized by the build system itself:</p> Field Type Description <code>artifacts</code> <code>list[str]</code> This is a list of extra <code>artifact</code> patterns and should generally only be appended to <code>force_include</code> <code>dict[str, str]</code> This is a mapping of extra forced inclusion paths, with this mapping taking precedence in case of conflicts <code>build_hooks</code> <code>tuple[str, ...]</code> This is an immutable sequence of the names of the configured build hooks and matches the order in which they run <p>Attention</p> <p>While user-facing TOML options are hyphenated, build data fields should be named with underscores to allow plugins to use them as valid Python identifiers.</p>"},{"location":"plugins/build-hook/reference/#notes","title":"Notes","text":"<p>In some cases it may be necessary to use <code>force_include</code> rather than <code>artifacts</code>. For example, say that you want to install a <code>lib.so</code> directly at the root of <code>site-packages</code> and a project defines a package <code>src/foo</code>. If you create <code>src/lib.so</code>, there will never be a match because the directory traversal starts at <code>src/foo</code> rather than <code>src</code>. In that case you must do either:</p> <pre><code>build_data['force_include']['src/lib.so'] = 'src/lib.so'\n</code></pre> <p>or</p> <pre><code>build_data['force_include']['/absolute/path/to/src/lib.so'] = 'src/lib.so'\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface","title":"<code>BuildHookInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\nclass SpecialBuildHook(BuildHookInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialBuildHook\n\n\n@hookimpl\ndef hatch_register_build_hook():\n    return SpecialBuildHook\n</code></pre> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>class BuildHookInterface(Generic[BuilderConfigBound]):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\n    class SpecialBuildHook(BuildHookInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialBuildHook\n\n\n    @hookimpl\n    def hatch_register_build_hook():\n        return SpecialBuildHook\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(\n        self,\n        root: str,\n        config: dict[str, Any],\n        build_config: BuilderConfigBound,\n        metadata: ProjectMetadata,\n        directory: str,\n        target_name: str,\n        app: Application | None = None,\n    ) -&gt; None:\n        self.__root = root\n        self.__config = config\n        self.__build_config = build_config\n        self.__metadata = metadata\n        self.__directory = directory\n        self.__target_name = target_name\n        self.__app = app\n\n    @property\n    def app(self) -&gt; Application:\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        if self.__app is None:\n            from hatchling.bridge.app import Application\n\n            self.__app = cast(Application, Application().get_safe_application())\n\n        return self.__app\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict[str, Any]:\n        \"\"\"\n        The cumulative hook configuration.\n\n        ```toml config-example\n        [tool.hatch.build.hooks.&lt;PLUGIN_NAME&gt;]\n        [tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    @property\n    def metadata(self) -&gt; ProjectMetadata:\n        # Undocumented for now\n        return self.__metadata\n\n    @property\n    def build_config(self) -&gt; BuilderConfigBound:\n        \"\"\"\n        An instance of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n        \"\"\"\n        return self.__build_config\n\n    @property\n    def directory(self) -&gt; str:\n        \"\"\"\n        The build directory.\n        \"\"\"\n        return self.__directory\n\n    @property\n    def target_name(self) -&gt; str:\n        \"\"\"\n        The plugin name of the build target.\n        \"\"\"\n        return self.__target_name\n\n    def dependencies(self) -&gt; list[str]:  # noqa: PLR6301\n        \"\"\"\n        A list of extra [dependencies](../../config/dependency.md) that must be installed\n        prior to builds.\n\n        !!! warning\n            - For this to have any effect the hook dependency itself cannot be dynamic and\n                must always be defined in `build-system.requires`.\n            - As the hook must be imported to call this method, imports that require these\n                dependencies must be evaluated lazily.\n        \"\"\"\n        return []\n\n    def clean(self, versions: list[str]) -&gt; None:\n        \"\"\"\n        This occurs before the build process if the `-c`/`--clean` flag was passed to\n        the [`build`](../../cli/reference.md#hatch-build) command, or when invoking\n        the [`clean`](../../cli/reference.md#hatch-clean) command.\n        \"\"\"\n\n    def initialize(self, version: str, build_data: dict[str, Any]) -&gt; None:\n        \"\"\"\n        This occurs immediately before each build.\n\n        Any modifications to the build data will be seen by the build target.\n        \"\"\"\n\n    def finalize(self, version: str, build_data: dict[str, Any], artifact_path: str) -&gt; None:\n        \"\"\"\n        This occurs immediately after each build and will not run if the `--hooks-only` flag\n        was passed to the [`build`](../../cli/reference.md#hatch-build) command.\n\n        The build data will reflect any modifications done by the target during the build.\n        \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.app","title":"<code>app: Application</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.config","title":"<code>config: dict[str, Any]</code>  <code>property</code>","text":"<p>The cumulative hook configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.&lt;PLUGIN_NAME&gt;]\n[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[build.hooks.&lt;PLUGIN_NAME&gt;]\n[build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.build_config","title":"<code>build_config: BuilderConfigBound</code>  <code>property</code>","text":"<p>An instance of BuilderConfig.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.target_name","title":"<code>target_name: str</code>  <code>property</code>","text":"<p>The plugin name of the build target.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.directory","title":"<code>directory: str</code>  <code>property</code>","text":"<p>The build directory.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.dependencies","title":"<code>dependencies() -&gt; list[str]</code>","text":"<p>A list of extra dependencies that must be installed prior to builds.</p> <p>Warning</p> <ul> <li>For this to have any effect the hook dependency itself cannot be dynamic and     must always be defined in <code>build-system.requires</code>.</li> <li>As the hook must be imported to call this method, imports that require these     dependencies must be evaluated lazily.</li> </ul> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def dependencies(self) -&gt; list[str]:  # noqa: PLR6301\n    \"\"\"\n    A list of extra [dependencies](../../config/dependency.md) that must be installed\n    prior to builds.\n\n    !!! warning\n        - For this to have any effect the hook dependency itself cannot be dynamic and\n            must always be defined in `build-system.requires`.\n        - As the hook must be imported to call this method, imports that require these\n            dependencies must be evaluated lazily.\n    \"\"\"\n    return []\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.clean","title":"<code>clean(versions: list[str]) -&gt; None</code>","text":"<p>This occurs before the build process if the <code>-c</code>/<code>--clean</code> flag was passed to the <code>build</code> command, or when invoking the <code>clean</code> command.</p> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def clean(self, versions: list[str]) -&gt; None:\n    \"\"\"\n    This occurs before the build process if the `-c`/`--clean` flag was passed to\n    the [`build`](../../cli/reference.md#hatch-build) command, or when invoking\n    the [`clean`](../../cli/reference.md#hatch-clean) command.\n    \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.initialize","title":"<code>initialize(version: str, build_data: dict[str, Any]) -&gt; None</code>","text":"<p>This occurs immediately before each build.</p> <p>Any modifications to the build data will be seen by the build target.</p> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def initialize(self, version: str, build_data: dict[str, Any]) -&gt; None:\n    \"\"\"\n    This occurs immediately before each build.\n\n    Any modifications to the build data will be seen by the build target.\n    \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.finalize","title":"<code>finalize(version: str, build_data: dict[str, Any], artifact_path: str) -&gt; None</code>","text":"<p>This occurs immediately after each build and will not run if the <code>--hooks-only</code> flag was passed to the <code>build</code> command.</p> <p>The build data will reflect any modifications done by the target during the build.</p> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def finalize(self, version: str, build_data: dict[str, Any], artifact_path: str) -&gt; None:\n    \"\"\"\n    This occurs immediately after each build and will not run if the `--hooks-only` flag\n    was passed to the [`build`](../../cli/reference.md#hatch-build) command.\n\n    The build data will reflect any modifications done by the target during the build.\n    \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/version/","title":"Version build hook","text":"<p>This writes the project's version to a file.</p>"},{"location":"plugins/build-hook/version/#configuration","title":"Configuration","text":"<p>The build hook plugin name is <code>version</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.version]\n[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.version]\n</code></pre> <pre><code>[build.hooks.version]\n[build.targets.&lt;TARGET_NAME&gt;.hooks.version]\n</code></pre>"},{"location":"plugins/build-hook/version/#options","title":"Options","text":"Option Description <code>path</code> (required) A relative path to the desired file <code>template</code> A string representing the entire contents of <code>path</code> that will be formatted with a <code>version</code> variable <code>pattern</code> Rather than updating the entire file, a regular expression may be used that has a named group called <code>version</code> that represents the version. If set to <code>true</code>, a pattern will be used that looks for a variable named <code>__version__</code> or <code>VERSION</code> that is set to a string containing the version, optionally prefixed with the lowercase letter <code>v</code>."},{"location":"plugins/builder/binary/","title":"Binary builder","text":"<p>This uses PyApp to build an application that is able to bootstrap itself at runtime.</p> <p>Note</p> <p>This requires an installation of Rust.</p>"},{"location":"plugins/builder/binary/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>binary</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.binary]\n</code></pre> <pre><code>[build.targets.binary]\n</code></pre>"},{"location":"plugins/builder/binary/#options","title":"Options","text":"Option Default Description <code>scripts</code> all defined An array of defined script names to limit what gets built <code>python-version</code> latest compatible Python minor version The Python version ID to use <code>pyapp-version</code> The version of PyApp to use"},{"location":"plugins/builder/binary/#build-behavior","title":"Build behavior","text":"<p>If any scripts are defined then each one will be built (limited by the <code>scripts</code> option). Otherwise, a single executable will be built based on the project name assuming there is an equivalently named module with a <code>__main__.py</code> file.</p> <p>Every executable will be built inside an <code>app</code> directory in the output directory.</p> <p>If the <code>CARGO</code> environment variable is set then that path will be used as the executable for performing builds.</p> <p>If the <code>CARGO_BUILD_TARGET</code> environment variable is set then its value will be appended to the file name stems.</p> <p>If the <code>PYAPP_REPO</code> environment variable is set then a local build will be performed inside that directory rather than installing from crates.io. Note that this is required if the <code>CARGO</code> environment variable refers to cross.</p>"},{"location":"plugins/builder/custom/","title":"Custom builder","text":"<p>This is a custom class in a given Python file that inherits from the BuilderInterface.</p>"},{"location":"plugins/builder/custom/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.custom]\n</code></pre> <pre><code>[build.targets.custom]\n</code></pre>"},{"location":"plugins/builder/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_build.py</code> The path of the Python file"},{"location":"plugins/builder/custom/#example","title":"Example","text":"hatch_build.py <pre><code>from hatchling.builders.plugin.interface import BuilderInterface\n\n\nclass CustomBuilder(BuilderInterface):\n    ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_builder</code> that returns the desired builder.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/builder/reference/","title":"Builder plugins","text":"<p>See the documentation for build configuration.</p>"},{"location":"plugins/builder/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-aws - used for building AWS Lambda functions with SAM</li> <li>hatch-zipped-directory - used for building ZIP archives for installation into various foreign package installation systems</li> </ul>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface","title":"<code>BuilderInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.builders.plugin.interface import BuilderInterface\n\n\nclass SpecialBuilder(BuilderInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialBuilder\n\n\n@hookimpl\ndef hatch_register_builder():\n    return SpecialBuilder\n</code></pre> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>class BuilderInterface(ABC, Generic[BuilderConfigBound, PluginManagerBound]):\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.builders.plugin.interface import BuilderInterface\n\n\n    class SpecialBuilder(BuilderInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialBuilder\n\n\n    @hookimpl\n    def hatch_register_builder():\n        return SpecialBuilder\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(\n        self,\n        root: str,\n        plugin_manager: PluginManagerBound | None = None,\n        config: dict[str, Any] | None = None,\n        metadata: ProjectMetadata | None = None,\n        app: Application | None = None,\n    ) -&gt; None:\n        self.__root = root\n        self.__plugin_manager = cast(PluginManagerBound, plugin_manager)\n        self.__raw_config = config\n        self.__metadata = metadata\n        self.__app = app\n        self.__config = cast(BuilderConfigBound, None)\n        self.__project_config: dict[str, Any] | None = None\n        self.__hatch_config: dict[str, Any] | None = None\n        self.__build_config: dict[str, Any] | None = None\n        self.__build_targets: list[str] | None = None\n        self.__target_config: dict[str, Any] | None = None\n\n        # Metadata\n        self.__project_id: str | None = None\n\n    def build(\n        self,\n        *,\n        directory: str | None = None,\n        versions: list[str] | None = None,\n        hooks_only: bool | None = None,\n        clean: bool | None = None,\n        clean_hooks_after: bool | None = None,\n        clean_only: bool | None = False,\n    ) -&gt; Generator[str, None, None]:\n        # Fail early for invalid project metadata\n        self.metadata.validate_fields()\n\n        if directory is None:\n            directory = (\n                self.config.normalize_build_directory(os.environ[BuildEnvVars.LOCATION])\n                if BuildEnvVars.LOCATION in os.environ\n                else self.config.directory\n            )\n\n        if not os.path.isdir(directory):\n            os.makedirs(directory)\n\n        version_api = self.get_version_api()\n\n        versions = versions or self.config.versions\n        if versions:\n            unknown_versions = set(versions) - set(version_api)\n            if unknown_versions:\n                message = (\n                    f'Unknown versions for target `{self.PLUGIN_NAME}`: {\", \".join(map(str, sorted(unknown_versions)))}'\n                )\n                raise ValueError(message)\n\n        if hooks_only is None:\n            hooks_only = env_var_enabled(BuildEnvVars.HOOKS_ONLY)\n\n        configured_build_hooks = self.get_build_hooks(directory)\n        build_hooks = list(configured_build_hooks.values())\n\n        if clean_only:\n            clean = True\n        elif clean is None:\n            clean = env_var_enabled(BuildEnvVars.CLEAN)\n        if clean:\n            if not hooks_only:\n                self.clean(directory, versions)\n\n            for build_hook in build_hooks:\n                build_hook.clean(versions)\n\n            if clean_only:\n                return\n\n        if clean_hooks_after is None:\n            clean_hooks_after = env_var_enabled(BuildEnvVars.CLEAN_HOOKS_AFTER)\n\n        for version in versions:\n            self.app.display_debug(f'Building `{self.PLUGIN_NAME}` version `{version}`')\n\n            build_data = self.get_default_build_data()\n            self.set_build_data_defaults(build_data)\n\n            # Allow inspection of configured build hooks and the order in which they run\n            build_data['build_hooks'] = tuple(configured_build_hooks)\n\n            # Execute all `initialize` build hooks\n            for build_hook in build_hooks:\n                build_hook.initialize(version, build_data)\n\n            if hooks_only:\n                self.app.display_debug(f'Only ran build hooks for `{self.PLUGIN_NAME}` version `{version}`')\n                continue\n\n            # Build the artifact\n            with self.config.set_build_data(build_data):\n                artifact = version_api[version](directory, **build_data)\n\n            # Execute all `finalize` build hooks\n            for build_hook in build_hooks:\n                build_hook.finalize(version, build_data, artifact)\n\n            if clean_hooks_after:\n                for build_hook in build_hooks:\n                    build_hook.clean([version])\n\n            yield artifact\n\n    def recurse_included_files(self) -&gt; Iterable[IncludedFile]:\n        \"\"\"\n        Returns a consistently generated series of file objects for every file that should be distributed. Each file\n        object has three `str` attributes:\n\n        - `path` - the absolute path\n        - `relative_path` - the path relative to the project root; will be an empty string for external files\n        - `distribution_path` - the path to be distributed as\n        \"\"\"\n        yield from self.recurse_selected_project_files()\n        yield from self.recurse_forced_files(self.config.get_force_include())\n\n    def recurse_selected_project_files(self) -&gt; Iterable[IncludedFile]:\n        if self.config.only_include:\n            yield from self.recurse_explicit_files(self.config.only_include)\n        else:\n            yield from self.recurse_project_files()\n\n    def recurse_project_files(self) -&gt; Iterable[IncludedFile]:\n        for root, dirs, files in safe_walk(self.root):\n            relative_path = get_relative_path(root, self.root)\n\n            dirs[:] = sorted(d for d in dirs if not self.config.directory_is_excluded(d, relative_path))\n\n            files.sort()\n            is_package = '__init__.py' in files\n            for f in files:\n                if f in EXCLUDED_FILES:\n                    continue\n\n                relative_file_path = os.path.join(relative_path, f)\n                distribution_path = self.config.get_distribution_path(relative_file_path)\n                if self.config.path_is_reserved(distribution_path):\n                    continue\n\n                if self.config.include_path(relative_file_path, is_package=is_package):\n                    yield IncludedFile(\n                        os.path.join(root, f), relative_file_path, self.config.get_distribution_path(relative_file_path)\n                    )\n\n    def recurse_forced_files(self, inclusion_map: dict[str, str]) -&gt; Iterable[IncludedFile]:\n        for source, target_path in inclusion_map.items():\n            external = not source.startswith(self.root)\n            if os.path.isfile(source):\n                yield IncludedFile(\n                    source,\n                    '' if external else os.path.relpath(source, self.root),\n                    self.config.get_distribution_path(target_path),\n                )\n            elif os.path.isdir(source):\n                for root, dirs, files in safe_walk(source):\n                    relative_directory = get_relative_path(root, source)\n\n                    dirs[:] = sorted(d for d in dirs if d not in EXCLUDED_DIRECTORIES)\n\n                    files.sort()\n                    for f in files:\n                        if f in EXCLUDED_FILES:\n                            continue\n\n                        relative_file_path = os.path.join(target_path, relative_directory, f)\n                        distribution_path = self.config.get_distribution_path(relative_file_path)\n                        if not self.config.path_is_reserved(distribution_path):\n                            yield IncludedFile(\n                                os.path.join(root, f),\n                                '' if external else relative_file_path,\n                                distribution_path,\n                            )\n            else:\n                msg = f'Forced include not found: {source}'\n                raise FileNotFoundError(msg)\n\n    def recurse_explicit_files(self, inclusion_map: dict[str, str]) -&gt; Iterable[IncludedFile]:\n        for source, target_path in inclusion_map.items():\n            external = not source.startswith(self.root)\n            if os.path.isfile(source):\n                distribution_path = self.config.get_distribution_path(target_path)\n                if not self.config.path_is_reserved(distribution_path):\n                    yield IncludedFile(\n                        source,\n                        '' if external else os.path.relpath(source, self.root),\n                        self.config.get_distribution_path(target_path),\n                    )\n            elif os.path.isdir(source):\n                for root, dirs, files in safe_walk(source):\n                    relative_directory = get_relative_path(root, source)\n\n                    dirs[:] = sorted(d for d in dirs if d not in EXCLUDED_DIRECTORIES)\n\n                    files.sort()\n                    is_package = '__init__.py' in files\n                    for f in files:\n                        if f in EXCLUDED_FILES:\n                            continue\n\n                        relative_file_path = os.path.join(target_path, relative_directory, f)\n                        distribution_path = self.config.get_distribution_path(relative_file_path)\n                        if self.config.path_is_reserved(distribution_path):\n                            continue\n\n                        if self.config.include_path(relative_file_path, explicit=True, is_package=is_package):\n                            yield IncludedFile(\n                                os.path.join(root, f), '' if external else relative_file_path, distribution_path\n                            )\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree.\n        \"\"\"\n        return self.__root\n\n    @property\n    def plugin_manager(self) -&gt; PluginManagerBound:\n        if self.__plugin_manager is None:\n            from hatchling.plugin.manager import PluginManager\n\n            self.__plugin_manager = PluginManager()\n\n        return self.__plugin_manager\n\n    @property\n    def metadata(self) -&gt; ProjectMetadata:\n        if self.__metadata is None:\n            from hatchling.metadata.core import ProjectMetadata\n\n            self.__metadata = ProjectMetadata(self.root, self.plugin_manager, self.__raw_config)\n\n        return self.__metadata\n\n    @property\n    def app(self) -&gt; Application:\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        if self.__app is None:\n            from hatchling.bridge.app import Application\n\n            self.__app = cast(Application, Application().get_safe_application())\n\n        return self.__app\n\n    @property\n    def raw_config(self) -&gt; dict[str, Any]:\n        if self.__raw_config is None:\n            self.__raw_config = self.metadata.config\n\n        return self.__raw_config\n\n    @property\n    def project_config(self) -&gt; dict[str, Any]:\n        if self.__project_config is None:\n            self.__project_config = self.metadata.core.config\n\n        return self.__project_config\n\n    @property\n    def hatch_config(self) -&gt; dict[str, Any]:\n        if self.__hatch_config is None:\n            self.__hatch_config = self.metadata.hatch.config\n\n        return self.__hatch_config\n\n    @property\n    def config(self) -&gt; BuilderConfigBound:\n        \"\"\"\n        An instance of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n        \"\"\"\n        if self.__config is None:\n            self.__config = self.get_config_class()(\n                self, self.root, self.PLUGIN_NAME, self.build_config, self.target_config\n            )\n\n        return self.__config\n\n    @property\n    def build_config(self) -&gt; dict[str, Any]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.build]\n        ```\n        \"\"\"\n        if self.__build_config is None:\n            self.__build_config = self.metadata.hatch.build_config\n\n        return self.__build_config\n\n    @property\n    def target_config(self) -&gt; dict[str, Any]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.build.targets.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        if self.__target_config is None:\n            target_config: dict[str, Any] = self.metadata.hatch.build_targets.get(self.PLUGIN_NAME, {})\n            if not isinstance(target_config, dict):\n                message = f'Field `tool.hatch.build.targets.{self.PLUGIN_NAME}` must be a table'\n                raise TypeError(message)\n\n            self.__target_config = target_config\n\n        return self.__target_config\n\n    @property\n    def project_id(self) -&gt; str:\n        if self.__project_id is None:\n            self.__project_id = f'{self.normalize_file_name_component(self.metadata.core.name)}-{self.metadata.version}'\n\n        return self.__project_id\n\n    def get_build_hooks(self, directory: str) -&gt; dict[str, BuildHookInterface]:\n        configured_build_hooks = {}\n        for hook_name, config in self.config.hook_config.items():\n            build_hook = self.plugin_manager.build_hook.get(hook_name)\n            if build_hook is None:\n                from hatchling.plugin.exceptions import UnknownPluginError\n\n                message = f'Unknown build hook: {hook_name}'\n                raise UnknownPluginError(message)\n\n            configured_build_hooks[hook_name] = build_hook(\n                self.root, config, self.config, self.metadata, directory, self.PLUGIN_NAME, self.app\n            )\n\n        return configured_build_hooks\n\n    @abstractmethod\n    def get_version_api(self) -&gt; dict[str, Callable]:\n        \"\"\"\n        A mapping of `str` versions to a callable that is used for building.\n        Each callable must have the following signature:\n\n        ```python\n        def ...(build_dir: str, build_data: dict) -&gt; str:\n        ```\n\n        The return value must be the absolute path to the built artifact.\n        \"\"\"\n\n    def get_default_versions(self) -&gt; list[str]:\n        \"\"\"\n        A list of versions to build when users do not specify any, defaulting to all versions.\n        \"\"\"\n        return list(self.get_version_api())\n\n    def get_default_build_data(self) -&gt; dict[str, Any]:  # noqa: PLR6301\n        \"\"\"\n        A mapping that can be modified by [build hooks](../build-hook/reference.md) to influence the behavior of builds.\n        \"\"\"\n        return {}\n\n    def set_build_data_defaults(self, build_data: dict[str, Any]) -&gt; None:  # noqa: PLR6301\n        build_data.setdefault('artifacts', [])\n        build_data.setdefault('force_include', {})\n\n    def clean(self, directory: str, versions: list[str]) -&gt; None:\n        \"\"\"\n        Called before builds if the `-c`/`--clean` flag was passed to the\n        [`build`](../../cli/reference.md#hatch-build) command.\n        \"\"\"\n\n    @classmethod\n    def get_config_class(cls) -&gt; type[BuilderConfig]:\n        \"\"\"\n        Must return a subclass of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n        \"\"\"\n        return BuilderConfig\n\n    @staticmethod\n    def normalize_file_name_component(file_name: str) -&gt; str:\n        \"\"\"\n        https://peps.python.org/pep-0427/#escaping-and-unicode\n        \"\"\"\n        return re.sub(r'[^\\w\\d.]+', '_', file_name, flags=re.UNICODE)\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.app","title":"<code>app: Application</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.build_config","title":"<code>build_config: dict[str, Any]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\n</code></pre> <pre><code>[build]\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.target_config","title":"<code>target_config: dict[str, Any]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[build.targets.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.config","title":"<code>config: BuilderConfigBound</code>  <code>property</code>","text":"<p>An instance of BuilderConfig.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_config_class","title":"<code>get_config_class() -&gt; type[BuilderConfig]</code>  <code>classmethod</code>","text":"<p>Must return a subclass of BuilderConfig.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>@classmethod\ndef get_config_class(cls) -&gt; type[BuilderConfig]:\n    \"\"\"\n    Must return a subclass of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n    \"\"\"\n    return BuilderConfig\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_version_api","title":"<code>get_version_api() -&gt; dict[str, Callable]</code>  <code>abstractmethod</code>","text":"<p>A mapping of <code>str</code> versions to a callable that is used for building. Each callable must have the following signature:</p> <pre><code>def ...(build_dir: str, build_data: dict) -&gt; str:\n</code></pre> <p>The return value must be the absolute path to the built artifact.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>@abstractmethod\ndef get_version_api(self) -&gt; dict[str, Callable]:\n    \"\"\"\n    A mapping of `str` versions to a callable that is used for building.\n    Each callable must have the following signature:\n\n    ```python\n    def ...(build_dir: str, build_data: dict) -&gt; str:\n    ```\n\n    The return value must be the absolute path to the built artifact.\n    \"\"\"\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_default_versions","title":"<code>get_default_versions() -&gt; list[str]</code>","text":"<p>A list of versions to build when users do not specify any, defaulting to all versions.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def get_default_versions(self) -&gt; list[str]:\n    \"\"\"\n    A list of versions to build when users do not specify any, defaulting to all versions.\n    \"\"\"\n    return list(self.get_version_api())\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.clean","title":"<code>clean(directory: str, versions: list[str]) -&gt; None</code>","text":"<p>Called before builds if the <code>-c</code>/<code>--clean</code> flag was passed to the <code>build</code> command.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def clean(self, directory: str, versions: list[str]) -&gt; None:\n    \"\"\"\n    Called before builds if the `-c`/`--clean` flag was passed to the\n    [`build`](../../cli/reference.md#hatch-build) command.\n    \"\"\"\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.recurse_included_files","title":"<code>recurse_included_files() -&gt; Iterable[IncludedFile]</code>","text":"<p>Returns a consistently generated series of file objects for every file that should be distributed. Each file object has three <code>str</code> attributes:</p> <ul> <li><code>path</code> - the absolute path</li> <li><code>relative_path</code> - the path relative to the project root; will be an empty string for external files</li> <li><code>distribution_path</code> - the path to be distributed as</li> </ul> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def recurse_included_files(self) -&gt; Iterable[IncludedFile]:\n    \"\"\"\n    Returns a consistently generated series of file objects for every file that should be distributed. Each file\n    object has three `str` attributes:\n\n    - `path` - the absolute path\n    - `relative_path` - the path relative to the project root; will be an empty string for external files\n    - `distribution_path` - the path to be distributed as\n    \"\"\"\n    yield from self.recurse_selected_project_files()\n    yield from self.recurse_forced_files(self.config.get_force_include())\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_default_build_data","title":"<code>get_default_build_data() -&gt; dict[str, Any]</code>","text":"<p>A mapping that can be modified by build hooks to influence the behavior of builds.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def get_default_build_data(self) -&gt; dict[str, Any]:  # noqa: PLR6301\n    \"\"\"\n    A mapping that can be modified by [build hooks](../build-hook/reference.md) to influence the behavior of builds.\n    \"\"\"\n    return {}\n</code></pre>"},{"location":"plugins/builder/sdist/","title":"Source distribution builder","text":"<p>A source distribution, or <code>sdist</code>, is an archive of Python \"source code\". Although largely unspecified, by convention it should include everything that is required to build a wheel without making network requests.</p>"},{"location":"plugins/builder/sdist/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>sdist</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\n</code></pre> <pre><code>[build.targets.sdist]\n</code></pre>"},{"location":"plugins/builder/sdist/#options","title":"Options","text":"Option Default Description <code>core-metadata-version</code> <code>\"2.3\"</code> The version of core metadata to use <code>strict-naming</code> <code>true</code> Whether or not file names should contain the normalized version of the project name <code>support-legacy</code> <code>false</code> Whether or not to include a <code>setup.py</code> file to support legacy installation mechanisms"},{"location":"plugins/builder/sdist/#versions","title":"Versions","text":"Version Description <code>standard</code> (default) The latest conventional format"},{"location":"plugins/builder/sdist/#default-file-selection","title":"Default file selection","text":"<p>When the user has not set any file selection options, all files that are not ignored by your VCS will be included.</p> <p>Note</p> <p>The following files are always included and cannot be excluded:</p> <ul> <li><code>/pyproject.toml</code></li> <li><code>/hatch.toml</code></li> <li><code>/hatch_build.py</code></li> <li><code>/.gitignore</code> or <code>/.hgignore</code></li> <li>Any defined <code>readme</code> file</li> <li>All defined <code>license-files</code></li> </ul>"},{"location":"plugins/builder/sdist/#reproducibility","title":"Reproducibility","text":"<p>Reproducible builds are supported.</p>"},{"location":"plugins/builder/sdist/#build-data","title":"Build data","text":"<p>This is data that can be modified by build hooks.</p> Data Default Description <code>dependencies</code> Extra project dependencies"},{"location":"plugins/builder/wheel/","title":"Wheel builder","text":"<p>A wheel is a binary distribution of a Python package that can be installed directly into an environment.</p>"},{"location":"plugins/builder/wheel/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>wheel</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\n</code></pre> <pre><code>[build.targets.wheel]\n</code></pre>"},{"location":"plugins/builder/wheel/#options","title":"Options","text":"Option Default Description <code>core-metadata-version</code> <code>\"2.3\"</code> The version of core metadata to use <code>shared-data</code> A mapping similar to the forced inclusion option corresponding to data that will be installed globally in a given Python environment, usually under <code>sys.prefix</code> <code>extra-metadata</code> A mapping similar to the forced inclusion option corresponding to extra metadata that will be shipped in a directory named <code>extra_metadata</code> <code>strict-naming</code> <code>true</code> Whether or not file names should contain the normalized version of the project name <code>macos-max-compat</code> <code>true</code> Whether or not on macOS, when build hooks have set the <code>infer_tag</code> build data, the wheel name should signal broad support rather than specific versions for newer SDK versions.Note: The default will become <code>false</code>, and this option eventually removed, sometime after consumers like pip start supporting these newer SDK versions. <code>bypass-selection</code> <code>false</code> Whether or not to suppress the error when one has not defined any file selection options and all heuristics have failed to determine what to ship"},{"location":"plugins/builder/wheel/#versions","title":"Versions","text":"Version Description <code>standard</code> (default) The latest standardized format <code>editable</code> A wheel that only ships <code>.pth</code> files or import hooks for real-time development"},{"location":"plugins/builder/wheel/#default-file-selection","title":"Default file selection","text":"<p>When the user has not set any file selection options, the project name will be used to determine the package to ship in the following heuristic order:</p> <ol> <li><code>&lt;NAME&gt;/__init__.py</code></li> <li><code>src/&lt;NAME&gt;/__init__.py</code></li> <li><code>&lt;NAME&gt;.py</code></li> <li><code>&lt;NAMESPACE&gt;/&lt;NAME&gt;/__init__.py</code></li> </ol> <p>If none of these heuristics are satisfied, an error will be raised.</p>"},{"location":"plugins/builder/wheel/#reproducibility","title":"Reproducibility","text":"<p>Reproducible builds are supported.</p>"},{"location":"plugins/builder/wheel/#build-data","title":"Build data","text":"<p>This is data that can be modified by build hooks.</p> Data Default Description <code>tag</code> The full tag part of the filename (e.g. <code>py3-none-any</code>), defaulting to a cross-platform wheel with the supported major versions of Python based on project metadata <code>infer_tag</code> <code>False</code> When <code>tag</code> is not set, this may be enabled to use the one most specific to the platform, Python interpreter, and ABI <code>pure_python</code> <code>True</code> Whether or not to write metadata indicating that the package does not contain any platform-specific files <code>dependencies</code> Extra project dependencies <code>extra_metadata</code> Additional <code>extra-metadata</code> entries, which take precedence in case of conflicts <code>force_include_editable</code> Similar to the <code>force_include</code> option but specifically for the <code>editable</code> version and takes precedence"},{"location":"plugins/environment/reference/","title":"Environment plugins","text":"<p>See the documentation for environment configuration.</p>"},{"location":"plugins/environment/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-conda - environments backed by Conda/Mamba</li> <li>hatch-containers - environments run inside containers</li> <li>hatch-pip-compile - use pip-compile to manage project dependencies and lockfiles</li> <li>hatch-pip-deepfreeze - virtual environments with dependency locking by pip-deepfreeze</li> </ul>"},{"location":"plugins/environment/reference/#installation","title":"Installation","text":"<p>Any required environment types that are not built-in must be manually installed alongside Hatch or listed in the <code>tool.hatch.env.requires</code> array for automatic management:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env]\nrequires = [\n  \"...\",\n]\n</code></pre> <pre><code>[env]\nrequires = [\n  \"...\",\n]\n</code></pre>"},{"location":"plugins/environment/reference/#life-cycle","title":"Life cycle","text":"<p>Whenever an environment is used, the following logic is performed:</p> Source code in <code>src/hatch/cli/application.py</code> <pre><code>def prepare_environment(self, environment: EnvironmentInterface):\n    if not environment.exists():\n        self.env_metadata.reset(environment)\n\n        with environment.app_status_creation():\n            environment.create()\n\n        if not environment.skip_install:\n            if environment.pre_install_commands:\n                with environment.app_status_pre_installation():\n                    self.run_shell_commands(environment, environment.pre_install_commands, source='pre-install')\n\n            with environment.app_status_project_installation():\n                if environment.dev_mode:\n                    environment.install_project_dev_mode()\n                else:\n                    environment.install_project()\n\n            if environment.post_install_commands:\n                with environment.app_status_post_installation():\n                    self.run_shell_commands(environment, environment.post_install_commands, source='post-install')\n\n    with environment.app_status_dependency_state_check():\n        new_dep_hash = environment.dependency_hash()\n\n    current_dep_hash = self.env_metadata.dependency_hash(environment)\n    if new_dep_hash != current_dep_hash:\n        with environment.app_status_dependency_installation_check():\n            dependencies_in_sync = environment.dependencies_in_sync()\n\n        if not dependencies_in_sync:\n            with environment.app_status_dependency_synchronization():\n                environment.sync_dependencies()\n                new_dep_hash = environment.dependency_hash()\n\n        self.env_metadata.update_dependency_hash(environment, new_dep_hash)\n</code></pre>"},{"location":"plugins/environment/reference/#build-environments","title":"Build environments","text":"<p>All environment types should offer support for a special sub-environment in which projects can be built. This environment is used in the following scenarios:</p> <ul> <li>the <code>build</code> command</li> <li>commands that read dependencies, like <code>dep hash</code>, if any project dependencies are set dynamically</li> </ul>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface","title":"<code>EnvironmentInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>    from hatch.env.plugin.interface import EnvironmentInterface\n\n\n    class SpecialEnvironment(EnvironmentInterface):\n        PLUGIN_NAME = 'special'\n        ...\n</code></pre> <pre><code>    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialEnvironment\n\n\n    @hookimpl\n    def hatch_register_environment():\n        return SpecialEnvironment\n</code></pre> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>class EnvironmentInterface(ABC):\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n        from hatch.env.plugin.interface import EnvironmentInterface\n\n\n        class SpecialEnvironment(EnvironmentInterface):\n            PLUGIN_NAME = 'special'\n            ...\n    ```\n\n    ```python tab=\"hooks.py\"\n        from hatchling.plugin import hookimpl\n\n        from .plugin import SpecialEnvironment\n\n\n        @hookimpl\n        def hatch_register_environment():\n            return SpecialEnvironment\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(\n        self,\n        root,\n        metadata,\n        name,\n        config,\n        matrix_variables,\n        data_directory,\n        isolated_data_directory,\n        platform,\n        verbosity,\n        app=None,\n    ):\n        self.__root = root\n        self.__metadata = metadata\n        self.__name = name\n        self.__config = config\n        self.__matrix_variables = matrix_variables\n        self.__data_directory = data_directory\n        self.__isolated_data_directory = isolated_data_directory\n        self.__platform = platform\n        self.__verbosity = verbosity\n        self.__app = app\n        self.__context = None\n\n        self._system_python = None\n        self._env_vars = None\n        self._env_include = None\n        self._env_exclude = None\n        self._environment_dependencies_complex = None\n        self._environment_dependencies = None\n        self._dependencies_complex = None\n        self._dependencies = None\n        self._platforms = None\n        self._skip_install = None\n        self._dev_mode = None\n        self._features = None\n        self._description = None\n        self._scripts = None\n        self._pre_install_commands = None\n        self._post_install_commands = None\n\n    @property\n    def matrix_variables(self):\n        return self.__matrix_variables\n\n    @property\n    def app(self):\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        if self.__app is None:\n            from hatchling.bridge.app import Application\n\n            self.__app = Application().get_safe_application()\n\n        return self.__app\n\n    @property\n    def context(self):\n        if self.__context is None:\n            self.__context = self.get_context()\n\n        return self.__context\n\n    @property\n    def verbosity(self):\n        return self.__verbosity\n\n    @property\n    def root(self):\n        \"\"\"\n        The root of the project tree as a path-like object.\n        \"\"\"\n        return self.__root\n\n    @property\n    def metadata(self):\n        return self.__metadata\n\n    @property\n    def name(self) -&gt; str:\n        \"\"\"\n        The name of the environment.\n        \"\"\"\n        return self.__name\n\n    @property\n    def platform(self):\n        \"\"\"\n        An instance of [Platform](../utilities.md#hatch.utils.platform.Platform).\n        \"\"\"\n        return self.__platform\n\n    @property\n    def data_directory(self):\n        \"\"\"\n        The [directory](../../config/hatch.md#environments) this plugin should use for storage as a path-like object.\n        If the user has not configured one then this will be the same as the\n        [isolated data directory](reference.md#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory).\n        \"\"\"\n        return self.__data_directory\n\n    @property\n    def isolated_data_directory(self):\n        \"\"\"\n        The default [directory](../../config/hatch.md#environments) reserved exclusively for this plugin as a path-like\n        object.\n        \"\"\"\n        return self.__isolated_data_directory\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    @property\n    def system_python(self):\n        if self._system_python is None:\n            system_python = os.environ.get(AppEnvVars.PYTHON)\n            if system_python == 'self':\n                system_python = sys.executable\n\n            system_python = (\n                system_python\n                or self.platform.modules.shutil.which('python')\n                or self.platform.modules.shutil.which('python3')\n                or sys.executable\n            )\n            if not isabs(system_python):\n                system_python = self.platform.modules.shutil.which(system_python)\n\n            self._system_python = system_python\n\n        return self._system_python\n\n    @property\n    def env_vars(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;.env-vars]\n        ```\n        \"\"\"\n        if self._env_vars is None:\n            env_vars = self.config.get('env-vars', {})\n            if not isinstance(env_vars, dict):\n                message = f'Field `tool.hatch.envs.{self.name}.env-vars` must be a mapping'\n                raise TypeError(message)\n\n            for key, value in env_vars.items():\n                if not isinstance(value, str):\n                    message = (\n                        f'Environment variable `{key}` of field `tool.hatch.envs.{self.name}.env-vars` must be a string'\n                    )\n                    raise TypeError(message)\n\n            new_env_vars = {}\n            with self.metadata.context.apply_context(self.context):\n                for key, value in env_vars.items():\n                    new_env_vars[key] = self.metadata.context.format(value)\n\n            new_env_vars[AppEnvVars.ENV_ACTIVE] = self.name\n            self._env_vars = new_env_vars\n\n        return self._env_vars\n\n    @property\n    def env_include(self) -&gt; list[str]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        env-include = [...]\n        ```\n        \"\"\"\n        if self._env_include is None:\n            env_include = self.config.get('env-include', [])\n            if not isinstance(env_include, list):\n                message = f'Field `tool.hatch.envs.{self.name}.env-include` must be an array'\n                raise TypeError(message)\n\n            for i, pattern in enumerate(env_include, 1):\n                if not isinstance(pattern, str):\n                    message = f'Pattern #{i} of field `tool.hatch.envs.{self.name}.env-include` must be a string'\n                    raise TypeError(message)\n\n            if env_include:\n                self._env_include = ['HATCH_BUILD_*', *env_include]\n            else:\n                self._env_include = env_include\n\n        return self._env_include\n\n    @property\n    def env_exclude(self) -&gt; list[str]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        env-exclude = [...]\n        ```\n        \"\"\"\n        if self._env_exclude is None:\n            env_exclude = self.config.get('env-exclude', [])\n            if not isinstance(env_exclude, list):\n                message = f'Field `tool.hatch.envs.{self.name}.env-exclude` must be an array'\n                raise TypeError(message)\n\n            for i, pattern in enumerate(env_exclude, 1):\n                if not isinstance(pattern, str):\n                    message = f'Pattern #{i} of field `tool.hatch.envs.{self.name}.env-exclude` must be a string'\n                    raise TypeError(message)\n\n            self._env_exclude = env_exclude\n\n        return self._env_exclude\n\n    @property\n    def environment_dependencies_complex(self):\n        if self._environment_dependencies_complex is None:\n            from packaging.requirements import InvalidRequirement, Requirement\n\n            dependencies_complex = []\n            with self.apply_context():\n                for option in ('dependencies', 'extra-dependencies'):\n                    dependencies = self.config.get(option, [])\n                    if not isinstance(dependencies, list):\n                        message = f'Field `tool.hatch.envs.{self.name}.{option}` must be an array'\n                        raise TypeError(message)\n\n                    for i, entry in enumerate(dependencies, 1):\n                        if not isinstance(entry, str):\n                            message = (\n                                f'Dependency #{i} of field `tool.hatch.envs.{self.name}.{option}` must be a string'\n                            )\n                            raise TypeError(message)\n\n                        try:\n                            dependencies_complex.append(Requirement(self.metadata.context.format(entry)))\n                        except InvalidRequirement as e:\n                            message = f'Dependency #{i} of field `tool.hatch.envs.{self.name}.{option}` is invalid: {e}'\n                            raise ValueError(message) from None\n\n            self._environment_dependencies_complex = dependencies_complex\n\n        return self._environment_dependencies_complex\n\n    @property\n    def environment_dependencies(self) -&gt; list[str]:\n        \"\"\"\n        The list of all [environment dependencies](../../config/environment/overview.md#dependencies).\n        \"\"\"\n        if self._environment_dependencies is None:\n            self._environment_dependencies = [str(dependency) for dependency in self.environment_dependencies_complex]\n\n        return self._environment_dependencies\n\n    @property\n    def dependencies_complex(self):\n        if self._dependencies_complex is None:\n            all_dependencies_complex = list(self.environment_dependencies_complex)\n\n            # Ensure these are checked last to speed up initial environment creation since\n            # they will already be installed along with the project\n            if (not self.skip_install and self.dev_mode) or self.features:\n                from hatch.utils.dep import get_project_dependencies_complex\n\n                dependencies_complex, optional_dependencies_complex = get_project_dependencies_complex(self)\n\n                if not self.skip_install and self.dev_mode:\n                    all_dependencies_complex.extend(dependencies_complex.values())\n\n                for feature in self.features:\n                    if feature not in optional_dependencies_complex:\n                        message = (\n                            f'Feature `{feature}` of field `tool.hatch.envs.{self.name}.features` is not '\n                            f'defined in the dynamic field `project.optional-dependencies`'\n                        )\n                        raise ValueError(message)\n\n                    all_dependencies_complex.extend(optional_dependencies_complex[feature].values())\n\n            self._dependencies_complex = all_dependencies_complex\n\n        return self._dependencies_complex\n\n    @property\n    def dependencies(self) -&gt; list[str]:\n        \"\"\"\n        The list of all [project dependencies](../../config/metadata.md#dependencies) (if\n        [installed](../../config/environment/overview.md#skip-install) and in\n        [dev mode](../../config/environment/overview.md#dev-mode)), selected\n        [optional dependencies](../../config/environment/overview.md#features), and\n        [environment dependencies](../../config/environment/overview.md#dependencies).\n        \"\"\"\n        if self._dependencies is None:\n            self._dependencies = [str(dependency) for dependency in self.dependencies_complex]\n\n        return self._dependencies\n\n    @property\n    def platforms(self) -&gt; list[str]:\n        \"\"\"\n        All names are stored as their lower-cased version.\n\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        platforms = [...]\n        ```\n        \"\"\"\n        if self._platforms is None:\n            platforms = self.config.get('platforms', [])\n            if not isinstance(platforms, list):\n                message = f'Field `tool.hatch.envs.{self.name}.platforms` must be an array'\n                raise TypeError(message)\n\n            for i, command in enumerate(platforms, 1):\n                if not isinstance(command, str):\n                    message = f'Platform #{i} of field `tool.hatch.envs.{self.name}.platforms` must be a string'\n                    raise TypeError(message)\n\n            self._platforms = [platform.lower() for platform in platforms]\n\n        return self._platforms\n\n    @property\n    def skip_install(self) -&gt; bool:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        skip-install = ...\n        ```\n        \"\"\"\n        if self._skip_install is None:\n            skip_install = self.config.get('skip-install', not self.metadata.has_project_file())\n            if not isinstance(skip_install, bool):\n                message = f'Field `tool.hatch.envs.{self.name}.skip-install` must be a boolean'\n                raise TypeError(message)\n\n            self._skip_install = skip_install\n\n        return self._skip_install\n\n    @property\n    def dev_mode(self) -&gt; bool:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        dev-mode = ...\n        ```\n        \"\"\"\n        if self._dev_mode is None:\n            dev_mode = self.config.get('dev-mode', True)\n            if not isinstance(dev_mode, bool):\n                message = f'Field `tool.hatch.envs.{self.name}.dev-mode` must be a boolean'\n                raise TypeError(message)\n\n            self._dev_mode = dev_mode\n\n        return self._dev_mode\n\n    @property\n    def features(self):\n        if self._features is None:\n            from hatchling.metadata.utils import normalize_project_name\n\n            features = self.config.get('features', [])\n            if not isinstance(features, list):\n                message = f'Field `tool.hatch.envs.{self.name}.features` must be an array of strings'\n                raise TypeError(message)\n\n            all_features = set()\n            for i, feature in enumerate(features, 1):\n                if not isinstance(feature, str):\n                    message = f'Feature #{i} of field `tool.hatch.envs.{self.name}.features` must be a string'\n                    raise TypeError(message)\n\n                if not feature:\n                    message = f'Feature #{i} of field `tool.hatch.envs.{self.name}.features` cannot be an empty string'\n                    raise ValueError(message)\n\n                normalized_feature = (\n                    feature\n                    if self.metadata.hatch.metadata.allow_ambiguous_features\n                    else normalize_project_name(feature)\n                )\n                if (\n                    not self.metadata.hatch.metadata.hook_config\n                    and normalized_feature not in self.metadata.core.optional_dependencies\n                ):\n                    message = (\n                        f'Feature `{normalized_feature}` of field `tool.hatch.envs.{self.name}.features` is not '\n                        f'defined in field `project.optional-dependencies`'\n                    )\n                    raise ValueError(message)\n\n                all_features.add(normalized_feature)\n\n            self._features = sorted(all_features)\n\n        return self._features\n\n    @property\n    def description(self) -&gt; str:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        description = ...\n        ```\n        \"\"\"\n        if self._description is None:\n            description = self.config.get('description', '')\n            if not isinstance(description, str):\n                message = f'Field `tool.hatch.envs.{self.name}.description` must be a string'\n                raise TypeError(message)\n\n            self._description = description\n\n        return self._description\n\n    @property\n    def scripts(self):\n        if self._scripts is None:\n            script_config = self.config.get('scripts', {})\n            if not isinstance(script_config, dict):\n                message = f'Field `tool.hatch.envs.{self.name}.scripts` must be a table'\n                raise TypeError(message)\n\n            config = {}\n\n            for name, data in script_config.items():\n                if ' ' in name:\n                    message = (\n                        f'Script name `{name}` in field `tool.hatch.envs.{self.name}.scripts` must not contain spaces'\n                    )\n                    raise ValueError(message)\n\n                commands = []\n\n                if isinstance(data, str):\n                    commands.append(data)\n                elif isinstance(data, list):\n                    for i, command in enumerate(data, 1):\n                        if not isinstance(command, str):\n                            message = (\n                                f'Command #{i} in field `tool.hatch.envs.{self.name}.scripts.{name}` must be a string'\n                            )\n                            raise TypeError(message)\n\n                        commands.append(command)\n                else:\n                    message = (\n                        f'Field `tool.hatch.envs.{self.name}.scripts.{name}` must be a string or an array of strings'\n                    )\n                    raise TypeError(message)\n\n                config[name] = commands\n\n            seen = {}\n            active = []\n            for script_name, commands in config.items():\n                commands[:] = expand_script_commands(self.name, script_name, commands, config, seen, active)\n\n            self._scripts = config\n\n        return self._scripts\n\n    @property\n    def pre_install_commands(self):\n        if self._pre_install_commands is None:\n            pre_install_commands = self.config.get('pre-install-commands', [])\n            if not isinstance(pre_install_commands, list):\n                message = f'Field `tool.hatch.envs.{self.name}.pre-install-commands` must be an array'\n                raise TypeError(message)\n\n            for i, command in enumerate(pre_install_commands, 1):\n                if not isinstance(command, str):\n                    message = (\n                        f'Command #{i} of field `tool.hatch.envs.{self.name}.pre-install-commands` must be a string'\n                    )\n                    raise TypeError(message)\n\n            self._pre_install_commands = list(pre_install_commands)\n\n        return self._pre_install_commands\n\n    @property\n    def post_install_commands(self):\n        if self._post_install_commands is None:\n            post_install_commands = self.config.get('post-install-commands', [])\n            if not isinstance(post_install_commands, list):\n                message = f'Field `tool.hatch.envs.{self.name}.post-install-commands` must be an array'\n                raise TypeError(message)\n\n            for i, command in enumerate(post_install_commands, 1):\n                if not isinstance(command, str):\n                    message = (\n                        f'Command #{i} of field `tool.hatch.envs.{self.name}.post-install-commands` must be a string'\n                    )\n                    raise TypeError(message)\n\n            self._post_install_commands = list(post_install_commands)\n\n        return self._post_install_commands\n\n    def activate(self):\n        \"\"\"\n        A convenience method called when using the environment as a context manager:\n\n        ```python\n        with environment:\n            ...\n        ```\n        \"\"\"\n\n    def deactivate(self):\n        \"\"\"\n        A convenience method called after using the environment as a context manager:\n\n        ```python\n        with environment:\n            ...\n        ```\n        \"\"\"\n\n    @abstractmethod\n    def find(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should return information about how to locate the environment or represent its ID in\n        some way. Additionally, this is expected to return something even if the environment is\n        [incompatible](reference.md#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility).\n        \"\"\"\n\n    @abstractmethod\n    def create(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should perform the necessary steps to set up the environment.\n        \"\"\"\n\n    @abstractmethod\n    def remove(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should perform the necessary steps to completely remove the environment from the system and will only\n        be triggered manually by users with the [`env remove`](../../cli/reference.md#hatch-env-remove) or\n        [`env prune`](../../cli/reference.md#hatch-env-prune) commands.\n\n        If the\n        [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n        has a caching mechanism, this should remove that as well.\n        \"\"\"\n\n    @abstractmethod\n    def exists(self) -&gt; bool:\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should indicate whether or not the environment has already been created.\n        \"\"\"\n\n    @abstractmethod\n    def install_project(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should install the project in the environment.\n        \"\"\"\n\n    @abstractmethod\n    def install_project_dev_mode(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should install the project in the environment such that the environment\n        always reflects the current state of the project.\n        \"\"\"\n\n    @abstractmethod\n    def dependencies_in_sync(self) -&gt; bool:\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should indicate whether or not the environment is compatible with the current\n        [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies).\n        \"\"\"\n\n    @abstractmethod\n    def sync_dependencies(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should install the\n        [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n        in the environment.\n        \"\"\"\n\n    def dependency_hash(self):\n        \"\"\"\n        This should return a hash of the environment's\n        [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n        and any other data that is handled by the\n        [sync_dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies)\n        and\n        [dependencies_in_sync](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync)\n        methods.\n        \"\"\"\n        from hatch.utils.dep import hash_dependencies\n\n        return hash_dependencies(self.dependencies_complex)\n\n    @contextmanager\n    def app_status_creation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status(f'Creating environment: {self.name}'):\n            yield\n\n    @contextmanager\n    def app_status_pre_installation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Running pre-installation commands'):\n            yield\n\n    @contextmanager\n    def app_status_post_installation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Running post-installation commands'):\n            yield\n\n    @contextmanager\n    def app_status_project_installation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        if self.dev_mode:\n            with self.app.status('Installing project in development mode'):\n                yield\n        else:\n            with self.app.status('Installing project'):\n                yield\n\n    @contextmanager\n    def app_status_dependency_state_check(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        if not self.skip_install and (\n            'dependencies' in self.metadata.dynamic or 'optional-dependencies' in self.metadata.dynamic\n        ):\n            with self.app.status('Polling dependency state'):\n                yield\n        else:\n            yield\n\n    @contextmanager\n    def app_status_dependency_installation_check(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Checking dependencies'):\n            yield\n\n    @contextmanager\n    def app_status_dependency_synchronization(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Syncing dependencies'):\n            yield\n\n    @contextmanager\n    def build_environment(\n        self,\n        dependencies: list[str],  # noqa: ARG002\n    ):\n        \"\"\"\n        This should set up an isolated environment in which to [`build`](../../cli/reference.md#hatch-build) the project\n        given a set of dependencies and must be a context manager:\n\n        ```python\n        with environment.build_environment([...]):\n            ...\n        ```\n\n        The build environment should reflect any\n        [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n        the user defined either currently or at the time of\n        [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n        \"\"\"\n        with self.get_env_vars():\n            yield\n\n    def run_builder(\n        self,\n        build_environment,  # noqa: ARG002\n        **kwargs,\n    ):\n        \"\"\"\n        This will be called when the\n        [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n        is active:\n\n        ```python\n        with environment.build_environment([...]) as build_env:\n            process = environment.run_builder(build_env, ...)\n        ```\n\n        This should return the standard library's\n        [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess).\n        The command is constructed by passing all keyword arguments to\n        [construct_build_command](reference.md#hatch.env.plugin.interface.EnvironmentInterface.construct_build_command).\n\n        For an example, open the default implementation below:\n        \"\"\"\n        return self.platform.run_command(self.construct_build_command(**kwargs))\n\n    def build_environment_exists(self):  # noqa: PLR6301\n        \"\"\"\n        If the\n        [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n        has a caching mechanism, this should indicate whether or not it has already been created.\n        \"\"\"\n        return False\n\n    def enter_shell(\n        self,\n        name: str,  # noqa: ARG002\n        path: str,\n        args: Iterable[str],\n    ):\n        \"\"\"\n        Spawn a [shell](../../config/hatch.md#shell) within the environment.\n\n        This should either use\n        [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n        directly or provide the same guarantee.\n        \"\"\"\n        with self.command_context():\n            self.platform.exit_with_command([path, *args])\n\n    def run_shell_command(self, command: str, **kwargs):\n        \"\"\"\n        This should return the standard library's\n        [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess)\n        and will always be called when the\n        [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n        is active, with the expectation of providing the same guarantee.\n        \"\"\"\n        kwargs.setdefault('shell', True)\n        return self.platform.run_command(command, **kwargs)\n\n    @contextmanager\n    def command_context(self):\n        \"\"\"\n        A context manager that when active should make executed shell commands reflect any\n        [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n        the user defined either currently or at the time of\n        [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n\n        For an example, open the default implementation below:\n        \"\"\"\n        with self.get_env_vars():\n            yield\n\n    def resolve_commands(self, commands: list[str]):\n        \"\"\"\n        This expands each command into one or more commands based on any\n        [scripts](../../config/environment/overview.md#scripts) that the user defined.\n        \"\"\"\n        for command in commands:\n            yield from self.expand_command(command)\n\n    def expand_command(self, command):\n        possible_script, args, _ignore_exit_code = parse_script_command(command)\n\n        # Indicate undefined\n        if not args:\n            args = None\n\n        with self.apply_context():\n            if possible_script in self.scripts:\n                for cmd in self.scripts[possible_script]:\n                    yield self.metadata.context.format(cmd, args=args).strip()\n            else:\n                yield self.metadata.context.format(command, args=args).strip()\n\n    def construct_build_command(  # noqa: PLR6301\n        self,\n        *,\n        directory=None,\n        targets=(),\n        hooks_only=False,\n        no_hooks=False,\n        clean=False,\n        clean_hooks_after=False,\n        clean_only=False,\n    ):\n        \"\"\"\n        This is the canonical way [`build`](../../cli/reference.md#hatch-build) command options are translated to\n        a subprocess command issued to [builders](../builder/reference.md).\n        \"\"\"\n        command = ['python', '-u', '-m', 'hatchling', 'build']\n\n        if directory:\n            command.extend(('--directory', directory))\n\n        if targets:\n            for target in targets:\n                command.extend(('--target', target))\n\n        if hooks_only:\n            command.append('--hooks-only')\n\n        if no_hooks:\n            command.append('--no-hooks')\n\n        if clean:\n            command.append('--clean')\n\n        if clean_hooks_after:\n            command.append('--clean-hooks-after')\n\n        if clean_only:\n            command.append('--clean-only')\n\n        return command\n\n    def construct_pip_install_command(self, args: list[str]):\n        \"\"\"\n        A convenience method for constructing a [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/)\n        command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.\n        \"\"\"\n        command = ['python', '-u', '-m', 'pip', 'install', '--disable-pip-version-check', '--no-python-version-warning']\n\n        # Default to -1 verbosity\n        add_verbosity_flag(command, self.verbosity, adjustment=-1)\n\n        command.extend(args)\n        return command\n\n    def join_command_args(self, args: list[str]):\n        \"\"\"\n        This is used by the [`run`](../../cli/reference.md#hatch-run) command to construct the root command string\n        from the received arguments.\n        \"\"\"\n        return self.platform.join_command_args(args)\n\n    def apply_features(self, requirement: str):\n        \"\"\"\n        A convenience method that applies any user defined [features](../../config/environment/overview.md#features)\n        to the given requirement.\n        \"\"\"\n        if self.features:\n            features = ','.join(self.features)\n            return f'{requirement}[{features}]'\n\n        return requirement\n\n    def check_compatibility(self):\n        \"\"\"\n        This raises an exception if the environment is not compatible with the user's setup. The default behavior\n        checks for [platform compatibility](../../config/environment/overview.md#supported-platforms)\n        and any method override should keep this check.\n\n        This check is never performed if the environment has been\n        [created](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n        \"\"\"\n        if self.platforms and self.platform.name not in self.platforms:\n            message = 'unsupported platform'\n            raise OSError(message)\n\n    def get_env_vars(self) -&gt; EnvVars:\n        \"\"\"\n        Returns a mapping of environment variables that should be available to the environment. The object can\n        be used as a context manager to temporarily apply the environment variables to the current process.\n\n        !!! note\n            The environment variable `HATCH_ENV_ACTIVE` will always be set to the name of the environment.\n        \"\"\"\n        return EnvVars(self.env_vars, self.env_include, self.env_exclude)\n\n    def get_env_var_option(self, option: str) -&gt; str:\n        \"\"\"\n        Returns the value of the upper-cased environment variable `HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;`.\n        \"\"\"\n        return os.environ.get(f'{AppEnvVars.ENV_OPTION_PREFIX}{self.PLUGIN_NAME}_{option}'.upper(), '')\n\n    def get_context(self):\n        \"\"\"\n        Returns a subclass of\n        [EnvironmentContextFormatter](../utilities.md#hatch.env.context.EnvironmentContextFormatter).\n        \"\"\"\n        from hatch.env.context import EnvironmentContextFormatter\n\n        return EnvironmentContextFormatter(self)\n\n    @staticmethod\n    def get_option_types() -&gt; dict:\n        \"\"\"\n        Returns a mapping of supported options to their respective types so that they can be used by\n        [overrides](../../config/environment/advanced.md#option-overrides).\n        \"\"\"\n        return {}\n\n    @contextmanager\n    def apply_context(self):\n        with self.get_env_vars(), self.metadata.context.apply_context(self.context):\n            yield\n\n    def __enter__(self):\n        self.activate()\n        return self\n\n    def __exit__(self, exc_type, exc_value, traceback):\n        self.deactivate()\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app","title":"<code>app</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.root","title":"<code>root</code>  <code>property</code>","text":"<p>The root of the project tree as a path-like object.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.name","title":"<code>name: str</code>  <code>property</code>","text":"<p>The name of the environment.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.data_directory","title":"<code>data_directory</code>  <code>property</code>","text":"<p>The directory this plugin should use for storage as a path-like object. If the user has not configured one then this will be the same as the isolated data directory.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory","title":"<code>isolated_data_directory</code>  <code>property</code>","text":"<p>The default directory reserved exclusively for this plugin as a path-like object.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.platform","title":"<code>platform</code>  <code>property</code>","text":"<p>An instance of Platform.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.environment_dependencies","title":"<code>environment_dependencies: list[str]</code>  <code>property</code>","text":"<p>The list of all environment dependencies.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dependencies","title":"<code>dependencies: list[str]</code>  <code>property</code>","text":"<p>The list of all project dependencies (if installed and in dev mode), selected optional dependencies, and environment dependencies.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.env_vars","title":"<code>env_vars: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;.env-vars]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;.env-vars]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.env_include","title":"<code>env_include: list[str]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nenv-include = [...]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nenv-include = [...]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.env_exclude","title":"<code>env_exclude: list[str]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nenv-exclude = [...]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nenv-exclude = [...]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.platforms","title":"<code>platforms: list[str]</code>  <code>property</code>","text":"<p>All names are stored as their lower-cased version.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nplatforms = [...]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nplatforms = [...]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.skip_install","title":"<code>skip_install: bool</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nskip-install = ...\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nskip-install = ...\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dev_mode","title":"<code>dev_mode: bool</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ndev-mode = ...\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ndev-mode = ...\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.description","title":"<code>description: str</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ndescription = ...\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ndescription = ...\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.find","title":"<code>find()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should return information about how to locate the environment or represent its ID in some way. Additionally, this is expected to return something even if the environment is incompatible.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef find(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should return information about how to locate the environment or represent its ID in\n    some way. Additionally, this is expected to return something even if the environment is\n    [incompatible](reference.md#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility).\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.create","title":"<code>create()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should perform the necessary steps to set up the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef create(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should perform the necessary steps to set up the environment.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.remove","title":"<code>remove()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should perform the necessary steps to completely remove the environment from the system and will only be triggered manually by users with the <code>env remove</code> or <code>env prune</code> commands.</p> <p>If the build environment has a caching mechanism, this should remove that as well.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef remove(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should perform the necessary steps to completely remove the environment from the system and will only\n    be triggered manually by users with the [`env remove`](../../cli/reference.md#hatch-env-remove) or\n    [`env prune`](../../cli/reference.md#hatch-env-prune) commands.\n\n    If the\n    [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n    has a caching mechanism, this should remove that as well.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.exists","title":"<code>exists() -&gt; bool</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should indicate whether or not the environment has already been created.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef exists(self) -&gt; bool:\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should indicate whether or not the environment has already been created.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.install_project","title":"<code>install_project()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should install the project in the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef install_project(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should install the project in the environment.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.install_project_dev_mode","title":"<code>install_project_dev_mode()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should install the project in the environment such that the environment always reflects the current state of the project.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef install_project_dev_mode(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should install the project in the environment such that the environment\n    always reflects the current state of the project.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync","title":"<code>dependencies_in_sync() -&gt; bool</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should indicate whether or not the environment is compatible with the current dependencies.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef dependencies_in_sync(self) -&gt; bool:\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should indicate whether or not the environment is compatible with the current\n    [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies).\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies","title":"<code>sync_dependencies()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should install the dependencies in the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef sync_dependencies(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should install the\n    [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n    in the environment.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dependency_hash","title":"<code>dependency_hash()</code>","text":"<p>This should return a hash of the environment's dependencies and any other data that is handled by the sync_dependencies and dependencies_in_sync methods.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def dependency_hash(self):\n    \"\"\"\n    This should return a hash of the environment's\n    [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n    and any other data that is handled by the\n    [sync_dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies)\n    and\n    [dependencies_in_sync](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync)\n    methods.\n    \"\"\"\n    from hatch.utils.dep import hash_dependencies\n\n    return hash_dependencies(self.dependencies_complex)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.build_environment","title":"<code>build_environment(dependencies: list[str])</code>","text":"<p>This should set up an isolated environment in which to <code>build</code> the project given a set of dependencies and must be a context manager:</p> <pre><code>with environment.build_environment([...]):\n    ...\n</code></pre> <p>The build environment should reflect any environment variables the user defined either currently or at the time of creation.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef build_environment(\n    self,\n    dependencies: list[str],  # noqa: ARG002\n):\n    \"\"\"\n    This should set up an isolated environment in which to [`build`](../../cli/reference.md#hatch-build) the project\n    given a set of dependencies and must be a context manager:\n\n    ```python\n    with environment.build_environment([...]):\n        ...\n    ```\n\n    The build environment should reflect any\n    [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n    the user defined either currently or at the time of\n    [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n    \"\"\"\n    with self.get_env_vars():\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.build_environment_exists","title":"<code>build_environment_exists()</code>","text":"<p>If the build environment has a caching mechanism, this should indicate whether or not it has already been created.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def build_environment_exists(self):  # noqa: PLR6301\n    \"\"\"\n    If the\n    [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n    has a caching mechanism, this should indicate whether or not it has already been created.\n    \"\"\"\n    return False\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.activate","title":"<code>activate()</code>","text":"<p>A convenience method called when using the environment as a context manager:</p> <pre><code>with environment:\n    ...\n</code></pre> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def activate(self):\n    \"\"\"\n    A convenience method called when using the environment as a context manager:\n\n    ```python\n    with environment:\n        ...\n    ```\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.deactivate","title":"<code>deactivate()</code>","text":"<p>A convenience method called after using the environment as a context manager:</p> <pre><code>with environment:\n    ...\n</code></pre> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def deactivate(self):\n    \"\"\"\n    A convenience method called after using the environment as a context manager:\n\n    ```python\n    with environment:\n        ...\n    ```\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_creation","title":"<code>app_status_creation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_creation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status(f'Creating environment: {self.name}'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_pre_installation","title":"<code>app_status_pre_installation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_pre_installation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Running pre-installation commands'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_post_installation","title":"<code>app_status_post_installation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_post_installation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Running post-installation commands'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_project_installation","title":"<code>app_status_project_installation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_project_installation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    if self.dev_mode:\n        with self.app.status('Installing project in development mode'):\n            yield\n    else:\n        with self.app.status('Installing project'):\n            yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_state_check","title":"<code>app_status_dependency_state_check()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_dependency_state_check(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    if not self.skip_install and (\n        'dependencies' in self.metadata.dynamic or 'optional-dependencies' in self.metadata.dynamic\n    ):\n        with self.app.status('Polling dependency state'):\n            yield\n    else:\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_installation_check","title":"<code>app_status_dependency_installation_check()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_dependency_installation_check(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Checking dependencies'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_synchronization","title":"<code>app_status_dependency_synchronization()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_dependency_synchronization(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Syncing dependencies'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.run_builder","title":"<code>run_builder(build_environment, **kwargs)</code>","text":"<p>This will be called when the build environment is active:</p> <pre><code>with environment.build_environment([...]) as build_env:\n    process = environment.run_builder(build_env, ...)\n</code></pre> <p>This should return the standard library's subprocess.CompletedProcess. The command is constructed by passing all keyword arguments to construct_build_command.</p> <p>For an example, open the default implementation below:</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def run_builder(\n    self,\n    build_environment,  # noqa: ARG002\n    **kwargs,\n):\n    \"\"\"\n    This will be called when the\n    [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n    is active:\n\n    ```python\n    with environment.build_environment([...]) as build_env:\n        process = environment.run_builder(build_env, ...)\n    ```\n\n    This should return the standard library's\n    [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess).\n    The command is constructed by passing all keyword arguments to\n    [construct_build_command](reference.md#hatch.env.plugin.interface.EnvironmentInterface.construct_build_command).\n\n    For an example, open the default implementation below:\n    \"\"\"\n    return self.platform.run_command(self.construct_build_command(**kwargs))\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.construct_build_command","title":"<code>construct_build_command(*, directory=None, targets=(), hooks_only=False, no_hooks=False, clean=False, clean_hooks_after=False, clean_only=False)</code>","text":"<p>This is the canonical way <code>build</code> command options are translated to a subprocess command issued to builders.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def construct_build_command(  # noqa: PLR6301\n    self,\n    *,\n    directory=None,\n    targets=(),\n    hooks_only=False,\n    no_hooks=False,\n    clean=False,\n    clean_hooks_after=False,\n    clean_only=False,\n):\n    \"\"\"\n    This is the canonical way [`build`](../../cli/reference.md#hatch-build) command options are translated to\n    a subprocess command issued to [builders](../builder/reference.md).\n    \"\"\"\n    command = ['python', '-u', '-m', 'hatchling', 'build']\n\n    if directory:\n        command.extend(('--directory', directory))\n\n    if targets:\n        for target in targets:\n            command.extend(('--target', target))\n\n    if hooks_only:\n        command.append('--hooks-only')\n\n    if no_hooks:\n        command.append('--no-hooks')\n\n    if clean:\n        command.append('--clean')\n\n    if clean_hooks_after:\n        command.append('--clean-hooks-after')\n\n    if clean_only:\n        command.append('--clean-only')\n\n    return command\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.command_context","title":"<code>command_context()</code>","text":"<p>A context manager that when active should make executed shell commands reflect any environment variables the user defined either currently or at the time of creation.</p> <p>For an example, open the default implementation below:</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef command_context(self):\n    \"\"\"\n    A context manager that when active should make executed shell commands reflect any\n    [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n    the user defined either currently or at the time of\n    [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n\n    For an example, open the default implementation below:\n    \"\"\"\n    with self.get_env_vars():\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.enter_shell","title":"<code>enter_shell(name: str, path: str, args: Iterable[str])</code>","text":"<p>Spawn a shell within the environment.</p> <p>This should either use command_context directly or provide the same guarantee.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def enter_shell(\n    self,\n    name: str,  # noqa: ARG002\n    path: str,\n    args: Iterable[str],\n):\n    \"\"\"\n    Spawn a [shell](../../config/hatch.md#shell) within the environment.\n\n    This should either use\n    [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n    directly or provide the same guarantee.\n    \"\"\"\n    with self.command_context():\n        self.platform.exit_with_command([path, *args])\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.run_shell_command","title":"<code>run_shell_command(command: str, **kwargs)</code>","text":"<p>This should return the standard library's subprocess.CompletedProcess and will always be called when the command_context is active, with the expectation of providing the same guarantee.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def run_shell_command(self, command: str, **kwargs):\n    \"\"\"\n    This should return the standard library's\n    [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess)\n    and will always be called when the\n    [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n    is active, with the expectation of providing the same guarantee.\n    \"\"\"\n    kwargs.setdefault('shell', True)\n    return self.platform.run_command(command, **kwargs)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.resolve_commands","title":"<code>resolve_commands(commands: list[str])</code>","text":"<p>This expands each command into one or more commands based on any scripts that the user defined.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def resolve_commands(self, commands: list[str]):\n    \"\"\"\n    This expands each command into one or more commands based on any\n    [scripts](../../config/environment/overview.md#scripts) that the user defined.\n    \"\"\"\n    for command in commands:\n        yield from self.expand_command(command)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars","title":"<code>get_env_vars() -&gt; EnvVars</code>","text":"<p>Returns a mapping of environment variables that should be available to the environment. The object can be used as a context manager to temporarily apply the environment variables to the current process.</p> <p>Note</p> <p>The environment variable <code>HATCH_ENV_ACTIVE</code> will always be set to the name of the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def get_env_vars(self) -&gt; EnvVars:\n    \"\"\"\n    Returns a mapping of environment variables that should be available to the environment. The object can\n    be used as a context manager to temporarily apply the environment variables to the current process.\n\n    !!! note\n        The environment variable `HATCH_ENV_ACTIVE` will always be set to the name of the environment.\n    \"\"\"\n    return EnvVars(self.env_vars, self.env_include, self.env_exclude)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.apply_features","title":"<code>apply_features(requirement: str)</code>","text":"<p>A convenience method that applies any user defined features to the given requirement.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def apply_features(self, requirement: str):\n    \"\"\"\n    A convenience method that applies any user defined [features](../../config/environment/overview.md#features)\n    to the given requirement.\n    \"\"\"\n    if self.features:\n        features = ','.join(self.features)\n        return f'{requirement}[{features}]'\n\n    return requirement\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.construct_pip_install_command","title":"<code>construct_pip_install_command(args: list[str])</code>","text":"<p>A convenience method for constructing a <code>pip install</code> command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def construct_pip_install_command(self, args: list[str]):\n    \"\"\"\n    A convenience method for constructing a [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/)\n    command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.\n    \"\"\"\n    command = ['python', '-u', '-m', 'pip', 'install', '--disable-pip-version-check', '--no-python-version-warning']\n\n    # Default to -1 verbosity\n    add_verbosity_flag(command, self.verbosity, adjustment=-1)\n\n    command.extend(args)\n    return command\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.join_command_args","title":"<code>join_command_args(args: list[str])</code>","text":"<p>This is used by the <code>run</code> command to construct the root command string from the received arguments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def join_command_args(self, args: list[str]):\n    \"\"\"\n    This is used by the [`run`](../../cli/reference.md#hatch-run) command to construct the root command string\n    from the received arguments.\n    \"\"\"\n    return self.platform.join_command_args(args)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility","title":"<code>check_compatibility()</code>","text":"<p>This raises an exception if the environment is not compatible with the user's setup. The default behavior checks for platform compatibility and any method override should keep this check.</p> <p>This check is never performed if the environment has been created.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def check_compatibility(self):\n    \"\"\"\n    This raises an exception if the environment is not compatible with the user's setup. The default behavior\n    checks for [platform compatibility](../../config/environment/overview.md#supported-platforms)\n    and any method override should keep this check.\n\n    This check is never performed if the environment has been\n    [created](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n    \"\"\"\n    if self.platforms and self.platform.name not in self.platforms:\n        message = 'unsupported platform'\n        raise OSError(message)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_option_types","title":"<code>get_option_types() -&gt; dict</code>  <code>staticmethod</code>","text":"<p>Returns a mapping of supported options to their respective types so that they can be used by overrides.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@staticmethod\ndef get_option_types() -&gt; dict:\n    \"\"\"\n    Returns a mapping of supported options to their respective types so that they can be used by\n    [overrides](../../config/environment/advanced.md#option-overrides).\n    \"\"\"\n    return {}\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_env_var_option","title":"<code>get_env_var_option(option: str) -&gt; str</code>","text":"<p>Returns the value of the upper-cased environment variable <code>HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;</code>.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def get_env_var_option(self, option: str) -&gt; str:\n    \"\"\"\n    Returns the value of the upper-cased environment variable `HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;`.\n    \"\"\"\n    return os.environ.get(f'{AppEnvVars.ENV_OPTION_PREFIX}{self.PLUGIN_NAME}_{option}'.upper(), '')\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_context","title":"<code>get_context()</code>","text":"<p>Returns a subclass of EnvironmentContextFormatter.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def get_context(self):\n    \"\"\"\n    Returns a subclass of\n    [EnvironmentContextFormatter](../utilities.md#hatch.env.context.EnvironmentContextFormatter).\n    \"\"\"\n    from hatch.env.context import EnvironmentContextFormatter\n\n    return EnvironmentContextFormatter(self)\n</code></pre>"},{"location":"plugins/environment/virtual/","title":"Virtual environment","text":"<p>This uses virtual environments backed by the standard virtualenv tool.</p>"},{"location":"plugins/environment/virtual/#configuration","title":"Configuration","text":"<p>The environment plugin name is <code>virtual</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ntype = \"virtual\"\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ntype = \"virtual\"\n</code></pre>"},{"location":"plugins/environment/virtual/#options","title":"Options","text":"Option Default Description <code>python</code> The version of Python to find on your system and subsequently use to create the environment, defaulting to the <code>HATCH_PYTHON</code> environment variable, followed by the normal resolution logic. Setting the <code>HATCH_PYTHON</code> environment variable to <code>self</code> will force the use of the Python executable Hatch is running on. For more information, see the documentation. <code>python-sources</code> <code>['external', 'internal']</code> This may be set to an array of strings that are either the literal <code>internal</code> or <code>external</code>. External considers only Python executables that are already on <code>PATH</code>. Internal considers only internally managed Python distributions. <code>path</code> An explicit path to the virtual environment. The path may be absolute or relative to the project root. Any environments that inherit this option will also use this path. The environment variable <code>HATCH_ENV_TYPE_VIRTUAL_PATH</code> may be used, which will take precedence. <code>system-packages</code> <code>false</code> Whether or not to give the virtual environment access to the system <code>site-packages</code> directory"},{"location":"plugins/environment/virtual/#location","title":"Location","text":"<p>The location of environments is determined in the following heuristic order:</p> <ol> <li>The <code>path</code> option</li> <li>A directory named after the environment within the configured <code>virtual</code> environment directory if the directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory</li> <li>Otherwise, environments are stored within the configured <code>virtual</code> environment directory in a deeply nested structure in order to support multiple projects</li> </ol> <p>Additionally, when the <code>path</code> option is not used, the name of the directory for the <code>default</code> environment will be the normalized project name to provide a more meaningful default shell prompt.</p>"},{"location":"plugins/environment/virtual/#python-resolution","title":"Python resolution","text":"<p>Virtual environments necessarily require a parent installation of Python. The following rules determine how the parent is resolved.</p> <p>The Python choice is determined by the <code>python</code> option followed by the <code>HATCH_PYTHON</code> environment variable. If the choice is via the environment variable, then resolution stops and that path is used unconditionally.</p> <p>The resolvers will be based on the <code>python-sources</code> option and all resolved interpreters will ensure compatibility with the project's defined Python support.</p> <p>If a Python version has been chosen then each resolver will try to find an interpreter that satisfies that version.</p> <p>If no version has been chosen, then each resolver will try to find a version that matches the version of Python that Hatch is currently running on. If not found then each resolver will try to find the highest compatible version.</p> <p>Note</p> <p>Some external Python paths are considered unstable and are ignored during resolution. For example, if Hatch is installed via Homebrew then <code>sys.executable</code> will be ignored because the interpreter could change or be removed at any time.</p> <p>Note</p> <p>When resolution finds a match using an internally managed distribution and an update is available, the latest distribution will automatically be downloaded before environment creation.</p>"},{"location":"plugins/environment/virtual/#internal-distributions","title":"Internal distributions","text":"<p>The following options are recognized for internal Python resolution.</p>"},{"location":"plugins/environment/virtual/#cpython","title":"CPython","text":"ID <code>3.7</code> <code>3.8</code> <code>3.9</code> <code>3.10</code> <code>3.11</code> <code>3.12</code> <p>The source of distributions is the python-build-standalone project.</p> <p>Some distributions have variants that may be configured with the <code>HATCH_PYTHON_VARIANT_&lt;PLATFORM&gt;</code> environment variable where <code>&lt;PLATFORM&gt;</code> is the uppercase version of one of the following:</p> Platform Options Linux <ul><li><code>v1</code></li><li><code>v2</code></li><li><code>v3</code> (default)</li><li><code>v4</code></li></ul> Windows <ul><li><code>shared</code> (default)</li><li><code>static</code></li></ul>"},{"location":"plugins/environment/virtual/#pypy","title":"PyPy","text":"ID <code>pypy2.7</code> <code>pypy3.9</code> <code>pypy3.10</code> <p>The source of distributions is the PyPy project.</p>"},{"location":"plugins/environment/virtual/#troubleshooting","title":"Troubleshooting","text":""},{"location":"plugins/environment/virtual/#macos-sip","title":"macOS SIP","text":"<p>If you need to set linker environment variables like those starting with <code>DYLD_</code> or <code>LD_</code>, any executable secured by System Integrity Protection that is invoked when running commands will not see those environment variable modifications as macOS strips those.</p> <p>Hatch interprets such commands as shell commands but deliberately ignores such paths to protected shells. This workaround suffices for the majority of use cases but there are 2 situations in which it may not:</p> <ol> <li>There are no unprotected <code>sh</code>, <code>bash</code>, <code>zsh</code>, nor <code>fish</code> executables found along PATH.</li> <li>The desired executable is a project's script, and the location of environments contains spaces or is longer than 124<sup>1</sup> characters. In this case <code>pip</code> and other installers will create such an entry point with a shebang pointing to <code>/bin/sh</code> (which is protected) to avoid shebang limitations. Rather than changing the location, you could invoke the script as e.g. <code>python -m pytest</code> (if the project supports that method of invocation by shipping a <code>__main__.py</code>).</li> </ol> <ol> <li> <p>The shebang length limit is usually 127 but 3 characters surround the executable path: <code>#!&lt;EXE_PATH&gt;\\n</code> \u21a9</p> </li> </ol>"},{"location":"plugins/environment-collector/custom/","title":"Custom environment collector","text":"<p>This is a custom class in a given Python file that inherits from the EnvironmentCollectorInterface.</p>"},{"location":"plugins/environment-collector/custom/#configuration","title":"Configuration","text":"<p>The environment collector plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env.collectors.custom]\n</code></pre> <pre><code>[env.collectors.custom]\n</code></pre>"},{"location":"plugins/environment-collector/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_plugins.py</code> The path of the Python file"},{"location":"plugins/environment-collector/custom/#example","title":"Example","text":"hatch_plugins.py <pre><code>    from hatch.env.collectors.plugin.interface import EnvironmentCollectorInterface\n\n\n    class CustomEnvironmentCollector(EnvironmentCollectorInterface):\n        ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_environment_collector</code> that returns the desired environment collector.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/environment-collector/default/","title":"Default environment collector","text":"<p>This adds the <code>default</code> environment with type set to virtual and will always be applied.</p>"},{"location":"plugins/environment-collector/default/#configuration","title":"Configuration","text":"<p>The environment collector plugin name is <code>default</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env.collectors.default]\n</code></pre> <pre><code>[env.collectors.default]\n</code></pre>"},{"location":"plugins/environment-collector/default/#options","title":"Options","text":"<p>There are no options available currently.</p>"},{"location":"plugins/environment-collector/reference/","title":"Environment collector plugins","text":"<p>Environment collectors allow for dynamically modifying environments or adding environments beyond those defined in config. Users can override default values provided by each environment.</p>"},{"location":"plugins/environment-collector/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-mkdocs - integrate MkDocs and infer dependencies into an env</li> </ul>"},{"location":"plugins/environment-collector/reference/#installation","title":"Installation","text":"<p>Any required environment collectors that are not built-in must be manually installed alongside Hatch or listed in the <code>tool.hatch.env.requires</code> array for automatic management:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env]\nrequires = [\n  \"...\",\n]\n</code></pre> <pre><code>[env]\nrequires = [\n  \"...\",\n]\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface","title":"<code>EnvironmentCollectorInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>    from hatch.env.collectors.plugin.interface import EnvironmentCollectorInterface\n\n\n    class SpecialEnvironmentCollector(EnvironmentCollectorInterface):\n        PLUGIN_NAME = 'special'\n        ...\n</code></pre> <pre><code>    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialEnvironmentCollector\n\n\n    @hookimpl\n    def hatch_register_environment_collector():\n        return SpecialEnvironmentCollector\n</code></pre> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>class EnvironmentCollectorInterface:\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n        from hatch.env.collectors.plugin.interface import EnvironmentCollectorInterface\n\n\n        class SpecialEnvironmentCollector(EnvironmentCollectorInterface):\n            PLUGIN_NAME = 'special'\n            ...\n    ```\n\n    ```python tab=\"hooks.py\"\n        from hatchling.plugin import hookimpl\n\n        from .plugin import SpecialEnvironmentCollector\n\n\n        @hookimpl\n        def hatch_register_environment_collector():\n            return SpecialEnvironmentCollector\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root, config):\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self):\n        \"\"\"\n        The root of the project tree as a path-like object.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.env.collectors.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    def get_initial_config(self) -&gt; dict[str, dict]:  # noqa: PLR6301\n        \"\"\"\n        Returns configuration for environments keyed by the environment or matrix name.\n        \"\"\"\n        return {}\n\n    def finalize_config(self, config: dict[str, dict]):\n        \"\"\"\n        Finalizes configuration for environments keyed by the environment or matrix name. This will override\n        any user-defined settings and any collectors that ran before this call.\n\n        This is called before matrices are turned into concrete environments.\n        \"\"\"\n\n    def finalize_environments(self, config: dict[str, dict]):\n        \"\"\"\n        Finalizes configuration for environments keyed by the environment name. This will override\n        any user-defined settings and any collectors that ran before this call.\n\n        This is called after matrices are turned into concrete environments.\n        \"\"\"\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.root","title":"<code>root</code>  <code>property</code>","text":"<p>The root of the project tree as a path-like object.</p>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.env.collectors.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[env.collectors.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.get_initial_config","title":"<code>get_initial_config() -&gt; dict[str, dict]</code>","text":"<p>Returns configuration for environments keyed by the environment or matrix name.</p> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>def get_initial_config(self) -&gt; dict[str, dict]:  # noqa: PLR6301\n    \"\"\"\n    Returns configuration for environments keyed by the environment or matrix name.\n    \"\"\"\n    return {}\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.finalize_config","title":"<code>finalize_config(config: dict[str, dict])</code>","text":"<p>Finalizes configuration for environments keyed by the environment or matrix name. This will override any user-defined settings and any collectors that ran before this call.</p> <p>This is called before matrices are turned into concrete environments.</p> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>def finalize_config(self, config: dict[str, dict]):\n    \"\"\"\n    Finalizes configuration for environments keyed by the environment or matrix name. This will override\n    any user-defined settings and any collectors that ran before this call.\n\n    This is called before matrices are turned into concrete environments.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.finalize_environments","title":"<code>finalize_environments(config: dict[str, dict])</code>","text":"<p>Finalizes configuration for environments keyed by the environment name. This will override any user-defined settings and any collectors that ran before this call.</p> <p>This is called after matrices are turned into concrete environments.</p> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>def finalize_environments(self, config: dict[str, dict]):\n    \"\"\"\n    Finalizes configuration for environments keyed by the environment name. This will override\n    any user-defined settings and any collectors that ran before this call.\n\n    This is called after matrices are turned into concrete environments.\n    \"\"\"\n</code></pre>"},{"location":"plugins/metadata-hook/custom/","title":"Custom metadata hook","text":"<p>This is a custom class in a given Python file that inherits from the MetadataHookInterface.</p>"},{"location":"plugins/metadata-hook/custom/#configuration","title":"Configuration","text":"<p>The metadata hook plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata.hooks.custom]\n</code></pre> <pre><code>[metadata.hooks.custom]\n</code></pre>"},{"location":"plugins/metadata-hook/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_build.py</code> The path of the Python file"},{"location":"plugins/metadata-hook/custom/#example","title":"Example","text":"hatch_build.py <pre><code>from hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\nclass CustomMetadataHook(MetadataHookInterface):\n    ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_metadata_hook</code> that returns the desired build hook.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/metadata-hook/reference/","title":"Metadata hook plugins","text":"<p>Metadata hooks allow for the modification of project metadata after it has been loaded.</p>"},{"location":"plugins/metadata-hook/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-docstring-description - set the project description using docstrings</li> <li>hatch-fancy-pypi-readme - dynamically construct the README</li> <li>hatch-nodejs-version - uses fields from NodeJS <code>package.json</code> files</li> <li>hatch-odoo - determine dependencies based on manifests of Odoo add-ons</li> <li>hatch-requirements-txt - read project dependencies from <code>requirements.txt</code> files</li> <li>UniDep - for unified <code>pip</code> and <code>conda</code> dependency management using a single <code>requirements.yaml</code> file for both </li> </ul>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface","title":"<code>MetadataHookInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\nclass SpecialMetadataHook(MetadataHookInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialMetadataHook\n\n\n@hookimpl\ndef hatch_register_metadata_hook():\n    return SpecialMetadataHook\n</code></pre> Source code in <code>backend/src/hatchling/metadata/plugin/interface.py</code> <pre><code>class MetadataHookInterface(ABC):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\n    class SpecialMetadataHook(MetadataHookInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialMetadataHook\n\n\n    @hookimpl\n    def hatch_register_metadata_hook():\n        return SpecialMetadataHook\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root: str, config: dict) -&gt; None:\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        The hook configuration.\n\n        ```toml config-example\n        [tool.hatch.metadata.hooks.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    @abstractmethod\n    def update(self, metadata: dict) -&gt; None:\n        \"\"\"\n        This updates the metadata mapping of the `project` table in-place.\n        \"\"\"\n\n    def get_known_classifiers(self) -&gt; list[str]:  # noqa: PLR6301\n        \"\"\"\n        This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.\n        \"\"\"\n        return []\n</code></pre>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree.</p>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"<p>The hook configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[metadata.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.update","title":"<code>update(metadata: dict) -&gt; None</code>  <code>abstractmethod</code>","text":"<p>This updates the metadata mapping of the <code>project</code> table in-place.</p> Source code in <code>backend/src/hatchling/metadata/plugin/interface.py</code> <pre><code>@abstractmethod\ndef update(self, metadata: dict) -&gt; None:\n    \"\"\"\n    This updates the metadata mapping of the `project` table in-place.\n    \"\"\"\n</code></pre>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.get_known_classifiers","title":"<code>get_known_classifiers() -&gt; list[str]</code>","text":"<p>This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.</p> Source code in <code>backend/src/hatchling/metadata/plugin/interface.py</code> <pre><code>def get_known_classifiers(self) -&gt; list[str]:  # noqa: PLR6301\n    \"\"\"\n    This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.\n    \"\"\"\n    return []\n</code></pre>"},{"location":"plugins/publisher/package-index/","title":"Index publisher","text":"<p>See the documentation for publishing.</p>"},{"location":"plugins/publisher/package-index/#options","title":"Options","text":"Flag Config name Description <code>-r</code>/<code>--repo</code> <code>repo</code> The repository with which to publish artifacts <code>-u</code>/<code>--user</code> <code>user</code> The user with which to authenticate <code>-a</code>/<code>--auth</code> <code>auth</code> The credentials to use for authentication <code>--ca-cert</code> <code>ca-cert</code> The path to a CA bundle <code>--client-cert</code> <code>client-cert</code> The path to a client certificate, optionally containing the private key <code>--client-key</code> <code>client-key</code> The path to the client certificate's private key <code>repos</code> A table of named repositories to their respective options"},{"location":"plugins/publisher/package-index/#configuration","title":"Configuration","text":"<p>The publisher plugin name is <code>index</code>.</p>  config.toml <pre><code>[publish.index]\n</code></pre>"},{"location":"plugins/publisher/package-index/#repositories","title":"Repositories","text":"<p>All top-level options can be overridden per repository using the <code>repos</code> table with a required <code>url</code> attribute for each repository. The following shows the default configuration:</p>  config.toml <pre><code>[publish.index.repos.main]\nurl = \"https://upload.pypi.org/legacy/\"\n\n[publish.index.repos.test]\nurl = \"https://test.pypi.org/legacy/\"\n</code></pre> <p>The <code>repo</code> and <code>repos</code> options have no effect.</p>"},{"location":"plugins/publisher/package-index/#confirmation-prompt","title":"Confirmation prompt","text":"<p>You can require a confirmation prompt or use of the <code>-y</code>/<code>--yes</code> flag by setting publishers' <code>disable</code> option to <code>true</code> in either Hatch's config file or project-specific configuration (which takes precedence):</p>  config.toml pyproject.toml hatch.toml <pre><code>[publish.index]\ndisable = true\n</code></pre> <pre><code>[tool.hatch.publish.index]\ndisable = true\n</code></pre> <pre><code>[publish.index]\ndisable = true\n</code></pre>"},{"location":"plugins/publisher/reference/","title":"Publisher plugins","text":""},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface","title":"<code>PublisherInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>    from hatch.publish.plugin.interface import PublisherInterface\n\n\n    class SpecialPublisher(PublisherInterface):\n        PLUGIN_NAME = 'special'\n        ...\n</code></pre> <pre><code>    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialPublisher\n\n\n    @hookimpl\n    def hatch_register_publisher():\n        return SpecialPublisher\n</code></pre> Source code in <code>src/hatch/publish/plugin/interface.py</code> <pre><code>class PublisherInterface(ABC):\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n        from hatch.publish.plugin.interface import PublisherInterface\n\n\n        class SpecialPublisher(PublisherInterface):\n            PLUGIN_NAME = 'special'\n            ...\n    ```\n\n    ```python tab=\"hooks.py\"\n        from hatchling.plugin import hookimpl\n\n        from .plugin import SpecialPublisher\n\n\n        @hookimpl\n        def hatch_register_publisher():\n            return SpecialPublisher\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, app, root, cache_dir, project_config, plugin_config):\n        self.__app = app\n        self.__root = root\n        self.__cache_dir = cache_dir\n        self.__project_config = project_config\n        self.__plugin_config = plugin_config\n\n        self.__disable = None\n\n    @property\n    def app(self):\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        return self.__app\n\n    @property\n    def root(self):\n        \"\"\"\n        The root of the project tree as a path-like object.\n        \"\"\"\n        return self.__root\n\n    @property\n    def cache_dir(self):\n        \"\"\"\n        The directory reserved exclusively for this plugin as a path-like object.\n        \"\"\"\n        return self.__cache_dir\n\n    @property\n    def project_config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.publish.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__project_config\n\n    @property\n    def plugin_config(self) -&gt; dict:\n        \"\"\"\n        This is defined in Hatch's [config file](../../config/hatch.md).\n\n        ```toml tab=\"config.toml\"\n        [publish.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__plugin_config\n\n    @property\n    def disable(self):\n        \"\"\"\n        Whether this plugin is disabled, thus requiring confirmation when publishing. Local\n        [project configuration](reference.md#hatch.publish.plugin.interface.PublisherInterface.project_config)\n        takes precedence over global\n        [plugin configuration](reference.md#hatch.publish.plugin.interface.PublisherInterface.plugin_config).\n        \"\"\"\n        if self.__disable is None:\n            if 'disable' in self.project_config:\n                disable = self.project_config['disable']\n                if not isinstance(disable, bool):\n                    message = f'Field `tool.hatch.publish.{self.PLUGIN_NAME}.disable` must be a boolean'\n                    raise TypeError(message)\n            else:\n                disable = self.plugin_config.get('disable', False)\n                if not isinstance(disable, bool):\n                    message = f'Global plugin configuration `publish.{self.PLUGIN_NAME}.disable` must be a boolean'\n                    raise TypeError(message)\n\n            self.__disable = disable\n\n        return self.__disable\n\n    @abstractmethod\n    def publish(self, artifacts: list[str], options: dict):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This is called directly by the [`publish`](../../cli/reference.md#hatch-publish) command\n        with the arguments and options it receives.\n        \"\"\"\n</code></pre>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.app","title":"<code>app</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.root","title":"<code>root</code>  <code>property</code>","text":"<p>The root of the project tree as a path-like object.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.cache_dir","title":"<code>cache_dir</code>  <code>property</code>","text":"<p>The directory reserved exclusively for this plugin as a path-like object.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.project_config","title":"<code>project_config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.publish.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[publish.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.plugin_config","title":"<code>plugin_config: dict</code>  <code>property</code>","text":"<p>This is defined in Hatch's config file.</p>  config.toml <pre><code>[publish.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.disable","title":"<code>disable</code>  <code>property</code>","text":"<p>Whether this plugin is disabled, thus requiring confirmation when publishing. Local project configuration takes precedence over global plugin configuration.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.publish","title":"<code>publish(artifacts: list[str], options: dict)</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This is called directly by the <code>publish</code> command with the arguments and options it receives.</p> Source code in <code>src/hatch/publish/plugin/interface.py</code> <pre><code>@abstractmethod\ndef publish(self, artifacts: list[str], options: dict):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This is called directly by the [`publish`](../../cli/reference.md#hatch-publish) command\n    with the arguments and options it receives.\n    \"\"\"\n</code></pre>"},{"location":"plugins/version-scheme/reference/","title":"Version scheme plugins","text":""},{"location":"plugins/version-scheme/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-semver - uses semantic versioning</li> </ul>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface","title":"<code>VersionSchemeInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.version.scheme.plugin.interface import VersionSchemeInterface\n\n\nclass SpecialVersionScheme(VersionSchemeInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialVersionScheme\n\n\n@hookimpl\ndef hatch_register_version_scheme():\n    return SpecialVersionScheme\n</code></pre> Source code in <code>backend/src/hatchling/version/scheme/plugin/interface.py</code> <pre><code>class VersionSchemeInterface(ABC):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.version.scheme.plugin.interface import VersionSchemeInterface\n\n\n    class SpecialVersionScheme(VersionSchemeInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialVersionScheme\n\n\n    @hookimpl\n    def hatch_register_version_scheme():\n        return SpecialVersionScheme\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root: str, config: dict) -&gt; None:\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree as a string.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.version]\n        ```\n        \"\"\"\n        return self.__config\n\n    @abstractmethod\n    def update(self, desired_version: str, original_version: str, version_data: dict) -&gt; str:\n        \"\"\"\n        This should return a normalized form of the desired version and verify that it\n        is higher than the original version.\n        \"\"\"\n</code></pre>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree as a string.</p>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\n</code></pre> <pre><code>[version]\n</code></pre>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.update","title":"<code>update(desired_version: str, original_version: str, version_data: dict) -&gt; str</code>  <code>abstractmethod</code>","text":"<p>This should return a normalized form of the desired version and verify that it is higher than the original version.</p> Source code in <code>backend/src/hatchling/version/scheme/plugin/interface.py</code> <pre><code>@abstractmethod\ndef update(self, desired_version: str, original_version: str, version_data: dict) -&gt; str:\n    \"\"\"\n    This should return a normalized form of the desired version and verify that it\n    is higher than the original version.\n    \"\"\"\n</code></pre>"},{"location":"plugins/version-scheme/standard/","title":"Standard version scheme","text":"<p>See the documentation for versioning.</p>"},{"location":"plugins/version-scheme/standard/#configuration","title":"Configuration","text":"<p>The version scheme plugin name is <code>standard</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nscheme = \"standard\"\n</code></pre> <pre><code>[version]\nscheme = \"standard\"\n</code></pre>"},{"location":"plugins/version-scheme/standard/#options","title":"Options","text":"Option Description <code>validate-bump</code> When setting a specific version, this determines whether to check that the new version is higher than the original. The default is <code>true</code>."},{"location":"plugins/version-source/code/","title":"Code version source","text":""},{"location":"plugins/version-source/code/#updates","title":"Updates","text":"<p>Setting the version is not supported.</p>"},{"location":"plugins/version-source/code/#configuration","title":"Configuration","text":"<p>The version source plugin name is <code>code</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"code\"\n</code></pre> <pre><code>[version]\nsource = \"code\"\n</code></pre>"},{"location":"plugins/version-source/code/#options","title":"Options","text":"Option Description <code>path</code> (required) A relative path to a Python file or extension module that will be loaded <code>expression</code> A Python expression that when evaluated in the context of the loaded file returns the version. The default expression is simply <code>__version__</code>. <code>search-paths</code> A list of relative paths to directories that will be prepended to Python's search path"},{"location":"plugins/version-source/code/#missing-imports","title":"Missing imports","text":"<p>If the chosen path imports another module in your project, then you'll need to use absolute imports coupled with the <code>search-paths</code> option. For example, say you need to load the following file:</p>  src/pkg/__init__.py <pre><code>    from ._version import get_version\n\n    __version__ = get_version()\n</code></pre> <p>You should change it to:</p>  src/pkg/__init__.py <pre><code>    from pkg._version import get_version\n\n    __version__ = get_version()\n</code></pre> <p>and the configuration would become:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"code\"\npath = \"src/pkg/__init__.py\"\nsearch-paths = [\"src\"]\n</code></pre> <pre><code>[version]\nsource = \"code\"\npath = \"src/pkg/__init__.py\"\nsearch-paths = [\"src\"]\n</code></pre>"},{"location":"plugins/version-source/env/","title":"Environment version source","text":"<p>Retrieves the version from an environment variable. This can be useful in build pipelines where the version is set by an external trigger.</p>"},{"location":"plugins/version-source/env/#updates","title":"Updates","text":"<p>Setting the version is not supported.</p>"},{"location":"plugins/version-source/env/#configuration","title":"Configuration","text":"<p>The version source plugin name is <code>env</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"env\"\n</code></pre> <pre><code>[version]\nsource = \"env\"\n</code></pre>"},{"location":"plugins/version-source/env/#options","title":"Options","text":"Option Description <code>variable</code> (required) The name of the environment variable"},{"location":"plugins/version-source/reference/","title":"Version source plugins","text":""},{"location":"plugins/version-source/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-vcs - uses your preferred version control system (like Git)</li> <li>hatch-nodejs-version - uses the <code>version</code> field of NodeJS <code>package.json</code> files</li> <li>hatch-regex-commit - automatically creates a Git commit and tag after version bumping</li> <li>versioningit - determines version from Git or Mercurial tags, with customizable version formatting</li> </ul>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface","title":"<code>VersionSourceInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.version.source.plugin.interface import VersionSourceInterface\n\n\nclass SpecialVersionSource(VersionSourceInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialVersionSource\n\n\n@hookimpl\ndef hatch_register_version_source():\n    return SpecialVersionSource\n</code></pre> Source code in <code>backend/src/hatchling/version/source/plugin/interface.py</code> <pre><code>class VersionSourceInterface(ABC):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.version.source.plugin.interface import VersionSourceInterface\n\n\n    class SpecialVersionSource(VersionSourceInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialVersionSource\n\n\n    @hookimpl\n    def hatch_register_version_source():\n        return SpecialVersionSource\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root: str, config: dict) -&gt; None:\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree as a string.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.version]\n        ```\n        \"\"\"\n        return self.__config\n\n    @abstractmethod\n    def get_version_data(self) -&gt; dict:\n        \"\"\"\n        This should return a mapping with a `version` key representing the current version of the project and will be\n        displayed when invoking the [`version`](../../cli/reference.md#hatch-version) command without any arguments.\n\n        The mapping can contain anything else and will be passed to\n        [set_version](reference.md#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version)\n        when updating the version.\n        \"\"\"\n\n    def set_version(self, version: str, version_data: dict) -&gt; None:\n        \"\"\"\n        This should update the version to the first argument with the data provided during retrieval.\n        \"\"\"\n        raise NotImplementedError\n</code></pre>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree as a string.</p>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\n</code></pre> <pre><code>[version]\n</code></pre>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.get_version_data","title":"<code>get_version_data() -&gt; dict</code>  <code>abstractmethod</code>","text":"<p>This should return a mapping with a <code>version</code> key representing the current version of the project and will be displayed when invoking the <code>version</code> command without any arguments.</p> <p>The mapping can contain anything else and will be passed to set_version when updating the version.</p> Source code in <code>backend/src/hatchling/version/source/plugin/interface.py</code> <pre><code>@abstractmethod\ndef get_version_data(self) -&gt; dict:\n    \"\"\"\n    This should return a mapping with a `version` key representing the current version of the project and will be\n    displayed when invoking the [`version`](../../cli/reference.md#hatch-version) command without any arguments.\n\n    The mapping can contain anything else and will be passed to\n    [set_version](reference.md#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version)\n    when updating the version.\n    \"\"\"\n</code></pre>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version","title":"<code>set_version(version: str, version_data: dict) -&gt; None</code>","text":"<p>This should update the version to the first argument with the data provided during retrieval.</p> Source code in <code>backend/src/hatchling/version/source/plugin/interface.py</code> <pre><code>def set_version(self, version: str, version_data: dict) -&gt; None:\n    \"\"\"\n    This should update the version to the first argument with the data provided during retrieval.\n    \"\"\"\n    raise NotImplementedError\n</code></pre>"},{"location":"plugins/version-source/regex/","title":"Regex version source","text":"<p>See the documentation for versioning.</p>"},{"location":"plugins/version-source/regex/#updates","title":"Updates","text":"<p>Setting the version is supported.</p>"},{"location":"plugins/version-source/regex/#configuration","title":"Configuration","text":"<p>The version source plugin name is <code>regex</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"regex\"\n</code></pre> <pre><code>[version]\nsource = \"regex\"\n</code></pre>"},{"location":"plugins/version-source/regex/#options","title":"Options","text":"Option Description <code>path</code> (required) A relative path to a file containing the project's version <code>pattern</code> A regular expression that has a named group called <code>version</code> that represents the version. The default pattern looks for a variable named <code>__version__</code> or <code>VERSION</code> that is set to a string containing the version, optionally prefixed with the lowercase letter <code>v</code>."},{"location":"tutorials/environment/basic-usage/","title":"Managing environments","text":"<p>Hatch environments are isolated workspaces that can be used for project tasks including running tests, building documentation and running code formatters and linters.</p>"},{"location":"tutorials/environment/basic-usage/#the-default-environment","title":"The default environment","text":"<p>When you start using Hatch, you can create the <code>default</code> environment. To do this use the <code>env create</code> command:</p> <pre><code>hatch env create\n</code></pre> <p>This will not only create will the <code>default</code> environment for you to work in but will also install your project in dev mode in this <code>default</code> environment.</p> <p>Tip</p> <p>You never need to manually create environments as spawning a shell or running commands within one will automatically trigger creation.</p>"},{"location":"tutorials/environment/basic-usage/#using-the-default-environment","title":"Using the default environment","text":"<p>Hatch will always use the <code>default</code> environment if an environment is not chosen explicitly when running a command.</p> <p>For instance, the following shows how to get version information for the Python in use.</p> <pre><code>$ hatch run python -V\nPython 3.12.1\n</code></pre>"},{"location":"tutorials/environment/basic-usage/#configure-the-default-environment","title":"Configure the default environment","text":"<p>You can customize the tools that are installed into the <code>default</code> environment by adding a table called <code>tool.hatch.envs.default</code> to your <code>pyproject.toml</code> file. Below is an example of adding the dependencies <code>pydantic</code> and <code>numpy</code> to the <code>default</code> environment.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"pydantic\",\n  \"numpy\",\n]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"pydantic\",\n  \"numpy\",\n]\n</code></pre> <p>You can declare versions for your dependencies as well within this configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"pydantic&gt;=2.0\",\n  \"numpy\",\n]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"pydantic&gt;=2.0\",\n  \"numpy\",\n]\n</code></pre>"},{"location":"tutorials/environment/basic-usage/#create-custom-environment","title":"Create custom environment","text":"<p>You can create custom environments in Hatch by adding a section to your <code>pyproject.toml</code> file <code>[tool.hatch.envs.&lt;ENV_NAME&gt;]</code>. Below you define an environment called <code>test</code> and you add the <code>pytest</code> and <code>pytest-cov</code> dependencies to that environment's configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"pytest\",\n  \"pytest-cov\"\n]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"pytest\",\n  \"pytest-cov\"\n]\n</code></pre> <p>The first time that you call the test environment, Hatch will:</p> <ol> <li>Create the environment</li> <li>Install your project into that environment in dev mode (by default) along with its dependencies.</li> <li>Install the environment's dependencies</li> </ol>"},{"location":"tutorials/environment/basic-usage/#run-commands-within-a-specific-environment","title":"Run commands within a specific environment","text":"<p>Hatch offers a unique environment feature that allows you run a specific command within a specific environment rather than needing to activate the environment as you would using a tool such as Conda or venv.</p> <p>For instance, if you define an environment called <code>test</code> that contains the dependencies from the previous section, you can run the <code>pytest</code> command from the <code>test</code> environment using the syntax:</p> <pre><code>hatch run &lt;ENV_NAME&gt;:command\n</code></pre> <p>To access the <code>test</code> environment and run <code>pytest</code>, you can run:</p> <pre><code>$ hatch run test:pytest\n============================== test session starts ===============================\nplatform darwin -- Python 3.12.1, pytest-7.4.4, pluggy-1.3.0\nrootdir: /your/path/to/yourproject\ncollected 0 items\n</code></pre> <p>Note</p> <p><code>test:pytest</code> represents the name of the environment to call (<code>test</code>) and the command to run (<code>pytest</code>).</p>"},{"location":"tutorials/environment/basic-usage/#view-current-environments","title":"View current environments","text":"<p>Above you defined and created a new test environment in your <code>pyproject.toml</code> file. You can now use the <code>env show</code> command to see both the currently created environments and the dependencies in each environment.</p> <pre><code>$ hatch env show\n             Standalone\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n\u2503 Name    \u2503 Type    \u2503 Dependencies \u2503\n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n\u2502 default \u2502 virtual \u2502              \u2502\n\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n\u2502 test    \u2502 virtual \u2502 pytest       \u2502\n\u2502         \u2502         \u2502 pytest-cov   \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n</code></pre> <p>Note</p> <p>The output may have more columns depending on your environment configuration.</p>"},{"location":"tutorials/environment/basic-usage/#locating-environments","title":"Locating environments","text":"<p>To see where your current environment is located you can use the <code>env find</code> command.</p> <pre><code>$ hatch env find test\n/your/path/Application Support/hatch/env/virtual/yourproject/twO2iQR3/test\n</code></pre> <p>Note</p> <p>That path is what you would see on macOS but differs for each platform, and is configurable.</p>"},{"location":"tutorials/environment/basic-usage/#launching-a-shell-within-a-specific-environment","title":"Launching a shell within a specific environment","text":"<p>If you wish to launch a shell for a specific environment that you have created, like the previous <code>test</code> environment, you can use:</p> <pre><code>hatch -e test shell\n</code></pre> <p>Once the environment is active, you can run commands like you would in any Python environment.</p> <p>Notice below that when running <code>pip list</code> in the test environment, you can see:</p> <ol> <li>That you package is installed in editable mode.</li> <li>That the environment contains both <code>pytest</code> and <code>pytest-cov</code> as specified above in the <code>pyproject.toml</code> file.</li> </ol> <pre><code>$ pip list\nPackage     Version Editable project location\n----------- ------- ----------------------------------------------------\ncoverage    7.4.1\niniconfig   2.0.0\npackaging   23.2\npip         23.3.1\npluggy      1.4.0\npytest      8.0.0\npytest-cov  4.1.0\nyourproject 0.1.0  /your/path/to/yourproject\n</code></pre>"},{"location":"tutorials/environment/basic-usage/#conda-environments","title":"Conda environments","text":"<p>If you prefer to use Conda environments with Hatch, you can check out the hatch-conda plugin.</p>"},{"location":"tutorials/testing/overview/","title":"Testing projects","text":"<p>The <code>test</code> command (by default) uses pytest with select plugins and coverage.py. View the testing configuration for more information.</p> <p>The majority of projects can be fully tested this way without the need for custom environments.</p>"},{"location":"tutorials/testing/overview/#passing-arguments","title":"Passing arguments","text":"<p>When you run the <code>test</code> command without any arguments, <code>tests</code> is passed as the default argument to <code>pytest</code> (this assumes that you have a <code>tests</code> directory). For example, the following command invocation:</p> <pre><code>hatch test\n</code></pre> <p>would be translated roughly to:</p> <pre><code>pytest tests\n</code></pre> <p>You can pass arguments to <code>pytest</code> by appending them to the <code>test</code> command. For example, the following command invocation:</p> <pre><code>hatch test -vv tests/test_foo.py::test_bar\n</code></pre> <p>would be translated roughly to:</p> <pre><code>pytest -vv tests/test_foo.py::test_bar\n</code></pre> <p>You can force the treatment of arguments as positional by using the <code>--</code> separator, especially useful when built-in flags of the <code>test</code> command conflict with those of <code>pytest</code>, such as the <code>--help</code> flag. For example, the following command invocation:</p> <pre><code>hatch test -r -- -r fE -- tests\n</code></pre> <p>would be translated roughly to:</p> <pre><code>pytest -r fE -- tests\n</code></pre> <p>Note</p> <p>It's important to ensure that <code>pytest</code> receives an argument instructing what to run/where to locate tests. It's default behavior is <code>.</code> meaning that it will exhaustively search for tests in the current directory. This can not just be slow but also lead to unexpected behavior.</p>"},{"location":"tutorials/testing/overview/#environment-selection","title":"Environment selection","text":""},{"location":"tutorials/testing/overview/#single-environment","title":"Single environment","text":"<p>If no environment options are selected, the <code>test</code> command will only run tests in the first defined environment that either already exists or is compatible. Additionally, the checking order will prioritize environments that define a version of Python that matches the interpreter that Hatch is running on.</p> <p>For example, if you overrode the default matrix as follows:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\n\n[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.11\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\n\n[[envs.hatch-test.matrix]]\npython = [\"3.11\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>the expanded environments would normally be:</p> <pre><code>hatch-test.py3.12\nhatch-test.py3.11\nhatch-test.py3.11-foo\nhatch-test.py3.11-bar\n</code></pre> <p>If you install Hatch on Python 3.11, the checking order would be:</p> <pre><code>hatch-test.py3.11\nhatch-test.py3.11-foo\nhatch-test.py3.11-bar\nhatch-test.py3.12\n</code></pre> <p>Note</p> <p>If you installed Hatch with an official installer or are using one of the standalone binaries, the version of Python that Hatch runs on is out of your control. If you are relying on the single environment resolution behavior, consider explicitly selecting environments based on the Python version instead.</p>"},{"location":"tutorials/testing/overview/#all-environments","title":"All environments","text":"<p>You can run tests in all compatible environments by using the <code>--all</code> flag. For example, say you defined the matrix and overrides as follows:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\"]\n\n[tool.hatch.envs.hatch-test.overrides]\nmatrix.feature.platforms = [\n  { value = \"linux\", if = [\"foo\", \"bar\"] },\n  { value = \"windows\", if = [\"foo\"] },\n  { value = \"macos\", if = [\"bar\"] },\n]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\"]\n\n[envs.hatch-test.overrides]\nmatrix.feature.platforms = [\n  { value = \"linux\", if = [\"foo\", \"bar\"] },\n  { value = \"windows\", if = [\"foo\"] },\n  { value = \"macos\", if = [\"bar\"] },\n]\n</code></pre> <p>The following table shows the environments in which tests would be run:</p> Environment Linux Windows macOS <code>hatch-test.py3.12-foo</code> <code>hatch-test.py3.12-bar</code> <code>hatch-test.py3.11-foo</code> <code>hatch-test.py3.11-bar</code>"},{"location":"tutorials/testing/overview/#specific-environments","title":"Specific environments","text":"<p>You can select subsets of environments by using the <code>--include</code>/<code>-i</code> and <code>--exclude</code>/<code>-x</code> options. These options may be used to include or exclude certain matrix variables, optionally followed by specific comma-separated values, and may be selected multiple times.</p> <p>For example, say you defined the matrix as follows:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\", \"baz\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\", \"baz\"]\n</code></pre> <p>If you wanted to run tests in all environments that have Python 3.12 and either the <code>foo</code> or <code>bar</code> feature, you could use the following command invocation:</p> <pre><code>hatch test -i python=3.12 -i feature=foo,bar\n</code></pre> <p>Alternatively, we could exclude the <code>baz</code> feature to achieve the same result:</p> <pre><code>hatch test -i python=3.12 -x feature=baz\n</code></pre> <p>Tip</p> <p>Since selecting the version of Python is a common use case, you can use the <code>--python</code>/<code>-py</code> option as a shorthand. For example, the previous commands could have been written as:</p> <pre><code>hatch test -py 3.12 -i feature=foo,bar\nhatch test -py 3.12 -x feature=baz\n</code></pre>"},{"location":"tutorials/testing/overview/#measuring-code-coverage","title":"Measuring code coverage","text":"<p>You can enable code coverage by using the <code>--cover</code> flag. For example, the following command invocation:</p> <pre><code>hatch test --cover\n</code></pre> <p>would be translated roughly to:</p> <pre><code>coverage run -m pytest tests\n</code></pre> <p>After tests run in all of the selected environments, the coverage data is combined and a report is shown. The <code>--cover-quiet</code> flag can be used to suppress the report and implicitly enables the <code>--cover</code> flag:</p> <pre><code>hatch test --cover-quiet\n</code></pre> <p>Note</p> <p>Coverage data files are generated at the root of the project. Be sure to exclude them from version control with the following glob-style pattern:</p> <pre><code>.coverage*\n</code></pre>"},{"location":"tutorials/testing/overview/#retry-failed-tests","title":"Retry failed tests","text":"<p>You can retry failed tests with the <code>--retries</code> option:</p> <pre><code>hatch test --retries 2\n</code></pre> <p>If a test fails every time and the number of retries is set to <code>2</code>, the test will be run a total of three times.</p> <p>You can also set the number of seconds to wait between retries with the <code>--retry-delay</code> option:</p> <pre><code>hatch test --retries 2 --retry-delay 1\n</code></pre>"},{"location":"tutorials/testing/overview/#parallelize-test-execution","title":"Parallelize test execution","text":"<p>You can parallelize test execution with the <code>--parallel</code>/<code>-p</code> flag:</p> <pre><code>hatch test --parallel\n</code></pre> <p>This distributes tests within an environment across multiple workers. The number of workers corresponds to the number of logical rather than physical CPUs that are available.</p>"},{"location":"tutorials/testing/overview/#randomize-test-order","title":"Randomize test order","text":"<p>You can randomize the order of tests with the <code>--randomize</code>/<code>-r</code> flag:</p> <pre><code>hatch test --randomize\n</code></pre>"},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/archive/2022/","title":"2022","text":""},{"location":"blog/category/release/","title":"Release","text":""}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"],"fields":{"title":{"boost":1000.0},"text":{"boost":1.0},"tags":{"boost":1000000.0}}},"docs":[{"location":"","title":"Hatch","text":"CI/CD Docs Package Meta <p>Hatch is a modern, extensible Python project manager. See the Why Hatch? page for more information.</p> <ul> <li> <p> Build system</p> <p>Reproducible builds by default with a rich ecosystem of plugins</p> <p> Configure builds</p> </li> <li> <p> Environments</p> <p>Robust environment management with support for custom scripts</p> <p> Getting started</p> </li> <li> <p> Python management</p> <p>Choose between easy manual installations or automatic as part of environments</p> <p> Try it</p> </li> <li> <p> Testing</p> <p>Test execution with known best practices</p> <p> Run</p> </li> <li> <p> Static analysis</p> <p>Static analysis backed by Ruff with up-to-date, sane defaults</p> <p> Learn</p> </li> <li> <p> Publishing</p> <p>Easily upload to PyPI or other indices</p> <p> See how</p> </li> <li> <p> Versioning</p> <p>Streamlined workflow for bumping versions</p> <p> Managing versions</p> </li> <li> <p> Project generation</p> <p>Create new projects from templates with known best practices</p> <p> Project setup</p> </li> <li> <p> Responsive CLI</p> <p>Hatch is up to 3x faster than equivalent tools</p> <p> CLI reference</p> </li> </ul>"},{"location":"#license","title":"License","text":"<p>Hatch is distributed under the terms of the MIT license.</p>"},{"location":"#navigation","title":"Navigation","text":"<p>Documentation for specific <code>MAJOR.MINOR</code> versions can be chosen by using the dropdown on the top of every page. The <code>dev</code> version reflects changes that have not yet been released.</p> <p>Also, desktop readers can use special keyboard shortcuts:</p> Keys Action <ul><li>, (comma)</li><li>p</li></ul> Navigate to the \"previous\" page <ul><li>. (period)</li><li>n</li></ul> Navigate to the \"next\" page <ul><li>/</li><li>s</li></ul> Display the search modal"},{"location":"build/","title":"Builds","text":""},{"location":"build/#configuration","title":"Configuration","text":"<p>Builds are configured using the <code>tool.hatch.build</code> table. Every target is defined by a section within <code>tool.hatch.build.targets</code>, for example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\nexclude = [\n  \"/.github\",\n  \"/docs\",\n]\n\n[tool.hatch.build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre> <pre><code>[build.targets.sdist]\nexclude = [\n  \"/.github\",\n  \"/docs\",\n]\n\n[build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre>"},{"location":"build/#building","title":"Building","text":"<p>Invoking the <code>build</code> command without any arguments will build the sdist and wheel targets:</p> <pre><code>$ hatch build\n[sdist]\ndist/hatch_demo-1rc0.tar.gz\n\n[wheel]\ndist/hatch_demo-1rc0-py3-none-any.whl\n</code></pre> <p>To only build specific targets, use the <code>-t</code>/<code>--target</code> option:</p> <pre><code>$ hatch build -t wheel\n[wheel]\ndist/hatch_demo-1rc0-py3-none-any.whl\n</code></pre> <p>If the target supports multiple versions, you can specify the exact versions to build by appending a colon followed by the desired versions separated by commas:</p> <pre><code>$ hatch -v build -t wheel:standard\n[wheel]\nBuilding `wheel` version `standard`\ndist/hatch_demo-1rc0-py3-none-any.whl\n</code></pre>"},{"location":"build/#packaging-ecosystem","title":"Packaging ecosystem","text":"<p>Hatch complies with modern Python packaging specs and therefore your projects can be used by other tools with Hatch serving as just the build backend.</p> <p>So you could use tox as an alternative to Hatch's environment management, or cibuildwheel to distribute packages for every platform, and they both will transparently use Hatch without any extra modification.</p>"},{"location":"environment/","title":"Environments","text":"<p>Environments are designed to allow for isolated workspaces for testing, building documentation, or anything else projects need.</p> <p>Unless an environment is chosen explicitly, Hatch will use the <code>default</code> environment.</p> <p>Tip</p> <p>For a more comprehensive walk-through, see the Basic usage tutorial.</p>"},{"location":"environment/#creation","title":"Creation","text":"<p>You can create environments by using the <code>env create</code> command. Let's enter the directory of the project we created in the setup phase:</p> <pre><code>$ hatch env create\nCreating environment: default\nInstalling project in development mode\nSyncing dependencies\n</code></pre> <p>Tip</p> <p>You never need to manually create environments as spawning a shell or running commands within one will automatically trigger creation.</p>"},{"location":"environment/#entering-environments","title":"Entering environments","text":"<p>You can spawn a shell within an environment by using the <code>shell</code> command.</p> <pre><code>$ hatch shell\n(hatch-demo) $\n</code></pre> <p>Now confirm the project has been installed:</p> <pre><code>(hatch-demo) $ pip show hatch-demo\nName: hatch-demo\nVersion: 0.0.1\n...\n</code></pre> <p>Finally, see where your environment's Python is located:</p> <pre><code>(hatch-demo) $ python -c \"import sys;print(sys.executable)\"\n...\n</code></pre> <p>You can type <code>exit</code> to leave the environment.</p>"},{"location":"environment/#command-execution","title":"Command execution","text":"<p>The <code>run</code> command allows you to execute commands in an environment as if you had already entered it. For example, running the following command will output the same path as before:</p> <pre><code>hatch run python -c \"import sys;print(sys.executable)\"\n</code></pre> <p>Tip</p> <p>Be sure to check out how to define scripts for your project.</p>"},{"location":"environment/#dependencies","title":"Dependencies","text":"<p>Hatch ensures that environments are always compatible with the currently defined project dependencies (if installed and in dev mode) and environment dependencies.</p> <p>To add <code>cowsay</code> as a dependency, open <code>pyproject.toml</code> and add it to the <code>dependencies</code> array:</p>  pyproject.toml <pre><code>[project]\n...\ndependencies = [\n  \"cowsay\"\n]\n</code></pre> <p>This dependency will be installed the next time you spawn a shell or run a command. For example:</p> <pre><code>$ hatch run cowsay -t \"Hello, world!\"\nSyncing dependencies\n  _____________\n| Hello, world! |\n  =============\n             \\\n              \\\n                ^__^\n                (oo)\\_______\n                (__)\\       )\\/\\\n                    ||----w |\n                    ||     ||\n</code></pre> <p>Note</p> <p>The <code>Syncing dependencies</code> status will display temporarily when Hatch updates environments in response to any dependency changes that you make.</p>"},{"location":"environment/#selection","title":"Selection","text":"<p>You can select which environment to enter or run commands in by using the <code>-e</code>/<code>--env</code> root option or by setting the <code>HATCH_ENV</code> environment variable.</p> <p>The <code>run</code> command allows for more explicit selection by prepending <code>&lt;ENV_NAME&gt;:</code> to commands. For example, if you had the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[tool.hatch.envs.docs.scripts]\nbuild = \"mkdocs build --clean --strict\"\nserve = \"mkdocs serve --dev-addr localhost:8000\"\n</code></pre> <pre><code>[envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[envs.docs.scripts]\nbuild = \"mkdocs build --clean --strict\"\nserve = \"mkdocs serve --dev-addr localhost:8000\"\n</code></pre> <p>you could then serve your documentation by running:</p> <pre><code>hatch run docs:serve\n</code></pre> <p>Tip</p> <p>If you've already entered an environment, commands will target it by default.</p>"},{"location":"environment/#matrix","title":"Matrix","text":"<p>Every environment can define its own set of matrices:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre> <p>Using the <code>env show</code> command would then display:</p> <pre><code>$ hatch env show --ascii\n     Standalone\n+---------+---------+\n| Name    | Type    |\n+=========+=========+\n| default | virtual |\n+---------+---------+\n                       Matrices\n+------+---------+---------------------+--------------+\n| Name | Type    | Envs                | Dependencies |\n+======+=========+=====================+==============+\n| test | virtual | test.py2.7-42       | pytest       |\n|      |         | test.py2.7-3.14     |              |\n|      |         | test.py3.8-42       |              |\n|      |         | test.py3.8-3.14     |              |\n|      |         | test.py3.8-9000-foo |              |\n|      |         | test.py3.8-9000-bar |              |\n|      |         | test.py3.9-9000-foo |              |\n|      |         | test.py3.9-9000-bar |              |\n+------+---------+---------------------+--------------+\n</code></pre>"},{"location":"environment/#removal","title":"Removal","text":"<p>You can remove a single environment or environment matrix by using the <code>env remove</code> command or all of a project's environments by using the <code>env prune</code> command.</p>"},{"location":"install/","title":"Installation","text":""},{"location":"install/#installers","title":"Installers","text":"macOSWindows GUI installerCommand line installer <ol> <li>In your browser, download the <code>.pkg</code> file: hatch-1.9.1.pkg</li> <li>Run your downloaded file and follow the on-screen instructions.</li> <li>Restart your terminal.</li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol> <ol> <li> <p>Download the file using the <code>curl</code> command. The <code>-o</code> option specifies the file name that the downloaded package is written to. In this example, the file is written to <code>hatch-1.9.1.pkg</code> in the current directory.</p> <pre><code>curl -o hatch-1.9.1.pkg https://github.com/pypa/hatch/releases/download/hatch-v1.9.1/hatch-1.9.1.pkg\n</code></pre> </li> <li> <p>Run the standard macOS <code>installer</code> program, specifying the downloaded <code>.pkg</code> file as the source. Use the <code>-pkg</code> parameter to specify the name of the package to install, and the <code>-target /</code> parameter for the drive in which to install the package. The files are installed to <code>/usr/local/hatch</code>, and an entry is created at <code>/etc/paths.d/hatch</code> that instructs shells to add the <code>/usr/local/hatch</code> directory to. You must include sudo on the command to grant write permissions to those folders.</p> <pre><code>sudo installer -pkg ./hatch-1.9.1.pkg -target /\n</code></pre> </li> <li> <p>Restart your terminal.</p> </li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol> GUI installerCommand line installer <ol> <li>In your browser, download one the <code>.msi</code> files:<ul> <li>hatch-1.9.1-x64.msi</li> </ul> </li> <li>Run your downloaded file and follow the on-screen instructions.</li> <li>Restart your terminal.</li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol> <ol> <li> <p>Download and run the installer using the standard Windows <code>msiexec</code> program, specifying one of the <code>.msi</code> files as the source. Use the <code>/passive</code> and <code>/i</code> parameters to request an unattended, normal installation.</p> x64x86 <pre><code>msiexec /passive /i https://github.com/pypa/hatch/releases/download/hatch-v1.9.1/hatch-1.9.1-x64.msi\n</code></pre> <pre><code>msiexec /passive /i https://github.com/pypa/hatch/releases/download/hatch-v1.9.1/hatch-1.9.1-x86.msi\n</code></pre> </li> <li> <p>Restart your terminal.</p> </li> <li> <p>To verify that the shell can find and run the <code>hatch</code> command in your <code>PATH</code>, use the following command.</p> <pre><code>$ hatch --version\n1.9.1\n</code></pre> </li> </ol>"},{"location":"install/#standalone-binaries","title":"Standalone binaries","text":"<p>After downloading the archive corresponding to your platform and architecture, extract the binary to a directory that is on your PATH and rename to <code>hatch</code>.</p> LinuxmacOSWindows <ul> <li>hatch-1.9.1-aarch64-unknown-linux-gnu.tar.gz</li> <li>hatch-1.9.1-x86_64-unknown-linux-gnu.tar.gz</li> <li>hatch-1.9.1-x86_64-unknown-linux-musl.tar.gz</li> <li>hatch-1.9.1-i686-unknown-linux-gnu.tar.gz</li> <li>hatch-1.9.1-powerpc64le-unknown-linux-gnu.tar.gz</li> </ul> <ul> <li>hatch-1.9.1-aarch64-apple-darwin.tar.gz</li> <li>hatch-1.9.1-x86_64-apple-darwin.tar.gz</li> </ul> <ul> <li>hatch-1.9.1-x86_64-pc-windows-msvc.zip</li> <li>hatch-1.9.1-i686-pc-windows-msvc.zip</li> </ul>"},{"location":"install/#pip","title":"pip","text":"<p>Hatch is available on PyPI and can be installed with pip.</p> <pre><code>pip install hatch\n</code></pre> <p>Warning</p> <p>This method modifies the Python environment in which you choose to install. Consider instead using pipx to avoid dependency conflicts.</p>"},{"location":"install/#pipx","title":"pipx","text":"<p>pipx allows for the global installation of Python applications in isolated environments.</p> <pre><code>pipx install hatch\n</code></pre>"},{"location":"install/#homebrew","title":"Homebrew","text":"<p>See the formula for more details.</p> <pre><code>brew install hatch\n</code></pre>"},{"location":"install/#conda","title":"Conda","text":"<p>See the feedstock for more details.</p> <pre><code>conda install -c conda-forge hatch\n</code></pre> <p>or with mamba:</p> <pre><code>mamba install hatch\n</code></pre> <p>Warning</p> <p>This method modifies the Conda environment in which you choose to install. Consider instead using pipx or condax to avoid dependency conflicts.</p>"},{"location":"install/#macports","title":"MacPorts","text":"<p>See the port for more details.</p> <pre><code>sudo port install hatch\n</code></pre>"},{"location":"install/#fedora","title":"Fedora","text":"<p>The minimum supported version is 37, currently in development as Rawhide.</p> <pre><code>sudo dnf install hatch\n</code></pre>"},{"location":"install/#void-linux","title":"Void Linux","text":"<pre><code>xbps-install hatch\n</code></pre>"},{"location":"install/#build-system-availability","title":"Build system availability","text":"<p>Hatchling is Hatch's build backend which you will never need to install manually. See its changelog for version information.</p> <p></p>"},{"location":"intro/","title":"Introduction","text":""},{"location":"intro/#setup","title":"Setup","text":"<p>Projects can be set up for use by Hatch using the <code>new</code> command.</p>"},{"location":"intro/#new-project","title":"New project","text":"<p>Let's say you want to create a project named <code>Hatch Demo</code>. You would run:</p> <pre><code>hatch new \"Hatch Demo\"\n</code></pre> <p>This would create the following structure in your current working directory:</p> <pre><code>hatch-demo\n\u251c\u2500\u2500 src\n\u2502   \u2514\u2500\u2500 hatch_demo\n\u2502       \u251c\u2500\u2500 __about__.py\n\u2502       \u2514\u2500\u2500 __init__.py\n\u251c\u2500\u2500 tests\n\u2502   \u2514\u2500\u2500 __init__.py\n\u251c\u2500\u2500 LICENSE.txt\n\u251c\u2500\u2500 README.md\n\u2514\u2500\u2500 pyproject.toml\n</code></pre> <p>Tip</p> <p>There are many ways to customize project generation.</p>"},{"location":"intro/#existing-project","title":"Existing project","text":"<p>To initialize an existing project, enter the directory containing the project and run the following:</p> <pre><code>hatch new --init\n</code></pre> <p>If your project has a <code>setup.py</code> file the command will automatically migrate <code>setuptools</code> configuration for you. Otherwise, this will interactively guide you through the setup process.</p>"},{"location":"intro/#project-metadata","title":"Project metadata","text":"<p>Next you'll want to define more of your project's metadata located in the <code>pyproject.toml</code> file. You can specify things like its license, the supported versions of Python, and URLs referring to various parts of your project, like documentation.</p>"},{"location":"intro/#dependencies","title":"Dependencies","text":"<p>The last step of the setup process is to define any dependencies that you'd like your project to begin with.</p>"},{"location":"intro/#configuration","title":"Configuration","text":"<p>All project-specific configuration recognized by Hatch can be defined in either the <code>pyproject.toml</code> file, or a file named <code>hatch.toml</code> where options are not contained within the <code>tool.hatch</code> table:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch]\noption = \"...\"\n\n[tool.hatch.table1]\noption = \"...\"\n\n[tool.hatch.table2]\noption = \"...\"\n</code></pre> <pre><code>option = \"...\"\n\n[table1]\noption = \"...\"\n\n[table2]\noption = \"...\"\n</code></pre> <p>Top level keys in the latter file take precedence when defined in both.</p> <p>Tip</p> <p>If you want to make your file more compact, you can use dotted keys, turning the above example into:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch]\noption = \"...\"\ntable1.option = \"...\"\ntable2.option = \"...\"\n</code></pre> <pre><code>option = \"...\"\ntable1.option = \"...\"\ntable2.option = \"...\"\n</code></pre>"},{"location":"next-steps/","title":"Next steps","text":""},{"location":"next-steps/#learn-more","title":"Learn more","text":"<p>At this point you should have a basic understanding of how to use Hatch.</p> <p>Now you may want to check out advanced configuration for environments or builds, set up your preferred shell, or read more about Hatch's CLI.</p> <p>After that, check out the Hatch Showcase project to see examples of what is possible.</p> <p>Finally, if you see a need, feel free to write a plugin for extended functionality.</p>"},{"location":"next-steps/#community","title":"Community","text":"<p>For any projects using Hatch, you may add its official badge somewhere prominent like the README.</p> <p></p> MarkdownreStructuredText <pre><code>[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)\n</code></pre> <pre><code>.. image:: https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg\n   :alt: Hatch project\n   :target: https://github.com/pypa/hatch\n</code></pre>"},{"location":"publish/","title":"Publishing","text":"<p>After your project is built, you can distribute it using the <code>publish</code> command.</p> <p>The <code>-p</code>/<code>--publisher</code> option controls which publisher to use, with the default being index.</p>"},{"location":"publish/#artifact-selection","title":"Artifact selection","text":"<p>By default, the <code>dist</code> directory located at the root of your project will be used:</p> <pre><code>$ hatch publish\ndist/hatch_demo-1rc0-py3-none-any.whl ... success\ndist/hatch_demo-1rc0.tar.gz ... success\n\n[hatch-demo]\nhttps://pypi.org/project/hatch-demo/1rc0/\n</code></pre> <p>You can instead pass specific paths as arguments:</p> <pre><code>hatch publish /path/to/artifacts foo-1.tar.gz\n</code></pre> <p>Only files ending with <code>.whl</code> or <code>.tar.gz</code> will be published.</p>"},{"location":"publish/#further-resources","title":"Further resources","text":"<p>Please refer to the publisher plugin reference for configuration options.</p> <p>There's a How-To on authentication and on options to select the target repository.</p> <p>The <code>publish</code> command is implemented as a built-in plugin, if you're planning your own plugin, read about the publisher plugin API. </p>"},{"location":"version/","title":"Versioning","text":""},{"location":"version/#configuration","title":"Configuration","text":"<p>When the version is not statically set, configuration is defined in the <code>tool.hatch.version</code> table. The <code>source</code> option determines the source to use for retrieving and updating the version. The regex source is used by default.</p> <p>The <code>regex</code> source requires an option <code>path</code> that represents a relative path to a file containing the project's version:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\npath = \"src/hatch_demo/__about__.py\"\n</code></pre> <pre><code>[version]\npath = \"src/hatch_demo/__about__.py\"\n</code></pre> <p>The default pattern looks for a variable named <code>__version__</code> or <code>VERSION</code> that is set to a string containing the version, optionally prefixed with the lowercase letter <code>v</code>.</p> <p>If this doesn't reflect how you store the version, you can define a different regular expression using the <code>pattern</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\npath = \"pkg/__init__.py\"\npattern = \"BUILD = 'b(?P&lt;version&gt;[^']+)'\"\n</code></pre> <pre><code>[version]\npath = \"pkg/__init__.py\"\npattern = \"BUILD = 'b(?P&lt;version&gt;[^']+)'\"\n</code></pre> <p>The pattern must have a named group called <code>version</code> that represents the version.</p>"},{"location":"version/#display","title":"Display","text":"<p>Invoking the <code>version</code> command without any arguments will display the current version of the project:</p> <pre><code>$ hatch version\n0.0.1\n</code></pre>"},{"location":"version/#updating","title":"Updating","text":"<p>You can update the version like so:</p> <pre><code>$ hatch version \"0.1.0\"\nOld: 0.0.1\nNew: 0.1.0\n</code></pre> <p>The <code>scheme</code> option determines the scheme to use for parsing both the existing and new versions. The standard scheme is used by default, which is based on PEP 440.</p> <p>Rather than setting the version explicitly, you can select the name of a segment used to increment the version:</p> <pre><code>$ hatch version minor\nOld: 0.1.0\nNew: 0.2.0\n</code></pre> <p>You can chain multiple segment updates with a comma. For example, if you wanted to release a preview of your project's first major version, you could do:</p> <pre><code>$ hatch version major,rc\nOld: 0.2.0\nNew: 1.0.0rc0\n</code></pre> <p>When you want to release the final version, you would do:</p> <pre><code>$ hatch version release\nOld: 1.0.0rc0\nNew: 1.0.0\n</code></pre>"},{"location":"version/#supported-segments","title":"Supported segments","text":"<p>Here are the supported segments and how they would influence an existing version of <code>1.0.0</code>:</p> Segments New version <code>release</code> <code>1.0.0</code> <code>major</code> <code>2.0.0</code> <code>minor</code> <code>1.1.0</code> <code>micro</code><code>patch</code><code>fix</code> <code>1.0.1</code> <code>a</code><code>alpha</code> <code>1.0.0a0</code> <code>b</code><code>beta</code> <code>1.0.0b0</code> <code>c</code><code>rc</code><code>pre</code><code>preview</code> <code>1.0.0rc0</code> <code>r</code><code>rev</code><code>post</code> <code>1.0.0.post0</code> <code>dev</code> <code>1.0.0.dev0</code>"},{"location":"why/","title":"Why Hatch?","text":"<p>The high level value proposition of Hatch is that if one adopts all functionality then many other tools become unnecessary since there is support for everything one might require. Further, if one chooses to use only specific features then there are still benefits compared to alternatives.</p>"},{"location":"why/#build-backend","title":"Build backend","text":"<p>Hatchling, the build backend sister project, has many benefits compared to setuptools. Here we only compare setuptools as that is the one most people are familiar with.</p> <ul> <li>Better defaults: The default behavior for setuptools is often not desirable for the average user.<ul> <li>For source distributions, setuptools has a custom enumeration of files that get included and excluded by default. Hatchling takes the defaults from your version control system such as Git's <code>.gitignore</code> file.</li> <li>For wheels, setuptools attempts to find every directory that looks like a Python package. This is often undesirable as you might ship files to the end-user unintentionally such as test or tooling directories. Hatchling defaults to very specific inclusion based on the project name and errors if no heuristic is satisfied.</li> </ul> </li> <li>Ease of configurability: Hatchling was designed based on a history of significant challenges when configuring setuptools.<ul> <li>Hatchling uses the same glob pattern syntax as Git itself for every option which is what most users are familiar with. On the other hand, setuptools uses shell-style glob patterns for source distributions while wheels use a mix of shell-style globs and Python package syntax.</li> <li>Configuring what gets included in source distributions requires a separate <code>MANIFEST.in</code> file. The custom syntax and directives must be learned and it is difficult knowing which options in the main files like <code>setup.py</code> influence the behavior and under what conditions. For Hatchling, everything gets configured in a single file under dedicated sections for specific targets like <code>[tool.hatch.build.targets.wheel]</code>.</li> <li>By default, non-Python files are excluded from wheels. Including such files requires usually verbose rules for every nested package directory. Hatchling makes no such distinction between file types and acts more like a general build system one might already be familiar with.</li> </ul> </li> <li>Editable installations: The default behavior of Hatchling allows for proper static analysis by external tools such as IDEs. With setuptools, you must provide additional configuration which means that by default, for example, you would not get autocompletion in Visual Studio Code. This is marked as a legacy feature and may in fact be removed in future versions of setuptools.</li> <li>Reproducibility: Hatchling builds reproducible wheels and source distributions by default. setuptools does not support this for source distributions and there is no guarantee that wheels are reproducible.</li> <li>Extensibility: Although it is possible to extend setuptools, the API is quite low level. Hatchling has the concept of plugins that are separated into discrete types and only expose what is necessary, leading to an easier developer experience.</li> </ul> <p>Why not?:</p> <p>If building extension modules is required then it is recommended that you continue using setuptools, or even other backends that specialize in interfacing with compilers.</p>"},{"location":"why/#environment-management","title":"Environment management","text":"<p>Here we compare to both <code>tox</code> and <code>nox</code>. At a high level, there are a few common advantages:</p> <ul> <li>Python management: Hatch is able to automatically download Python distributions on the fly when specific versions that environments request cannot be found. The alternatives will raise an error, with the option to ignore unknown distributions.</li> <li> <p>Philosophy: In the alternatives, environments are for the most part treated as executable units where a dependency set is associated with an action. If you are familiar with container ecosystems, this would be like defining a <code>CMD</code> at the end of a Dockerfile but without the ability to change the action at runtime. This involves significant wasted disk space usually because one often requires slight modifications to the actions and therefore will define entirely different environments inherited from a base config just to perform different logic. Additionally, this can be confusing to users not just configuration-wise but also for execution of the different environments.</p> <p>In Hatch, environments are treated as isolated areas where you can execute arbitrary commands at runtime. For example, you can define a single test environment with named scripts that runs unit vs non-unit tests, each command being potentially very long but named however you wish so you get to control the interface. Since environments are treated as places where work is performed, you can also spawn a shell into any which will execute a subprocess that automatically drops into your shell of choice. Your shell will be configured appropriately like <code>python</code> on PATH being updated and the prompt being changed to reflect the chosen environment.</p> </li> <li> <p>Configuration:</p> <ul> <li><code>tox</code> only supports INI configuration and if one desires putting that in the standard <code>pyproject.toml</code> file then it must be a multi-line string containing the INI config which would preclude syntax highlighting. Hatch allows for TOML-based config just like most other tools in the Python ecosystem.</li> <li><code>nox</code> config is defined in Python which often leads to increased verbosity and makes it challenging to onboard folks compared to a standardized format with known behaviors.</li> </ul> </li> <li>Extensibility:<ul> <li><code>tox</code> allows for extending most aspects of its functionality however the API is so low-level and attached to internals that creating plugins may be challenging. For example, here is a <code>tox</code> plugin that was migrated to an equivalent Hatch environment collector plugin.</li> <li><code>nox</code> is configured with Python so for the local project you can do whatever you want, however there is no concept of third-party plugins per se. To achieve that, you must usually use a package that wraps <code>nox</code> and use that package's imports instead (example).</li> </ul> </li> </ul> <p>Why not?:</p> <p>If you are using <code>nox</code> and you wish to migrate, and for some reason you notify sessions, then migration wouldn't be a straight translation but rather you might have to redesign that conditional step.</p>"},{"location":"why/#python-management","title":"Python management","text":"<p>Here we compare Python management to that of pyenv.</p> <ul> <li>Cross-platform: Hatch allows for the same experience no matter the system whereas <code>pyenv</code> does not support Windows so you must use an entirely different project that tries to emulate the functionality.</li> <li>No build dependencies: Hatch guarantees that every available distribution is prebuilt whereas the alternative requires one to maintain a precise build environment which differs by platform and potentially Python version. Another benefit to this is extremely fast installations since the distributions are simply downloaded and unpacked.</li> <li>Optimized by default: The CPython distributions are built with profile guided optimization and link-time optimization, resulting in a 10-30% performance improvement depending on the workload. These distributions have seen wide adoption throughout the industry and are even used by the build system Bazel.</li> <li>Simplicity: Hatch treats Python installations as just another directory that one would add to PATH. It can do this for you or you can manage PATH yourself, even allowing for custom install locations. On the other hand, <code>pyenv</code> operates by adding shims which then act as wrappers around the actual underlying binaries. This has many unfortunate side effects:<ul> <li>It is incumbent upon the user to manage which specific Python comes first via the CLI, switch when necessary, and/or have a mental model of which versions are exposed globally and locally per-project. This can become confusing quite quickly. When working with Hatch, your global Python installations are only important insofar as they are on PATH somewhere since environments do not use them directly but rather create virtual environments from them, always using a version that is compatible with your project.</li> <li>Configuration is required for each shell to properly set up <code>pyenv</code> on start, leading to inconsistencies when running processes that do not spawn a shell.</li> <li>Debugging issues with Python search paths can be extremely difficult, especially for users of software. If you or users have ever ran into an issue where code was being executed that you did not anticipate, the issue is almost always <code>pyenv</code> influencing the <code>python</code> on PATH.</li> </ul> </li> </ul> <p>Why not?:</p> <p>Currently, Hatch does not allow for the installation of specific patch release versions but rather only uses minor release granularity that tracks the latest patch release. If specific patch releases are important to you then it is best to use an alternative installation mechanism.</p>"},{"location":"blog/","title":"Blog","text":""},{"location":"blog/2022/10/08/hatch-v160/","title":"Hatch v1.6.0","text":"<p>Hatch v1.6.0 brings improvements to build environments, better handling of dynamic metadata, and support for tools like Visual Studio Code.</p>"},{"location":"blog/2022/10/08/hatch-v160/#build-environments","title":"Build environments","text":"<p>Originally, the environment interface method for providing builder sub-environments was intended to be used in conjunction with some cleanup logic in order to provide a fresh setup every time. However, this is unnecessary in practice because build dependencies rarely change.</p> <p>Without caching, repeat build environment use is slow which affects the following scenarios:</p> <ul> <li>the <code>build</code> command</li> <li>commands that read project metadata, like <code>dep hash</code>, if any fields are set dynamically</li> </ul> <p>Now a new environment interface method <code>build_environment_exists</code> is used by Hatch to determine whether or not it has already been created, for implementations that have a caching mechanism.</p> <p>The <code>virtual</code> environment type now uses this method to cache build environments.</p>"},{"location":"blog/2022/10/08/hatch-v160/#project-metadata","title":"Project metadata","text":"<p>Dynamically defined metadata is now supported everywhere, thanks to the new caching of <code>virtual</code> build environments.</p> <p>A <code>project metadata</code> command is introduced that displays the fully resolved metadata. The output format is JSON unless a field is specified as an argument.</p> <p>For example, if you checkout a project that is built by Hatch, like FastAPI, and run:</p> <pre><code>hatch project metadata readme\n</code></pre> <p>only the <code>readme</code> text will be displayed. If the content is in Markdown, then Rich will render it directly in your terminal:</p> <p></p>"},{"location":"blog/2022/10/08/hatch-v160/#virtual-environment-location","title":"Virtual environment location","text":"<p>The <code>virtual</code> environment type now uses a flat layout for storage in the configured <code>virtual</code> environment directory if the directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory.</p> <p>For example, if you define the following Hatch configuration:</p>  config.toml <pre><code>[dirs.env]\nvirtual = \".hatch\"\n</code></pre> <p>and the following matrix:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\npython = [\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"3.11\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\npython = [\"3.7\", \"3.8\", \"3.9\", \"3.10\", \"3.11\"]\n</code></pre> <p>then locating environments with the following command:</p> <pre><code>hatch env find test\n</code></pre> <p>will show that the general directory structure is:</p> <pre><code>.hatch\n\u251c\u2500\u2500 test.py3.7\n\u251c\u2500\u2500 test.py3.8\n\u251c\u2500\u2500 test.py3.9\n\u251c\u2500\u2500 test.py3.10\n\u2514\u2500\u2500 test.py3.11\n</code></pre> <p>This flat structure is required for detection of virtual environments by tools like Visual Studio Code and PyCharm.</p> <p>Additionally, the <code>virtual</code> environment type now supports a <code>path</code> option to specify an explicit path that all inherited environments will share, such as the common <code>.venv</code>.</p>"},{"location":"blog/2022/10/08/hatch-v160/#migration-script-improvements","title":"Migration script improvements","text":"<p>The script used to migrate existing projects from <code>setuptools</code> has been improved to handle more edge cases that were encountered in the wild and now no longer modifies the formatting of existing <code>pyproject.toml</code> configuration.</p>"},{"location":"blog/2022/10/08/hatch-v160/#hatchling","title":"Hatchling","text":"<p>Hatch now depends on Hatchling v1.11.0, which was also just released.</p>"},{"location":"blog/2022/10/08/hatch-v160/#environment-version-source","title":"Environment version source","text":"<p>A new <code>env</code> version source is available that allows for the project version to be defined by an environment variable.</p>"},{"location":"blog/2022/10/08/hatch-v160/#relaxed-version-bumping","title":"Relaxed version bumping","text":"<p>The <code>standard</code> version scheme now supports a <code>validate-bump</code> option that when set to <code>false</code> will forego the check when updating the version that the desired version is higher than the current version.</p> <p>This use case comes from Project Jupyter:</p> <p>A common pattern we use in Jupyter is to bump to a <code>.dev0</code> minor version bump after making a release.  If we have a  bug fix that needs to go out in the interim, we'd rather not be forced to create a branch every time.</p>"},{"location":"blog/2023/12/11/hatch-v180/","title":"Hatch v1.8.0","text":"<p>Hatch v1.8.0 brings Python distribution management, static analysis and formatting backed by Ruff, and binaries for every platform.</p>"},{"location":"blog/2023/12/11/hatch-v180/#installation-made-easy","title":"Installation made easy","text":"<p>One thing that has been a perpetual problem for Hatch and other Python applications is that Python itself is a dependency. You, and more importantly your users, need to in some way get Python before your software can even be used. The recommended way to go about that is platform-dependent and even differs based on your target audience. I viewed this as a central UX problem for Hatch and so severe that I took a bit of a hiatus to solve it.</p> <p>Luckily, I have to my satisfaction solved this problem in the form of PyApp. It is a runtime installer for Python projects written in Rust. Apps are distributed as standalone executables as users have come to expect and bootstrapping occurs upon the first invocation. Here is an example of what you would see the first time you run a binary from this release:</p> <p></p> <p>Now that we have binaries, creating installers for different platforms becomes trivial. Starting with this release not only are binaries available for every platform but also we have installers for Windows and macOS. The installer for macOS is signed using a certificate from the same account used to sign the official distributions from https://www.python.org, so users will not get any security pop-ups. Shout out to @ewdurbin for their extreme generosity in setting up multiple certificates in their free time!</p> <p>These installers and binaries are now the recommended way to install and update Hatch. These binaries have built-in management so you can update to the latest version by running <code>hatch self update</code>.</p> <p>Windows signing</p> <p>In future we will sign the installers for Windows but I did not have time to look into how that works. macOS signing took way longer than I anticipated </p>"},{"location":"blog/2023/12/11/hatch-v180/#python-management","title":"Python management","text":"<p>For a long time I and other users have desired that Hatch gain the ability to manage Python distributions. In my mind this was always blocked on a better installation experience because there was sort of a chicken-or-egg problem where you want a Python manager but you first need Python. No longer is that the case!</p> <p>The new <code>python</code> command group allows for easy installation of various distributions to arbitrary locations which are then added to your PATH by default. Hatch supports CPython and PyPy distributions:</p> <p></p>"},{"location":"blog/2023/12/11/hatch-v180/#virtual-environment-python-resolution","title":"Virtual environment Python resolution","text":"<p>The <code>virtual</code> environment type is now far more intelligent when resolving the parent distribution to use and guarantees that, when no specific version is requested, the resolved distribution will always be compatible with the project.</p> <p>Additionally, when a requested version cannot be found on PATH it will automatically be downloaded and managed internally.</p>"},{"location":"blog/2023/12/11/hatch-v180/#static-analysis","title":"Static analysis","text":"<p>There is a new <code>fmt</code> command, backed entirely by Ruff, that checks and fixes your code for formatting and linting issues.</p> <p>Starting with this release, Hatch maintains default settings that are guaranteed to be up-to-date and represent best practices for programming in modern Python. The idea is to provide defaults that are so broadly applicable that the majority of users will maintain little if any of their own overrides.</p> <p>The default behavior is internal management of settings to provide an OOTB experience that works. It is recommended however that you persist the default config file in version control so that other tools like IDEs can utilize your full configuration.</p> <p>Since Ruff is now provided as a built-in feature, new project templates no longer have such configuration and are much less verbose.</p>"},{"location":"blog/2023/12/11/hatch-v180/#build-improvements","title":"Build improvements","text":"<p>Building projects that do not use Hatchling as a backend is now supported and such builds are managed with the standard build tool.</p> <p>The bridge between Hatch and the Hatchling CLI has been removed. Previously, the builder would send serialized messages to Hatch that would contain the desired content and style for each line of output. This was done in an effort to allow builder and build hook plugins to output pretty messages without actually requiring a dependency like Rich. A problem that arises with this is that builders that invoke subprocesses will not display ANSI codes as one might expect and will lose out on the interactive experience of such invocations, like the built-in binary builder plugin calling <code>cargo build</code>. So now everything is simpler at the expense of no colored output without manual logic, or adding a dependency if you're a third-party plugin.</p>"},{"location":"blog/2023/12/11/hatch-v180/#faster-environment-usage","title":"Faster environment usage","text":"<p>Spawning a shell or running commands within environments always first checks that your project's dependencies are satisfied and if not synchronizes the environment with what is defined. Previously, this had the potential to be quite slow for projects that have many dependencies.</p> <p>Now the set of dependency definitions is hashed and no check is performed if the hash is the same as before, significantly speeding up environment usage in most cases.</p>"},{"location":"blog/2023/12/11/hatch-v180/#hatchling","title":"Hatchling","text":"<p>Hatch now depends on Hatchling v1.19.0, which was also just released.</p>"},{"location":"blog/2023/12/11/hatch-v180/#better-defaults","title":"Better defaults","text":"<p>Hatchling is all about providing the best possible defaults, even at the expense of backward compatibility. In this release, there are two breaking changes that provide a much better user experience and were in fact requested by users.</p> <ul> <li>Both the <code>force-include</code> option and the <code>force_include_editable</code> wheel build data setting now raise errors if source paths do not exist.</li> <li>The <code>wheel</code> build target now raises an error when no file inclusion options have been defined and none of its heuristics to determine what to ship are satisfied.</li> </ul>"},{"location":"blog/2023/12/11/hatch-v180/#binary-build-target","title":"Binary build target","text":"<p>A new <code>binary</code> build target is now stable that allows for the building of standalone binaries for projects. This is what Hatch itself uses for its binaries.</p>"},{"location":"blog/2023/12/11/hatch-v180/#meta","title":"Meta","text":""},{"location":"blog/2023/12/11/hatch-v180/#why-hatch","title":"Why Hatch?","text":"<p>A new page has been introduced that discusses the value proposition of Hatch and Hatchling in comparison to alternatives. Currently, it only addresses a few features but in future this page will become more comprehensive.</p>"},{"location":"blog/2023/12/11/hatch-v180/#future","title":"Future","text":"<p>Upcoming features include a <code>test</code> command, commands to manage dependencies, and workspaces functionality similar to Cargo that will make managing monorepos far easier.</p> <p>Next year there will be two large efforts that you should expect to see:</p> <ol> <li> <p>A significant amount of my free time (and some at work) will be devoted to introducing lock file functionality in Hatch and trying to get whatever that happens to be standardized.</p> <p>I met with @brettcannon about his thoughts post-PEP 665 and about mousebender. I also met with the prefix.dev team about rip and was fortunate enough to be shown a demo before its official announcement.</p> <p>At the moment, the two options I see are to either go all in and contribute to mousebender or rely on the Prefix folks and use rip. The latter has the benefit of potentially supporting Conda as a side effect with the downside of being quite new with the spec firmly out of our control. The former has the benefit of being able to easily gain institutional support from the Python packaging team and each of our employers with the downside being a significant amount of work needing to be done.</p> </li> <li> <p>When @henryiii is able to get some free time away from teaching I plan to work with him once again and push very hard for the Python build ecosystem to adopt the extensionlib approach.</p> <p>I am of the opinion that the Python community has not fully completed the expressed outcome of PEP 517 in that build backends are still (for the most part) reliant on setuptools for building non-Python code bases.</p> <p>Basically, there are components that interact with compilers to produce extension modules and components that pack files into an archive which we call a build backend. These are two distinct pieces of functionality and my view is that there should be an API that allows backends to consume extension module builders to find out where things got created and where they should be shipped inside archives.</p> <p>In this hypothetical future any build backend would be able to trigger the building of extension modules based on user configuration.</p> </li> </ol>"},{"location":"blog/2023/12/11/hatch-v180/#support","title":"Support","text":"<p>If you or your organization finds value in what Hatch provides, consider a sponsorship to assist with maintenance and more rapid development!</p>"},{"location":"blog/2023/12/18/hatch-v190/","title":"Hatch v1.9.0","text":"<p>Hatch v1.9.0 brings improvements to static analysis and important bug fixes.</p>"},{"location":"blog/2023/12/18/hatch-v190/#static-analysis","title":"Static analysis","text":"<p>The default version of Ruff has been increased to v0.1.8. This release brings formatting capabilities to docstrings and Hatch enables this by default with line length set to 80. This length was chosen as the default because it plays nicely with the rendering of the most popular themes for Python documentation, such as Material for MkDocs and Furo.</p> <p>Additionally, it is now possible for projects to pin to specific versions of Ruff for upgrading at a later time:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre> <pre><code>[envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre>"},{"location":"blog/2023/12/18/hatch-v190/#notable-fixes","title":"Notable fixes","text":"<ul> <li>Python resolution for environments that do not install the project is no longer bound by the project's Python requirement.</li> <li>Fixed an edge case for out-of-the-box static analysis when there was existing configuration.</li> <li>Compatibility checks for environments no longer occur if the environment is already created. This significantly increases the responsiveness of environment usage.</li> </ul>"},{"location":"cli/about/","title":"CLI usage","text":""},{"location":"cli/about/#verbosity","title":"Verbosity","text":"<p>The amount of displayed output is controlled solely by the <code>-v</code>/<code>--verbose</code> (environment variable <code>HATCH_VERBOSE</code>) and  <code>-q</code>/<code>--quiet</code> (environment variable <code>HATCH_QUIET</code>) root options.</p> <p>The levels are documented here.</p>"},{"location":"cli/about/#project-awareness","title":"Project awareness","text":"<p>No matter the mode, Hatch will always change to the project's root directory for entering or running commands in environments.</p>"},{"location":"cli/about/#tab-completion","title":"Tab completion","text":"<p>Completion is achieved by saving a script and then executing it as a part of your shell's startup sequence.</p> <p>Afterward, you'll need to start a new shell in order for the changes to take effect.</p> BashZ shellfish <p>Save the script somewhere:</p> <pre><code>_HATCH_COMPLETE=bash_source hatch &gt; ~/.hatch-complete.bash\n</code></pre> <p>Source the file in <code>~/.bashrc</code> (or <code>~/.bash_profile</code> if on macOS):</p> <pre><code>. ~/.hatch-complete.bash\n</code></pre> <p>Save the script somewhere:</p> <pre><code>_HATCH_COMPLETE=zsh_source hatch &gt; ~/.hatch-complete.zsh\n</code></pre> <p>Source the file in <code>~/.zshrc</code>:</p> <pre><code>. ~/.hatch-complete.zsh\n</code></pre> <p>Save the script in <code>~/.config/fish/completions</code>:</p> <pre><code>_HATCH_COMPLETE=fish_source hatch &gt; ~/.config/fish/completions/hatch.fish\n</code></pre>"},{"location":"cli/reference/","title":"hatch","text":"<p>Usage:</p> <pre><code>hatch [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--env</code>, <code>-e</code> text The name of the environment to use [env var: <code>HATCH_ENV</code>] <code>default</code> <code>--project</code>, <code>-p</code> text The name of the project to work on [env var: <code>HATCH_PROJECT</code>] None <code>--verbose</code>, <code>-v</code> integer range (<code>0</code> and above) Increase verbosity (can be used additively) [env var: <code>HATCH_VERBOSE</code>] <code>0</code> <code>--quiet</code>, <code>-q</code> integer range (<code>0</code> and above) Decrease verbosity (can be used additively) [env var: <code>HATCH_QUIET</code>] <code>0</code> <code>--color</code> / <code>--no-color</code> boolean Whether or not to display colored output (default is auto-detection) [env vars: <code>FORCE_COLOR</code>/<code>NO_COLOR</code>] None <code>--interactive</code> / <code>--no-interactive</code> boolean Whether or not to allow features like prompts and progress bars (default is auto-detection) [env var: <code>HATCH_INTERACTIVE</code>] None <code>--data-dir</code> text The path to a custom directory used to persist data [env var: <code>HATCH_DATA_DIR</code>] None <code>--cache-dir</code> text The path to a custom directory used to cache data [env var: <code>HATCH_CACHE_DIR</code>] None <code>--config</code> text The path to a custom config file to use [env var: <code>HATCH_CONFIG</code>] None <code>--version</code> boolean Show the version and exit. <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-build","title":"hatch build","text":"<p>Build a project.</p> <p>Usage:</p> <pre><code>hatch build [OPTIONS] [LOCATION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--target</code>, <code>-t</code> text The target to build, overriding project defaults. This may be selected multiple times e.g. <code>-t sdist -t wheel</code> None <code>--hooks-only</code> boolean Whether or not to only execute build hooks [env var: <code>HATCH_BUILD_HOOKS_ONLY</code>] <code>False</code> <code>--no-hooks</code> boolean Whether or not to disable build hooks [env var: <code>HATCH_BUILD_NO_HOOKS</code>] <code>False</code> <code>--ext</code> boolean Whether or not to only execute build hooks for distributing binary Python packages, such as compiling extensions. Equivalent to <code>--hooks-only -t wheel</code> <code>False</code> <code>--clean</code>, <code>-c</code> boolean Whether or not existing artifacts should first be removed [env var: <code>HATCH_BUILD_CLEAN</code>] <code>False</code> <code>--clean-hooks-after</code> boolean Whether or not build hook artifacts should be removed after each build [env var: <code>HATCH_BUILD_CLEAN_HOOKS_AFTER</code>] <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-clean","title":"hatch clean","text":"<p>Remove build artifacts.</p> <p>Usage:</p> <pre><code>hatch clean [OPTIONS] [LOCATION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--target</code>, <code>-t</code> text The target with which to remove artifacts, overriding project defaults. This may be selected multiple times e.g. <code>-t sdist -t wheel</code> None <code>--hooks-only</code> boolean Whether or not to only remove artifacts from build hooks [env var: <code>HATCH_BUILD_HOOKS_ONLY</code>] <code>False</code> <code>--no-hooks</code> boolean Whether or not to ignore artifacts from build hooks [env var: <code>HATCH_BUILD_NO_HOOKS</code>] <code>False</code> <code>--ext</code> boolean Whether or not to only remove artifacts from build hooks for distributing binary Python packages, such as compiled extensions. Equivalent to <code>--hooks-only -t wheel</code> <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config","title":"hatch config","text":"<p>Manage the config file</p> <p>Usage:</p> <pre><code>hatch config [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-explore","title":"hatch config explore","text":"<p>Open the config location in your file manager.</p> <p>Usage:</p> <pre><code>hatch config explore [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-find","title":"hatch config find","text":"<p>Show the location of the config file.</p> <p>Usage:</p> <pre><code>hatch config find [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-restore","title":"hatch config restore","text":"<p>Restore the config file to default settings.</p> <p>Usage:</p> <pre><code>hatch config restore [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-set","title":"hatch config set","text":"<p>Assign values to config file entries. If the value is omitted, you will be prompted, with the input hidden if it is sensitive.</p> <p>Usage:</p> <pre><code>hatch config set [OPTIONS] KEY [VALUE]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-show","title":"hatch config show","text":"<p>Show the contents of the config file.</p> <p>Usage:</p> <pre><code>hatch config show [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--all</code>, <code>-a</code> boolean Do not scrub secret fields <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-config-update","title":"hatch config update","text":"<p>Update the config file with any new fields.</p> <p>Usage:</p> <pre><code>hatch config update [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep","title":"hatch dep","text":"<p>Manage environment dependencies</p> <p>Usage:</p> <pre><code>hatch dep [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-hash","title":"hatch dep hash","text":"<p>Output a hash of the currently defined dependencies.</p> <p>Usage:</p> <pre><code>hatch dep hash [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--project-only</code>, <code>-p</code> boolean Whether or not to exclude environment dependencies <code>False</code> <code>--env-only</code>, <code>-e</code> boolean Whether or not to exclude project dependencies <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-show","title":"hatch dep show","text":"<p>Display dependencies in various formats</p> <p>Usage:</p> <pre><code>hatch dep show [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-show-requirements","title":"hatch dep show requirements","text":"<p>Enumerate dependencies as a list of requirements.</p> <p>Usage:</p> <pre><code>hatch dep show requirements [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--project-only</code>, <code>-p</code> boolean Whether or not to exclude environment dependencies <code>False</code> <code>--env-only</code>, <code>-e</code> boolean Whether or not to exclude project dependencies <code>False</code> <code>--feature</code>, <code>-f</code> text Whether or not to only show the dependencies of the specified features None <code>--all</code> boolean Whether or not to include the dependencies of all features <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-dep-show-table","title":"hatch dep show table","text":"<p>Enumerate dependencies in a tabular format.</p> <p>Usage:</p> <pre><code>hatch dep show table [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--project-only</code>, <code>-p</code> boolean Whether or not to exclude environment dependencies <code>False</code> <code>--env-only</code>, <code>-e</code> boolean Whether or not to exclude project dependencies <code>False</code> <code>--lines</code>, <code>-l</code> boolean Whether or not to show lines between table rows <code>False</code> <code>--ascii</code> boolean Whether or not to only use ASCII characters <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env","title":"hatch env","text":"<p>Manage project environments</p> <p>Usage:</p> <pre><code>hatch env [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-create","title":"hatch env create","text":"<p>Create environments.</p> <p>Usage:</p> <pre><code>hatch env create [OPTIONS] [ENV_NAME]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-find","title":"hatch env find","text":"<p>Locate environments.</p> <p>Usage:</p> <pre><code>hatch env find [OPTIONS] [ENV_NAME]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-prune","title":"hatch env prune","text":"<p>Remove all environments.</p> <p>Usage:</p> <pre><code>hatch env prune [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-remove","title":"hatch env remove","text":"<p>Remove environments.</p> <p>Usage:</p> <pre><code>hatch env remove [OPTIONS] [ENV_NAME]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-run","title":"hatch env run","text":"<p>Run commands within project environments.</p> <p>The <code>-e</code>/<code>--env</code> option overrides the equivalent root option and the <code>HATCH_ENV</code> environment variable.</p> <p>The <code>-i</code>/<code>--include</code> and <code>-x</code>/<code>--exclude</code> options may be used to include or exclude certain variables, optionally followed by specific comma-separated values, and may be selected multiple times. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <p>then running:</p> <pre><code>hatch env run -i py=3.10 -x version=9000 test:pytest\n</code></pre> <p>would execute <code>pytest</code> in the environments <code>test.py3.10-42</code> and <code>test.py3.10-3.14</code>. Note that <code>py</code> may be used as an alias for <code>python</code>.</p> <p>Usage:</p> <pre><code>hatch env run [OPTIONS] ARGS...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--env</code>, <code>-e</code> text The environments to target None <code>--include</code>, <code>-i</code> text The matrix variables to include None <code>--exclude</code>, <code>-x</code> text The matrix variables to exclude None <code>--filter</code>, <code>-f</code> text The JSON data used to select environments None <code>--force-continue</code> boolean Run every command and if there were any errors exit with the first code <code>False</code> <code>--ignore-compat</code> boolean Ignore incompatibility when selecting specific environments <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-env-show","title":"hatch env show","text":"<p>Show the available environments.</p> <p>Usage:</p> <pre><code>hatch env show [OPTIONS] [ENVS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--ascii</code> boolean Whether or not to only use ASCII characters <code>False</code> <code>--json</code> boolean Whether or not to output in JSON format <code>False</code> <code>--internal</code>, <code>-i</code> boolean Show internal environments <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-fmt","title":"hatch fmt","text":"<p>Format and lint source code.</p> <p>Usage:</p> <pre><code>hatch fmt [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--check</code> boolean Only check for errors rather than fixing them <code>False</code> <code>--linter</code>, <code>-l</code> boolean Only run the linter <code>False</code> <code>--formatter</code>, <code>-f</code> boolean Only run the formatter <code>False</code> <code>--sync</code> boolean Sync the default config file with the current version of Hatch <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-new","title":"hatch new","text":"<p>Create or initialize a project.</p> <p>Usage:</p> <pre><code>hatch new [OPTIONS] [NAME] [LOCATION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--interactive</code>, <code>-i</code> boolean Interactively choose details about the project <code>False</code> <code>--cli</code> boolean Give the project a command line interface <code>False</code> <code>--init</code> boolean Initialize an existing project <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-project","title":"hatch project","text":"<p>View project information</p> <p>Usage:</p> <pre><code>hatch project [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-project-metadata","title":"hatch project metadata","text":"<p>Display project metadata.</p> <p>If you want to view the raw readme file without rendering, you can use a JSON parser like jq:</p> <pre><code>hatch project metadata | jq -r .readme\n</code></pre> <p>Usage:</p> <pre><code>hatch project metadata [OPTIONS] [FIELD]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-publish","title":"hatch publish","text":"<p>Publish build artifacts.</p> <p>Usage:</p> <pre><code>hatch publish [OPTIONS] [ARTIFACTS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--repo</code>, <code>-r</code> text The repository with which to publish artifacts [env var: <code>HATCH_INDEX_REPO</code>] None <code>--user</code>, <code>-u</code> text The user with which to authenticate [env var: <code>HATCH_INDEX_USER</code>] None <code>--auth</code>, <code>-a</code> text The credentials to use for authentication [env var: <code>HATCH_INDEX_AUTH</code>] None <code>--ca-cert</code> text The path to a CA bundle [env var: <code>HATCH_INDEX_CA_CERT</code>] None <code>--client-cert</code> text The path to a client certificate, optionally containing the private key [env var: <code>HATCH_INDEX_CLIENT_CERT</code>] None <code>--client-key</code> text The path to the client certificate's private key [env var: <code>HATCH_INDEX_CLIENT_KEY</code>] None <code>--no-prompt</code>, <code>-n</code> boolean Disable prompts, such as for missing required fields <code>False</code> <code>--initialize-auth</code> boolean Save first-time authentication information even if nothing was published <code>False</code> <code>--publisher</code>, <code>-p</code> text The publisher plugin to use (default is <code>index</code>) [env var: <code>HATCH_PUBLISHER</code>] <code>index</code> <code>--option</code>, <code>-o</code> text Options to pass to the publisher plugin. This may be selected multiple times e.g. <code>-o foo=bar -o baz=23</code> [env var: <code>HATCH_PUBLISHER_OPTIONS</code>] None <code>--yes</code>, <code>-y</code> boolean Confirm without prompting when the plugin is disabled <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python","title":"hatch python","text":"<p>Manage Python installations</p> <p>Usage:</p> <pre><code>hatch python [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-find","title":"hatch python find","text":"<p>Locate Python binaries.</p> <p>Usage:</p> <pre><code>hatch python find [OPTIONS] NAME\n</code></pre> <p>Options:</p> Name Type Description Default <code>-p</code>, <code>--parent</code> boolean Show the parent directory of the Python binary <code>False</code> <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-install","title":"hatch python install","text":"<p>Install Python distributions.</p> <p>You may select <code>all</code> to install all compatible distributions:</p> <pre><code>hatch python install all\n</code></pre> <p>Usage:</p> <pre><code>hatch python install [OPTIONS] NAMES...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--private</code> boolean Do not add distributions to the user PATH <code>False</code> <code>--update</code>, <code>-u</code> boolean Update existing installations <code>False</code> <code>--dir</code>, <code>-d</code> text The directory in which to install distributions, overriding configuration None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-remove","title":"hatch python remove","text":"<p>Remove Python distributions.</p> <p>You may select <code>all</code> to remove all installed distributions:</p> <pre><code>hatch python remove all\n</code></pre> <p>Usage:</p> <pre><code>hatch python remove [OPTIONS] NAMES...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-show","title":"hatch python show","text":"<p>Show the available Python distributions.</p> <p>Usage:</p> <pre><code>hatch python show [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--ascii</code> boolean Whether or not to only use ASCII characters <code>False</code> <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-python-update","title":"hatch python update","text":"<p>Update Python distributions.</p> <p>You may select <code>all</code> to update all installed distributions:</p> <pre><code>hatch python update all\n</code></pre> <p>Usage:</p> <pre><code>hatch python update [OPTIONS] NAMES...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--dir</code>, <code>-d</code> text The directory in which distributions reside None <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-run","title":"hatch run","text":"<p>Run commands within project environments. This is a convenience wrapper around the <code>env run</code> command.</p> <p>If the first argument contains a colon, then the preceding component will be interpreted as the name of the environment to target, overriding the <code>-e</code>/<code>--env</code> root option and the <code>HATCH_ENV</code> environment variable.</p> <p>If the environment provides matrices, then you may also provide leading arguments starting with a <code>+</code> or <code>-</code> to select or exclude certain variables, optionally followed by specific comma-separated values. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <p>then running:</p> <pre><code>hatch run +py=3.10 -version=9000 test:pytest\n</code></pre> <p>would execute <code>pytest</code> in the environments <code>test.py3.10-42</code> and <code>test.py3.10-3.14</code>. Note that <code>py</code> may be used as an alias for <code>python</code>.</p> <p>Usage:</p> <pre><code>hatch run [OPTIONS] [ENV:]ARGS...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self","title":"hatch self","text":"<p>Manage Hatch</p> <p>Usage:</p> <pre><code>hatch self [OPTIONS] COMMAND [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self-report","title":"hatch self report","text":"<p>Generate a pre-populated GitHub issue.</p> <p>Usage:</p> <pre><code>hatch self report [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--no-open</code>, <code>-n</code> boolean Show the URL instead of opening it <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self-restore","title":"hatch self restore","text":"<p>Restore the installation</p> <p>Usage:</p> <pre><code>hatch self restore [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-self-update","title":"hatch self update","text":"<p>Install the latest version</p> <p>Usage:</p> <pre><code>hatch self update [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-shell","title":"hatch shell","text":"<p>Enter a shell within a project's environment.</p> <p>Usage:</p> <pre><code>hatch shell [OPTIONS] [SHELL_NAME] [SHELL_PATH] [SHELL_ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-status","title":"hatch status","text":"<p>Show information about the current environment.</p> <p>Usage:</p> <pre><code>hatch status [OPTIONS]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-test","title":"hatch test","text":"<p>Run tests using the <code>hatch-test</code> environment matrix.</p> <p>If no filtering options are selected, then tests will be run in the first compatible environment found in the matrix with priority given to those matching the current interpreter.</p> <p>The <code>-i</code>/<code>--include</code> and <code>-x</code>/<code>--exclude</code> options may be used to include or exclude certain variables, optionally followed by specific comma-separated values, and may be selected multiple times. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.9\", \"3.10\"]\nversion = [\"42\", \"3.14\", \"9000\"]\n</code></pre> <p>then running:</p> <pre><code>hatch test -i py=3.10 -x version=9000\n</code></pre> <p>would run tests in the environments <code>hatch-test.py3.10-42</code> and <code>hatch-test.py3.10-3.14</code>.</p> <p>The <code>-py</code>/<code>--python</code> option is a shortcut for specifying the inclusion <code>-i py=...</code>.</p> <p>Usage:</p> <pre><code>hatch test [OPTIONS] [ARGS]...\n</code></pre> <p>Options:</p> Name Type Description Default <code>--randomize</code>, <code>-r</code> boolean Randomize the order of test execution <code>False</code> <code>--parallel</code>, <code>-p</code> boolean Parallelize test execution <code>False</code> <code>--retries</code> integer Number of times to retry failed tests None <code>--retry-delay</code> float Seconds to wait between retries None <code>--cover</code>, <code>-c</code> boolean Measure code coverage <code>False</code> <code>--cover-quiet</code> boolean Disable coverage reporting after tests, implicitly enabling --cover <code>False</code> <code>--all</code>, <code>-a</code> boolean Test all environments in the matrix <code>False</code> <code>--python</code>, <code>-py</code> text The Python versions to test, equivalent to: -i py=... None <code>--include</code>, <code>-i</code> text The matrix variables to include None <code>--exclude</code>, <code>-x</code> text The matrix variables to exclude None <code>--show</code>, <code>-s</code> boolean Show information about environments in the matrix <code>False</code> <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"cli/reference/#hatch-version","title":"hatch version","text":"<p>View or set a project's version.</p> <p>Usage:</p> <pre><code>hatch version [OPTIONS] [DESIRED_VERSION]\n</code></pre> <p>Options:</p> Name Type Description Default <code>--help</code> boolean Show this message and exit. <code>False</code>"},{"location":"community/contributing/","title":"Contributing","text":"<p>The usual process to make a contribution is to:</p> <ol> <li>Check for existing related issues</li> <li>Fork the repository and create a new branch</li> <li>Make your changes</li> <li>Make sure formatting, linting and tests passes.</li> <li>Add tests if possible to cover the lines you added.</li> <li>Commit, and send a Pull Request.</li> </ol>"},{"location":"community/contributing/#clone-the-repository","title":"Clone the repository","text":"<p>Clone the <code>hatch</code> repository, <code>cd</code> into it, and create a new branch for your contribution:</p> <pre><code>cd hatch\ngit checkout -b add-my-contribution\n</code></pre>"},{"location":"community/contributing/#run-the-tests","title":"Run the tests","text":"<p>Run the test suite while developing:</p> <pre><code>hatch run dev\n</code></pre> <p>Run the test suite with coverage report:</p> <pre><code>hatch run cov\n</code></pre> <p>Run the extended test suite with coverage:</p> <pre><code>hatch run full\n</code></pre>"},{"location":"community/contributing/#lint","title":"Lint","text":"<p>Run automated formatting:</p> <pre><code>hatch run lint:fmt\n</code></pre> <p>Run full linting and type checking:</p> <pre><code>hatch run lint:all\n</code></pre>"},{"location":"community/contributing/#docs","title":"Docs","text":"<p>Start the documentation in development:</p> <pre><code>hatch run docs:serve\n</code></pre> <p>Build and validate the documentation website:</p> <pre><code>hatch run docs:build-check\n</code></pre>"},{"location":"community/highlights/","title":"Community highlights","text":""},{"location":"community/highlights/#integration","title":"Integration","text":"<ul> <li>Project Jupyter - https://blog.jupyter.org/packaging-for-jupyter-in-2022-c7be64c38926</li> </ul>"},{"location":"community/highlights/#adoption","title":"Adoption","text":"<ul> <li>Black - https://ichard26.github.io/blog/2022/10/black-22.10.0/#goodbye-python-36-and-hello-hatchling</li> <li>\"Switching to Hatch\" - https://andrich.me/2023/08/switching-to-hatch/</li> </ul>"},{"location":"community/users/","title":"Users","text":"<p>The following is not intended to be a complete enumeration. Be sure to view the development version of this page for an up-to-date listing.</p>"},{"location":"community/users/#projects","title":"Projects","text":"<p>aiogram | Apache Airflow | argon2-cffi | attrs | Black | coffea | Colorama | Django Anymail | Django Debug Toolbar | Django Wiki | FastAPI | filelock | github3.py | Gradio | HTTPX | iCalendar for Humans | LinkChecker | Material for MkDocs | MkDocs | openSUSE | Nox | Packit | pipx | platformdirs | Pydantic | Pygments | PyHamcrest | PyMdown Extensions | Python JSON Schema | Rye | SALib | Spack | Starlette | structlog | tox | Twisted | urllib3 | Uvicorn | virtualenv | Voil\u00e0 | XGBoost | Ypy</p>"},{"location":"community/users/#industry","title":"Industry","text":"<ul> <li>Anaconda <sup>[1|2|3|4|5|6]</sup></li> <li>Astronomer <sup>[1]</sup></li> <li>Bloomberg <sup>[1|2]</sup></li> <li>Blue Robotics <sup>[1]</sup></li> <li>Cars.com <sup>[1]</sup></li> <li>Databricks <sup>[1|2]</sup></li> <li>Datadog <sup>[1|2|3|4]</sup></li> <li>deepset <sup>[1|2]</sup></li> <li>Elastic <sup>[1|2|3]</sup></li> <li>Google <sup>[1|2|3|4|5]</sup></li> <li>IBM <sup>[1]</sup></li> <li>JPMorgan Chase <sup>[1]</sup></li> <li>Intel Corporation <sup>[1|2|3]</sup></li> <li>Meta <sup>[1|2]</sup></li> <li>Microsoft <sup>[1|2|3|4|5]</sup></li> <li>OpenAI <sup>[1]</sup></li> <li>Oracle <sup>[1]</sup></li> <li>Palo Alto Networks <sup>[1]</sup></li> <li>Red Hat <sup>[1|2|3|4|5]</sup></li> <li>Snowflake <sup>[1]</sup></li> <li>Splunk <sup>[1]</sup></li> <li>Virtru <sup>[1|2]</sup></li> <li>VMware <sup>[1|2|3]</sup></li> <li>Volvo Group <sup>[1]</sup></li> </ul>"},{"location":"community/users/#organizations","title":"Organizations","text":"<ul> <li>Greater Paris University Hospitals (AP-HP) <sup>[1]</sup></li> <li>OpenTelemetry <sup>[1|2]</sup></li> <li>Smithsonian Institution <sup>[1]</sup></li> <li>The New York Public Library <sup>[1]</sup></li> </ul>"},{"location":"community/users/#government","title":"Government","text":"<ul> <li>European Molecular Biology Laboratory<ul> <li>European Bioinformatics Institute <sup>[1]</sup></li> </ul> </li> <li>Germany<ul> <li>Berlin Institute of Health <sup>[1]</sup></li> <li>Helmholtz Munich <sup>[1|2]</sup></li> </ul> </li> <li>Norway<ul> <li>Statistics Norway <sup>[1]</sup></li> </ul> </li> <li>United Kingdom<ul> <li>The Alan Turing Institute <sup>[1]</sup></li> <li>Department for Business and Trade <sup>[1]</sup></li> <li>The National Archives <sup>[1]</sup></li> </ul> </li> <li>United States<ul> <li>NASA <sup>[1]</sup></li> <li>National Security Agency <sup>[1|2]</sup></li> <li>National Telecommunications and Information Administration <sup>[1|2|3|4]</sup></li> </ul> </li> </ul>"},{"location":"community/users/#academia","title":"Academia","text":"<ul> <li>Brown University<ul> <li>Carney Institute for Brain Science <sup>[1]</sup></li> </ul> </li> <li>Chinese Academy of Sciences<ul> <li>Academy of Mathematics and Systems Science <sup>[1]</sup></li> </ul> </li> <li>Georgia Institute of Technology<ul> <li>Georgia Tech Database Group <sup>[1]</sup></li> </ul> </li> <li>Harvard University<ul> <li>Department of Molecular and Cellular Biology <sup>[1]</sup></li> </ul> </li> <li>Heidelberg University<ul> <li>Center for Molecular Biology <sup>[1]</sup></li> </ul> </li> <li>Leiden University<ul> <li>Leiden University Libraries <sup>[1|2]</sup></li> </ul> </li> <li>Maastricht University<ul> <li>Institute of Data Science <sup>[1|2|3|4|5|6|7]</sup></li> </ul> </li> <li>Massachusetts Institute of Technology<ul> <li>Computer Science and Artificial Intelligence Laboratory <sup>[1]</sup></li> <li>Digital Humanities <sup>[1]</sup></li> </ul> </li> <li>Medical University of Innsbruck<ul> <li>Institute of Bioinformatics <sup>[1]</sup></li> </ul> </li> <li>Polytechnique Montr\u00e9al<ul> <li>Department of Computer Engineering and Software Engineering <sup>[1]</sup></li> </ul> </li> <li>Siberian Branch of the Russian Academy of Sciences<ul> <li>Institute of Cytology and Genetics <sup>[1|2|3|4]</sup></li> </ul> </li> <li>Stanford University<ul> <li>Empirical Security Research Group <sup>[1]</sup></li> </ul> </li> <li>University of British Columbia<ul> <li>Department of Earth, Ocean and Atmospheric Sciences <sup>[1|2|3]</sup></li> </ul> </li> <li>University of California, Berkeley<ul> <li>Center for Computational Biology <sup>[1]</sup></li> </ul> </li> <li>University of Freiburg<ul> <li>Freiburg Center for Data Analysis and Modeling <sup>[1]</sup></li> </ul> </li> <li>University of Illinois Urbana-Champaign<ul> <li>Grainger College of Engineering <sup>[1]</sup></li> </ul> </li> <li>University of Lausanne<ul> <li>Department of Computational Biology <sup>[1]</sup></li> </ul> </li> <li>University of Ljubljana<ul> <li>Faculty of Mechanical Engineering <sup>[1]</sup></li> </ul> </li> <li>University of Oxford<ul> <li>Oxford Research Software Engineering <sup>[1]</sup></li> </ul> </li> <li>University of Pennsylvania<ul> <li>Lifespan Informatics and Neuroimaging Center <sup>[1]</sup></li> </ul> </li> <li>University of Sussex<ul> <li>Predictive Analytics Lab <sup>[1]</sup></li> </ul> </li> <li>University of Toronto Scarborough<ul> <li>utsc-networking <sup>[1|2|3|4]</sup></li> </ul> </li> <li>University of Washington<ul> <li>Interactive Data Lab <sup>[1]</sup></li> <li>Virtual Brain Lab <sup>[1]</sup></li> </ul> </li> <li>Waseda University<ul> <li>Tackeuchi Laboratory <sup>[1|2|3|4|5]</sup></li> </ul> </li> <li>Wellcome Sanger Institute <sup>[1]</sup></li> </ul>"},{"location":"community/users/#research","title":"Research","text":"<ul> <li>Clariah <sup>[1]</sup></li> <li>CloudDrift <sup>[1]</sup></li> <li>GAMA <sup>[1]</sup></li> <li>IPython <sup>[1|2|3]</sup></li> <li>MNE <sup>[1|2|3]</sup></li> <li>NIPY <sup>[1|2]</sup></li> <li>Project Jupyter<ul> <li>Jupyter <sup>[1|2|3|4]</sup></li> <li>JupyterLab <sup>[1|2|3|4|5]</sup></li> <li>Jupyter Server <sup>[1|2|3|4]</sup></li> </ul> </li> <li>Scikit-HEP <sup>[1|2|3|4|5|6|7|8|9|10]</sup></li> <li>scverse <sup>[1|2|3]</sup></li> <li>Spyder <sup>[1]</sup></li> </ul>"},{"location":"community/users/#security","title":"Security","text":"<ul> <li>Armory</li> <li>in-toto</li> <li>The Update Framework</li> </ul>"},{"location":"community/users/#crypto","title":"Crypto","text":"<ul> <li>Ocean Protocol <sup>[1]</sup></li> </ul>"},{"location":"config/build/","title":"Build configuration","text":"<p>Build targets are defined as sections within <code>tool.hatch.build.targets</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;TARGET_NAME&gt;]\n</code></pre> <pre><code>[build.targets.&lt;TARGET_NAME&gt;]\n</code></pre> <p>Tip</p> <p>Although not recommended, you may define global configuration in the <code>tool.hatch.build</code> table. Keys may then be overridden by target config.</p>"},{"location":"config/build/#build-system","title":"Build system","text":"<p>To be compatible with the broader Python packaging ecosystem, you must define the build system as follows:</p>  pyproject.toml <pre><code>[build-system]\nrequires = [\"hatchling\"]\nbuild-backend = \"hatchling.build\"\n</code></pre> <p>The version of <code>hatchling</code> defined here will be used to build all targets.</p> <p>Hatchling is a standards-compliant<sup>1</sup> build backend and is a dependency of Hatch itself.</p>"},{"location":"config/build/#file-selection","title":"File selection","text":""},{"location":"config/build/#vcs","title":"VCS","text":"<p>By default, Hatch will respect the first <code>.gitignore</code> or <code>.hgignore</code> file found in your project's root directory or parent directories. Set <code>ignore-vcs</code> to <code>true</code> to disable this behavior:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\nignore-vcs = true\n</code></pre> <pre><code>[build.targets.sdist]\nignore-vcs = true\n</code></pre> <p>Note</p> <p>For <code>.hgignore</code> files only glob syntax is supported.</p>"},{"location":"config/build/#patterns","title":"Patterns","text":"<p>You can set the <code>include</code> and <code>exclude</code> options to select exactly which files will be shipped in each build, with <code>exclude</code> taking precedence. Every entry represents a Git-style glob pattern.</p> <p>For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\ninclude = [\n  \"pkg/*.py\",\n  \"/tests\",\n]\nexclude = [\n  \"*.json\",\n  \"pkg/_compat.py\",\n]\n</code></pre> <pre><code>[build.targets.sdist]\ninclude = [\n  \"pkg/*.py\",\n  \"/tests\",\n]\nexclude = [\n  \"*.json\",\n  \"pkg/_compat.py\",\n]\n</code></pre> <p>will exclude every file with a <code>.json</code> extension, and will include everything under a <code>tests</code> directory located at the root and every file with a <code>.py</code> extension that is directly under a <code>pkg</code> directory located at the root except for <code>_compat.py</code>.</p>"},{"location":"config/build/#artifacts","title":"Artifacts","text":"<p>If you want to include files that are ignored by your VCS, such as those that might be created by build hooks, you can use the <code>artifacts</code> option. This option is semantically equivalent to <code>include</code>.</p> <p>Note that artifacts are not affected by the <code>exclude</code> option. Artifacts can be excluded by using more explicit paths or by using the <code>!</code> negation operator. When using the <code>!</code> operator, the negated pattern(s) must come after the more generic ones.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nartifacts = [\n  \"*.so\",\n  \"*.dll\",\n  \"!/foo/*.so\",\n]\n</code></pre> <pre><code>[build.targets.wheel]\nartifacts = [\n  \"*.so\",\n  \"*.dll\",\n  \"!/foo/*.so\",\n]\n</code></pre>"},{"location":"config/build/#explicit-selection","title":"Explicit selection","text":""},{"location":"config/build/#generic","title":"Generic","text":"<p>You can use the <code>only-include</code> option to prevent directory traversal starting at the project root and only select specific relative paths to directories or files. Using this option ignores any defined <code>include</code> patterns.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\nonly-include = [\"pkg\", \"tests/unit\"]\n</code></pre> <pre><code>[build.targets.sdist]\nonly-include = [\"pkg\", \"tests/unit\"]\n</code></pre>"},{"location":"config/build/#packages","title":"Packages","text":"<p>The <code>packages</code> option is semantically equivalent to <code>only-include</code> (which takes precedence) except that the shipped path will be collapsed to only include the final component.</p> <p>So for example, if you want to ship a package <code>foo</code> that is stored in a directory <code>src</code> you would do:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre> <pre><code>[build.targets.wheel]\npackages = [\"src/foo\"]\n</code></pre>"},{"location":"config/build/#forced-inclusion","title":"Forced inclusion","text":"<p>The <code>force-include</code> option allows you to select specific files or directories from anywhere on the file system that should be included and map them to the desired relative distribution path.</p> <p>For example, if there was a directory alongside the project root named <code>artifacts</code> containing a file named <code>lib.so</code> and a file named <code>lib.h</code> in your home directory, you could ship both files in a <code>pkg</code> directory with the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel.force-include]\n\"../artifacts\" = \"pkg\"\n\"~/lib.h\" = \"pkg/lib.h\"\n</code></pre> <pre><code>[build.targets.wheel.force-include]\n\"../artifacts\" = \"pkg\"\n\"~/lib.h\" = \"pkg/lib.h\"\n</code></pre> <p>Note</p> <ul> <li>Files must be mapped exactly to their desired paths, not to directories.</li> <li>The contents of directory sources are recursively included.</li> <li>To map directory contents directly to the root use <code>/</code> (a forward slash).</li> <li>Sources that do not exist will raise an error.</li> </ul> <p>Warning</p> <p>Files included using this option will overwrite any file path that was already included by other file selection options.</p>"},{"location":"config/build/#default-file-selection","title":"Default file selection","text":"<p>If no file selection options are provided, then what gets included is determined by each build target.</p>"},{"location":"config/build/#excluding-files-outside-packages","title":"Excluding files outside packages","text":"<p>If you want to exclude non-artifact files that do not reside within a Python package, set <code>only-packages</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nonly-packages = true\n</code></pre> <pre><code>[build.targets.wheel]\nonly-packages = true\n</code></pre>"},{"location":"config/build/#rewriting-paths","title":"Rewriting paths","text":"<p>You can rewrite relative paths to directories with the <code>sources</code> option. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel.sources]\n\"src/foo\" = \"bar\"\n</code></pre> <pre><code>[build.targets.wheel.sources]\n\"src/foo\" = \"bar\"\n</code></pre> <p>would distribute the file <code>src/foo/file.ext</code> as <code>bar/file.ext</code>.</p> <p>If you want to remove path prefixes entirely, rather than setting each to an empty string, you can define <code>sources</code> as an array:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nsources = [\"src\"]\n</code></pre> <pre><code>[build.targets.wheel]\nsources = [\"src\"]\n</code></pre> <p>If you want to add a prefix to paths, you can use an empty string. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel.sources]\n\"\" = \"foo\"\n</code></pre> <pre><code>[build.targets.wheel.sources]\n\"\" = \"foo\"\n</code></pre> <p>would distribute the file <code>bar/file.ext</code> as <code>foo/bar/file.ext</code>.</p> <p>The packages option itself relies on sources. Defining <code>packages = [\"src/foo\"]</code> for the <code>wheel</code> target is equivalent to the following:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\nonly-include = [\"src/foo\"]\nsources = [\"src\"]\n</code></pre> <pre><code>[build.targets.wheel]\nonly-include = [\"src/foo\"]\nsources = [\"src\"]\n</code></pre>"},{"location":"config/build/#performance","title":"Performance","text":"<p>All encountered directories are traversed by default. To skip non-artifact directories that are excluded, set <code>skip-excluded-dirs</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\nskip-excluded-dirs = true\n</code></pre> <pre><code>[build]\nskip-excluded-dirs = true\n</code></pre> <p>Warning</p> <p>This may result in not shipping desired files. For example, if you want to include the file <code>a/b/c.txt</code> but your VCS ignores <code>a/b</code>, the file <code>c.txt</code> will not be seen because its parent directory will not be entered. In such cases you can use the <code>force-include</code> option.</p>"},{"location":"config/build/#reproducible-builds","title":"Reproducible builds","text":"<p>By default, build targets will build in a reproducible manner provided that they support that behavior. To disable this, set <code>reproducible</code> to <code>false</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\nreproducible = false\n</code></pre> <pre><code>[build]\nreproducible = false\n</code></pre> <p>When enabled, the SOURCE_DATE_EPOCH environment variable will be used for all build timestamps. If not set, then Hatch will use an unchanging default value.</p>"},{"location":"config/build/#output-directory","title":"Output directory","text":"<p>When the output directory is not provided to the <code>build</code> command, the <code>dist</code> directory will be used by default. You can change the default to a different directory using a relative or absolute path like so:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\ndirectory = \"&lt;PATH&gt;\"\n</code></pre> <pre><code>[build]\ndirectory = \"&lt;PATH&gt;\"\n</code></pre>"},{"location":"config/build/#dev-mode","title":"Dev mode","text":"<p>By default for dev mode environment installations or editable installs, the <code>wheel</code> target will determine which directories should be added to Python's search path based on the selected files.</p> <p>If you want to override this detection or perhaps instruct other build targets as well, you can use the <code>dev-mode-dirs</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\ndev-mode-dirs = [\".\"]\n</code></pre> <pre><code>[build]\ndev-mode-dirs = [\".\"]\n</code></pre> <p>If you don't want to add entire directories to Python's search path, you can enable a more targeted mechanism with the mutually exclusive <code>dev-mode-exact</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\ndev-mode-exact = true\n</code></pre> <pre><code>[build]\ndev-mode-exact = true\n</code></pre> <p>Warning</p> <p>The <code>dev-mode-exact</code> mechanism is not supported by static analysis tools &amp; IDEs, therefore functionality such as autocompletion is unlikely to work.</p>"},{"location":"config/build/#build-targets","title":"Build targets","text":"<p>A build target can be provided by any builder plugin. There are three built-in build targets: wheel, sdist, and custom.</p>"},{"location":"config/build/#dependencies","title":"Dependencies","text":"<p>You can specify additional dependencies that will be installed in each build environment, such as for third party builders:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.your-target-name]\ndependencies = [\n  \"your-builder-plugin\"\n]\n</code></pre> <pre><code>[build.targets.your-target-name]\ndependencies = [\n  \"your-builder-plugin\"\n]\n</code></pre> <p>You can also declare dependence on the project's runtime dependencies with the <code>require-runtime-dependencies</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.your-target-name]\nrequire-runtime-dependencies = true\n</code></pre> <pre><code>[build.targets.your-target-name]\nrequire-runtime-dependencies = true\n</code></pre> <p>Additionally, you may declare dependence on specific runtime features of the project with the <code>require-runtime-features</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.your-target-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre> <pre><code>[build.targets.your-target-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre>"},{"location":"config/build/#versions","title":"Versions","text":"<p>If a build target supports multiple build strategies or if there are major changes over time, you can specify exactly which versions you want to build using the <code>versions</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;TARGET_NAME&gt;]\nversions = [\n  \"v1\",\n  \"beta-feature\",\n]\n</code></pre> <pre><code>[build.targets.&lt;TARGET_NAME&gt;]\nversions = [\n  \"v1\",\n  \"beta-feature\",\n]\n</code></pre> <p>See the wheel target for a real world example.</p>"},{"location":"config/build/#build-hooks","title":"Build hooks","text":"<p>A build hook defines code that will be executed at various stages of the build process and can be provided by any build hook plugin. There is one built-in build hook: custom.</p> <p>Build hooks can be applied either globally:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.&lt;HOOK_NAME&gt;]\n</code></pre> <pre><code>[build.hooks.&lt;HOOK_NAME&gt;]\n</code></pre> <p>or to specific build targets:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;HOOK_NAME&gt;]\n</code></pre> <pre><code>[build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;HOOK_NAME&gt;]\n</code></pre>"},{"location":"config/build/#dependencies_1","title":"Dependencies","text":"<p>You can specify additional dependencies that will be installed in each build environment, such as for third party build hooks:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.your-hook-name]\ndependencies = [\n  \"your-build-hook-plugin\"\n]\n</code></pre> <pre><code>[build.hooks.your-hook-name]\ndependencies = [\n  \"your-build-hook-plugin\"\n]\n</code></pre> <p>You can also declare dependence on the project's runtime dependencies with the <code>require-runtime-dependencies</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.your-hook-name]\nrequire-runtime-dependencies = true\n</code></pre> <pre><code>[build.hooks.your-hook-name]\nrequire-runtime-dependencies = true\n</code></pre> <p>Additionally, you may declare dependence on specific runtime features of the project with the <code>require-runtime-features</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.your-hook-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre> <pre><code>[build.hooks.your-hook-name]\nrequire-runtime-features = [\n  \"feature1\",\n  \"feature2\",\n]\n</code></pre>"},{"location":"config/build/#order-of-execution","title":"Order of execution","text":"<p>For each build target, build hooks execute in the order in which they are defined, starting with global hooks.</p> <p>As an example, for the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.foo.hooks.hook2]\n\n[tool.hatch.build.hooks.hook3]\n[tool.hatch.build.hooks.hook1]\n</code></pre> <pre><code>[build.targets.foo.hooks.hook2]\n\n[build.hooks.hook3]\n[build.hooks.hook1]\n</code></pre> <p>When target <code>foo</code> is built, build hook <code>hook3</code> will be executed first, followed by <code>hook1</code>, and then finally <code>hook2</code>.</p>"},{"location":"config/build/#conditional-execution","title":"Conditional execution","text":"<p>If you want to disable a build hook by default and control its use by environment variables, you can do so by setting the <code>enable-by-default</code> option to <code>false</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.&lt;HOOK_NAME&gt;]\nenable-by-default = false\n</code></pre> <pre><code>[build.hooks.&lt;HOOK_NAME&gt;]\nenable-by-default = false\n</code></pre>"},{"location":"config/build/#environment-variables","title":"Environment variables","text":"Variable Default Description <code>HATCH_BUILD_CLEAN</code> <code>false</code> Whether or not existing artifacts should first be removed <code>HATCH_BUILD_CLEAN_HOOKS_AFTER</code> <code>false</code> Whether or not build hook artifacts should be removed after each build <code>HATCH_BUILD_HOOKS_ONLY</code> <code>false</code> Whether or not to only execute build hooks <code>HATCH_BUILD_NO_HOOKS</code> <code>false</code> Whether or not to disable all build hooks; this takes precedence over other options <code>HATCH_BUILD_HOOKS_ENABLE</code> <code>false</code> Whether or not to enable all build hooks <code>HATCH_BUILD_HOOK_ENABLE_&lt;HOOK_NAME&gt;</code> <code>false</code> Whether or not to enable the build hook named <code>&lt;HOOK_NAME&gt;</code> <code>HATCH_BUILD_LOCATION</code> <code>dist</code> The location with which to build the targets; only used by the <code>build</code> command <ol> <li> <p>Support for PEP 517 and PEP 660 guarantees interoperability with other build tools.\u00a0\u21a9</p> </li> </ol>"},{"location":"config/context/","title":"Context formatting","text":"<p>You can populate configuration with the values of certain supported fields using the syntax of Python's format strings. Each field interprets the modifier part after the colon differently, if at all.</p>"},{"location":"config/context/#global-fields","title":"Global fields","text":"<p>Any configuration that declares support for context formatting will always support these fields.</p>"},{"location":"config/context/#paths","title":"Paths","text":"Field Description <code>root</code> The root project directory <code>home</code> The user's home directory <p>All paths support the following modifiers:</p> Modifier Description <code>uri</code> The normalized absolute URI path prefixed by <code>file:</code> <code>real</code> The path with all symbolic links resolved <code>parent</code> The parent of the preceding path <p>Tip</p> <p>The <code>parent</code> modifier can be chained and may be combined with either the <code>uri</code> or <code>real</code> modifier, with the latter placed at the end. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n    \"example-project @ {root:parent:parent:uri}/example-project\",\n]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n    \"example-project @ {root:parent:parent:uri}/example-project\",\n]\n</code></pre>"},{"location":"config/context/#system-separators","title":"System separators","text":"Field Description <code>/</code> <code>\\</code> on Windows, <code>/</code> otherwise <code>;</code> <code>;</code> on Windows, <code>:</code> otherwise"},{"location":"config/context/#environment-variables","title":"Environment variables","text":"<p>The <code>env</code> field and its modifier allow you to select the value of an environment variable. If the environment variable is not set, you must specify a default value as an additional modifier e.g. <code>{env:PATH:DEFAULT}</code>.</p>"},{"location":"config/context/#field-nesting","title":"Field nesting","text":"<p>You can insert fields within others. For example, if you wanted a script that displays the value of the environment variable <code>FOO</code>, with a fallback to the environment variable <code>BAR</code>, with its own fallback to the user's home directory, you could do the following:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.scripts]\ndisplay = \"echo {env:FOO:{env:BAR:{home}}}\"\n</code></pre> <pre><code>[envs.test.scripts]\ndisplay = \"echo {env:FOO:{env:BAR:{home}}}\"\n</code></pre>"},{"location":"config/dependency/","title":"Dependency configuration","text":"<p>Project dependencies are defined with PEP 508 strings using optional PEP 440 version specifiers.</p>"},{"location":"config/dependency/#version-specifiers","title":"Version specifiers","text":"<p>A version specifier consists of a series of version clauses, separated by commas. For example:</p>  pyproject.toml <pre><code>[project]\n...\ndependencies = [\n  \"cryptography\",\n  \"click&gt;=7, &lt;9, != 8.0.0\",\n  \"python-dateutil==2.8.*\",\n  \"numpy~=1.21.4\",\n]\n</code></pre> <p>The comma is equivalent to a logical <code>AND</code> operator: a candidate version must match all given version clauses in order to match the specifier as a whole.</p>"},{"location":"config/dependency/#operators","title":"Operators","text":"Operators Function <code>~=</code> Compatible release <code>==</code> Version matching <code>!=</code> Version exclusion <code>&lt;=</code>, <code>&gt;=</code> Inclusive ordered comparison <code>&lt;</code>, <code>&gt;</code> Exclusive ordered comparison <code>===</code> Arbitrary equality"},{"location":"config/dependency/#version-matching","title":"Version matching","text":"<p>A version matching clause includes the version matching operator <code>==</code> and a version identifier.</p> <p>By default, the version matching operator is based on a strict equality comparison: the specified version must be exactly the same as the requested version.</p> Clause Allowed versions <code>==1</code> <code>1.0.0</code> <code>==1.2</code> <code>1.2.0</code> <p>Prefix matching may be requested instead of strict comparison, by appending a trailing <code>.*</code> to the version identifier in the version matching clause. This means that additional trailing segments will be ignored when determining whether or not a version identifier matches the clause.</p> Clause Allowed versions <code>==1.*</code> <code>&gt;=1.0.0, &lt;2.0.0</code> <code>==1.2.*</code> <code>&gt;=1.2.0, &lt;1.3.0</code>"},{"location":"config/dependency/#compatible-release","title":"Compatible release","text":"<p>A compatible release clause consists of the compatible release operator <code>~=</code> and a version identifier. It matches any candidate version that is expected to be compatible with the specified version.</p> <p>For a given release identifier <code>V.N</code>, the compatible release clause is approximately equivalent to the following pair of comparison clauses:</p> <pre><code>&gt;= V.N, == V.*\n</code></pre> <p>This operator cannot be used with a single segment version number such as <code>~=1</code>.</p> Clause Allowed versions <code>~=1.2</code> <code>&gt;=1.2.0, &lt;2.0.0</code> <code>~=1.2.3</code> <code>&gt;=1.2.3, &lt;1.3.0</code>"},{"location":"config/dependency/#version-exclusion","title":"Version exclusion","text":"<p>A version exclusion clause includes the version exclusion operator <code>!=</code> and a version identifier.</p> <p>The allowed version identifiers and comparison semantics are the same as those of the Version matching operator, except that the sense of any match is inverted.</p>"},{"location":"config/dependency/#ordered-comparison","title":"Ordered comparison","text":"<p>Inclusive comparisons allow for the version identifier part of clauses whereas exclusive comparisons do not. For example, <code>&gt;=1.2</code> allows for version <code>1.2.0</code> while <code>&gt;1.2</code> does not.</p> <p>Unlike the inclusive ordered comparisons <code>&lt;=</code> and <code>&gt;=</code>, the exclusive ordered comparisons <code>&lt;</code> and <code>&gt;</code> specifically exclude pre-releases, post-releases, and local versions of the specified version.</p>"},{"location":"config/dependency/#arbitrary-equality","title":"Arbitrary equality","text":"<p>Though heavily discouraged, arbitrary equality comparisons allow for simple string matching without any version semantics, for example <code>===foobar</code>.</p>"},{"location":"config/dependency/#environment-markers","title":"Environment markers","text":"<p>Environment markers allow for dependencies to only be installed when certain conditions are met.</p> <p>For example, if you need to install the latest version of <code>cryptography</code> that is available for a given Python major version you could define the following:</p> <pre><code>cryptography==3.3.2; python_version &lt; \"3\"\ncryptography&gt;=35.0; python_version &gt; \"3\"\n</code></pre> <p>Alternatively, if you only need it on Python 3 when running on Windows you could do:</p> <pre><code>cryptography; python_version ~= \"3.0\" and platform_system == \"Windows\"\n</code></pre> <p>The available environment markers are as follows.</p> Marker Python equivalent Examples <code>os_name</code> <code>import os</code><code>os.name</code> <ul><li>posix</li><li>java</li></ul> <code>sys_platform</code> <code>import sys</code><code>sys.platform</code> <ul><li>linux</li><li>win32</li><li>darwin</li></ul> <code>platform_machine</code> <code>import platform</code><code>platform.machine()</code> <ul><li>x86_64</li></ul> <code>platform_python_implementation</code> <code>import platform</code><code>platform.python_implementation()</code> <ul><li>CPython</li><li>Jython</li></ul> <code>platform_release</code> <code>import platform</code><code>platform.release()</code> <ul><li>1.8.0_51</li><li>3.14.1-x86_64-linode39</li></ul> <code>platform_system</code> <code>import platform</code><code>platform.system()</code> <ul><li>Linux</li><li>Windows</li><li>Darwin</li></ul> <code>platform_version</code> <code>import platform</code><code>platform.version()</code> <ul><li>10.0.19041</li><li>#1 SMP Fri Apr 2 22:23:49 UTC 2021</li></ul> <code>python_version</code> <code>import platform</code><code>'.'.join(platform.python_version_tuple()[:2])</code> <ul><li>2.7</li><li>3.10</li></ul> <code>python_full_version</code> <code>import platform</code><code>platform.python_version()</code> <ul><li>2.7.18</li><li>3.11.0b1</li></ul> <code>implementation_name</code> <code>import sys</code><code>sys.implementation.name</code> <ul><li>cpython</li></ul> <code>implementation_version</code> See here <ul><li>2.7.18</li><li>3.11.0b1</li></ul>"},{"location":"config/dependency/#features","title":"Features","text":"<p>You can select groups of optional dependencies to install using the extras syntax. For example, if a dependency named <code>foo</code> defined the following:</p>  pyproject.toml <pre><code>[project.optional-dependencies]\ncrypto = [\n  \"PyJWT\",\n  \"cryptography\",\n]\nfastjson = [\n  \"orjson\",\n]\ncli = [\n  \"prompt-toolkit\",\n  \"colorama; platform_system == 'Windows'\",\n]\n</code></pre> <p>You can select the <code>cli</code> and <code>crypto</code> features like so:</p> <pre><code>foo[cli,crypto]==1.*\n</code></pre> <p>Note that the features come immediately after the package name, before any version specifiers.</p>"},{"location":"config/dependency/#self-referential","title":"Self-referential","text":"<p>Feature groups can self-referentially extend others. For example, for a project called <code>awesome-project</code>, the <code>dev</code> feature group in the following <code>pyproject.toml</code> file would select everything in the <code>crypto</code> feature group, plus <code>black</code>:</p>  pyproject.toml <pre><code>[project]\nname = \"awesome-project\"\n\n[project.optional-dependencies]\ncrypto = [\n  \"PyJWT\",\n  \"cryptography\",\n]\ndev = [\n  \"awesome-project[crypto]\",\n  \"black\",\n]\n</code></pre>"},{"location":"config/dependency/#direct-references","title":"Direct references","text":"<p>Instead of using normal version specifiers and fetching packages from an index like PyPI, you can define exact sources using direct references with an explicit URI.</p> <p>Direct references are usually not meant to be used for dependencies of a published project but rather are used for defining dependencies for an environment.</p> <p>All direct reference types are prefixed by the package name like:</p> <pre><code>&lt;NAME&gt; @ &lt;REFERENCE&gt;\n</code></pre>"},{"location":"config/dependency/#version-control-systems","title":"Version control systems","text":"<p>Various version control systems (VCS) are supported as long as the associated executable is available along your <code>PATH</code>.</p> <p>VCS direct references are defined using one of the following formats:</p> <pre><code>&lt;NAME&gt; @ &lt;SCHEME&gt;://&lt;PATH&gt;\n&lt;NAME&gt; @ &lt;SCHEME&gt;://&lt;PATH&gt;@&lt;REVISION&gt;\n</code></pre> <p>You may also append a <code>#subdirectory=&lt;PATH&gt;</code> component for specifying the relative path to the Python package when it is not located at the root e.g. <code>#subdirectory=lib/foo</code>.</p> <p>For more information, refer to this.</p>"},{"location":"config/dependency/#supported-vcs","title":"Supported VCS","text":"GitMercurialSubversionBazaar Executable Schemes Revisions Example <code>git</code> <ul><li><code>git+file</code></li><li><code>git+https</code></li><li><code>git+ssh</code></li><li><code>git+http</code> </li><li><code>git+git</code> </li><li><code>git</code> </li></ul> <ul><li>Commit hash</li><li>Tag name</li><li>Branch name</li></ul> <code>proj @ git+https://github.com/org/proj.git@v1</code> Executable Schemes Revisions Example <code>hg</code> <ul><li><code>hg+file</code></li><li><code>hg+https</code></li><li><code>hg+ssh</code></li><li><code>hg+http</code> </li><li><code>hg+static-http</code> </li></ul> <ul><li>Revision hash</li><li>Revision number</li><li>Tag name</li><li>Branch name</li></ul> <code>proj @ hg+file:///path/to/proj@v1</code> Executable Schemes Revisions Example <code>svn</code> <ul><li><code>svn+https</code></li><li><code>svn+ssh</code></li><li><code>svn+http</code> </li><li><code>svn+svn</code> </li><li><code>svn</code> </li></ul> <ul><li>Revision number</li></ul> <code>proj @ svn+file:///path/to/proj</code> Executable Schemes Revisions Example <code>bzr</code> <ul><li><code>bzr+https</code></li><li><code>bzr+ssh</code></li><li><code>bzr+sftp</code></li><li><code>bzr+lp</code></li><li><code>bzr+http</code> </li><li><code>bzr+ftp</code> </li></ul> <ul><li>Revision number</li><li>Tag name</li></ul> <code>proj @ bzr+lp:proj@v1</code>"},{"location":"config/dependency/#local","title":"Local","text":"<p>You can install local packages with the <code>file</code> scheme in the following format:</p> <pre><code>&lt;NAME&gt; @ file://&lt;HOST&gt;/&lt;PATH&gt;\n</code></pre> <p>The <code>&lt;HOST&gt;</code> is only used on Windows systems, where it can refer to a network share. If omitted it is assumed to be <code>localhost</code> and the third slash must still be present.</p> <p>The <code>&lt;PATH&gt;</code> can refer to a source archive, a wheel, or a directory containing a Python package.</p> Type Unix Windows Source archive <code>proj @ file:///path/to/pkg.tar.gz</code> <code>proj @ file:///c:/path/to/pkg.tar.gz</code> Wheel <code>proj @ file:///path/to/pkg.whl</code> <code>proj @ file:///c:/path/to/pkg.whl</code> Directory <code>proj @ file:///path/to/pkg</code> <code>proj @ file:///c:/path/to/pkg</code> <p>Tip</p> <p>You may also specify paths relative to your project's root directory on all platforms by using context formatting:</p> <pre><code>&lt;NAME&gt; @ {root:uri}/pkg_inside_project\n&lt;NAME&gt; @ {root:uri}/../pkg_alongside_project\n</code></pre>"},{"location":"config/dependency/#remote","title":"Remote","text":"<p>You can install source archives and wheels by simply referring to a URL:</p> <pre><code>black @ https://github.com/psf/black/archive/refs/tags/21.10b0.zip\npytorch @ https://download.pytorch.org/whl/cu102/torch-1.10.0%2Bcu102-cp39-cp39-linux_x86_64.whl\n</code></pre> <p>An expected hash value may be specified by appending a <code>#&lt;HASH_ALGORITHM&gt;=&lt;EXPECTED_HASH&gt;</code> component:</p> <pre><code>requests @ https://github.com/psf/requests/archive/refs/tags/v2.26.0.zip#sha256=eb729a757f01c10546ebd179ae2aec852dd0d7f8ada2328ccf4558909d859985\n</code></pre> <p>If the hash differs from the expected hash, the installation will fail.</p> <p>It is recommended that only hashes which are unconditionally provided by the latest version of the standard library's hashlib module be used for hashes. As of Python 3.10, that list consists of:</p> <ul> <li><code>md5</code></li> <li><code>sha1</code></li> <li><code>sha224</code></li> <li><code>sha256</code></li> <li><code>sha384</code></li> <li><code>sha512</code></li> <li><code>blake2b</code></li> <li><code>blake2s</code></li> </ul>"},{"location":"config/dependency/#complex-syntax","title":"Complex syntax","text":"<p>The following is an example that uses features and environment markers:</p> <pre><code>pkg[feature1,feature2] @ &lt;REFERENCE&gt; ; python_version &lt; \"3.7\"\n</code></pre> <p>Note that the space before the semicolon is required.</p>"},{"location":"config/hatch/","title":"Hatch configuration","text":"<p>Configuration for Hatch itself is stored in a <code>config.toml</code> file located by default in one of the following platform-specific directories.</p> Platform Path macOS <code>~/Library/Application Support/hatch</code> Windows <code>%USERPROFILE%\\AppData\\Local\\hatch</code> Unix <code>$XDG_CONFIG_HOME/hatch</code> (the XDG_CONFIG_HOME environment variable default is <code>~/.config</code>) <p>You can select a custom path to the file using the <code>--config</code> root option or by setting the <code>HATCH_CONFIG</code> environment variable.</p> <p>The file can be managed by the <code>config</code> command group.</p>"},{"location":"config/hatch/#mode","title":"Mode","text":"<p>The <code>mode</code> key controls how Hatch selects the project to work on.</p>"},{"location":"config/hatch/#local","title":"Local","text":"config.toml <pre><code>mode = \"local\"\n</code></pre> <p>By default, Hatch will look for a <code>pyproject.toml</code> file in the current working directory and any parent directories. The directory storing the first found file will be considered the project root.</p>"},{"location":"config/hatch/#project","title":"Project","text":"config.toml <pre><code>mode = \"project\"\nproject = \"proj1\"\n\n[projects]\nproj1 = \"/path/to/project1\"\nproj2 = {\"location\": \"/path/to/project2\"}\n\n[dirs]\nproject = [\"/path/to/monorepo1\", \"/path/to/monorepo2\"]\n</code></pre> <p>In this mode, Hatch will only work on the selected <code>project</code>. The project is located using multiple heuristics:</p> <ol> <li>If the project is defined in the <code>projects</code> table then it must be a string, or an inline table with a <code>location</code> key, that is the full path to the project.</li> <li>If the project matches a subdirectory in any of the directories listed in <code>dirs.project</code>, then that will be used as the project root.</li> </ol> <p>An error will occur if the project cannot be found.</p> <p>You can use the <code>config set</code> command to change the project you are working on:</p> <pre><code>$ hatch config set project proj2\nNew setting:\nproject = \"proj2\"\n</code></pre> <p>The project can be selected on a per-command basis with the <code>-p</code>/<code>--project</code> (environment variable <code>HATCH_PROJECT</code>) root option.</p>"},{"location":"config/hatch/#aware","title":"Aware","text":"config.toml <pre><code>mode = \"aware\"\n</code></pre> <p>This is essentially the <code>local</code> mode with a fallback to the <code>project</code> mode.</p>"},{"location":"config/hatch/#shell","title":"Shell","text":"<p>You can control the shell used to enter environments with the <code>shell</code> key.</p> <p>If defined as a string, it must be the name of one of the supported shells and be available along your <code>PATH</code>.</p>  config.toml <pre><code>shell = \"fish\"\n</code></pre> <p>If the executable name of your shell differs from the supported name, you can define the <code>shell</code> as a table with <code>name</code> and <code>path</code> keys.</p>  config.toml <pre><code>[shell]\nname = \"bash\"\npath = \"/bin/ash\"\n</code></pre> <p>You can change the default arguments used to spawn most shells with the <code>args</code> key. The default for such supported shells is usually <code>[\"-i\"]</code>.</p>  config.toml <pre><code>[shell]\nname = \"bash\"\nargs = [\"--login\"]\n</code></pre>"},{"location":"config/hatch/#supported","title":"Supported","text":"Shell Name Arguments macOS Windows Unix Almquist shell <code>ash</code> <code>[\"-i\"]</code> Bash <code>bash</code> <code>[\"-i\"]</code> Command Prompt <code>cmd</code> C shell <code>csh</code> <code>[\"-i\"]</code> fish <code>fish</code> <code>[\"-i\"]</code> Nushell <code>nu</code> <code>[]</code> PowerShell <code>pwsh</code>, <code>powershell</code> tcsh <code>tcsh</code> <code>[\"-i\"]</code> xonsh <code>xonsh</code> <code>[\"-i\"]</code> Z shell <code>zsh</code> <code>[\"-i\"]</code>"},{"location":"config/hatch/#default","title":"Default","text":"<p>Hatch will attempt to use the current shell based on parent processes. If the shell cannot be determined, then on Windows systems Hatch will use the <code>SHELL</code> environment variable, if present, followed by the <code>COMSPEC</code> environment variable, defaulting to <code>cmd</code>. On all other platforms only the <code>SHELL</code> environment variable will be used, defaulting to <code>bash</code>.</p>"},{"location":"config/hatch/#directories","title":"Directories","text":""},{"location":"config/hatch/#data","title":"Data","text":"config.toml <pre><code>[dirs]\ndata = \"...\"\n</code></pre> <p>This is the directory that is used to persist data. By default it is set to one of the following platform-specific directories.</p> Platform Path macOS <code>~/Library/Application Support/hatch</code> Windows <code>%USERPROFILE%\\AppData\\Local\\hatch</code> Unix <code>$XDG_DATA_HOME/hatch</code> (the XDG_DATA_HOME environment variable default is <code>~/.local/share</code>) <p>You can select a custom path to the directory using the <code>--data-dir</code> root option or by setting the <code>HATCH_DATA_DIR</code> environment variable.</p>"},{"location":"config/hatch/#cache","title":"Cache","text":"config.toml <pre><code>[dirs]\ncache = \"...\"\n</code></pre> <p>This is the directory that is used to cache data. By default it is set to one of the following platform-specific directories.</p> Platform Path macOS <code>~/Library/Caches/hatch</code> Windows <code>%USERPROFILE%\\AppData\\Local\\hatch\\Cache</code> Unix <code>$XDG_CACHE_HOME/hatch</code> (the XDG_CACHE_HOME environment variable default is <code>~/.cache</code>) <p>You can select a custom path to the directory using the <code>--cache-dir</code> root option or by setting the <code>HATCH_CACHE_DIR</code> environment variable.</p>"},{"location":"config/hatch/#environments","title":"Environments","text":"config.toml <pre><code>[dirs.env]\n&lt;ENV_TYPE&gt; = \"...\"\n</code></pre> <p>This determines where to store environments, with every key being the type of environment and the value being the desired storage location.</p> <p>For example, if you wanted to store virtual environments in a <code>.virtualenvs</code> directory within your home directory, you could specify the following:</p>  config.toml <pre><code>[dirs.env]\nvirtual = \"~/.virtualenvs\"\n</code></pre> <p>Any environment variables are also expanded.</p> <p>If the path is not absolute, then it will be relative to the project root. So if you wanted to use a directory named <code>.hatch</code> in each project directory, you could do:</p>  config.toml <pre><code>[dirs.env]\nvirtual = \".hatch\"\n</code></pre> <p>Any type of environment that is not explicitly defined will default to <code>&lt;DATA_DIR&gt;/env/&lt;ENV_TYPE&gt;</code>.</p>"},{"location":"config/hatch/#python-installations","title":"Python installations","text":"config.toml <pre><code>[dirs]\npython = \"...\"\n</code></pre> <p>This determines where to install specific versions of Python.</p> <p>The following values have special meanings:</p> Value Path <code>isolated</code> (default) <code>&lt;DATA_DIR&gt;/pythons</code>"},{"location":"config/hatch/#terminal","title":"Terminal","text":"<p>You can configure how all output is displayed using the <code>terminal.styles</code> table. These settings are also applied to all plugins.</p>  config.toml <pre><code>[terminal.styles]\nerror = \"...\"\n...\n</code></pre> <p>Cross-platform terminal capabilities are provided by Rich.</p>"},{"location":"config/hatch/#output-levels","title":"Output levels","text":"<p>The levels of output are as follows. Note that the verbosity indicates the minimum level at which the output is displayed.</p> Level Default Verbosity Description <code>debug</code> <code>bold</code> 1 - 3 Messages that are not useful for most user experiences <code>error</code> <code>bold red</code> -2 Messages indicating some unrecoverable error <code>info</code> <code>bold</code> 0 Messages conveying basic information <code>success</code> <code>bold cyan</code> 0 Messages indicating some positive outcome <code>waiting</code> <code>bold magenta</code> 0 Messages shown before potentially time consuming operations <code>warning</code> <code>bold yellow</code> -1 Messages conveying important information <p>See the documentation and color reference for guidance on valid values.</p>"},{"location":"config/hatch/#spinner","title":"Spinner","text":"<p>You can select the sequence used for waiting animations with the <code>spinner</code> option.</p>  config.toml <pre><code>[terminal.styles]\nspinner = \"...\"\n</code></pre>"},{"location":"config/metadata/","title":"Configuring project metadata","text":"<p>Project metadata is stored in a <code>pyproject.toml</code> file located at the root of a project's tree and is based entirely on the standard.</p>"},{"location":"config/metadata/#name","title":"Name (required)","text":"<p>The name of the project.</p>  pyproject.toml <pre><code>[project]\nname = \"your-app\"\n</code></pre>"},{"location":"config/metadata/#version","title":"Version (required)","text":"pyproject.toml DynamicStatic <p>See the dedicated versioning section.</p> <pre><code>[project]\n...\ndynamic = [\"version\"]\n\n[tool.hatch.version]\npath = \"...\"\n</code></pre> <pre><code>[project]\n...\nversion = \"0.0.1\"\n</code></pre>"},{"location":"config/metadata/#description","title":"Description","text":"<p>A brief summary of the project.</p>  pyproject.toml <pre><code>[project]\n...\ndescription = '...'\n</code></pre>"},{"location":"config/metadata/#readme","title":"Readme","text":"<p>The full description of the project.</p>  pyproject.toml SimpleComplex <p>The file extension must be <code>.md</code>, <code>.rst</code>, or <code>.txt</code>.</p> <pre><code>[project]\n...\nreadme = \"README.md\"\n</code></pre> <p>The <code>content-type</code> field must be set to <code>text/markdown</code>, <code>text/x-rst</code>, or <code>text/plain</code>.</p> FileText <p>A <code>charset</code> field may also be set to instruct which encoding to use for reading the file, defaulting to <code>utf-8</code>.</p> <pre><code>[project]\n...\nreadme = {\"file\" = \"README.md\", \"content-type\" = \"text/markdown\"}\n</code></pre> <p>The <code>content-type</code> field must be set to <code>text/markdown</code> or <code>text/x-rst</code>.</p> <pre><code>[project]\n...\nreadme = {\"text\" = \"...\", \"content-type\" = \"text/markdown\"}\n</code></pre> <p>Note</p> <p>If this is defined as a file, then it will always be included in source distributions for consistent builds.</p>"},{"location":"config/metadata/#python-support","title":"Python support","text":"<p>The Python version requirements of the project.</p>  pyproject.toml <pre><code>[project]\n...\nrequires-python = \"&gt;=3.8\"\n</code></pre>"},{"location":"config/metadata/#license","title":"License","text":"<p>For more information, see PEP 639.</p>  pyproject.toml SPDX expressionFiles <pre><code>[project]\n...\nlicense = \"Apache-2.0 OR MIT\"\n</code></pre> PathsGlobs <pre><code>[project]\n...\nlicense-files = { paths = [\"LICENSE.txt\"] }\n</code></pre> <pre><code>[project]\n...\nlicense-files = { globs = [\"LICENSES/*\"] }\n</code></pre>"},{"location":"config/metadata/#ownership","title":"Ownership","text":"<p>The people or organizations considered to be the <code>authors</code> or <code>maintainers</code> of the project. The exact meaning is open to interpretation; it may list the original or primary authors, current maintainers, or owners of the package. If the values are the same, prefer only the use of the <code>authors</code> field.</p>  pyproject.toml <pre><code>[project]\n...\nauthors = [\n  { name = \"...\", email = \"...\" },\n]\nmaintainers = [\n  { name = \"...\", email = \"...\" },\n]\n</code></pre>"},{"location":"config/metadata/#keywords","title":"Keywords","text":"<p>The keywords used to assist in the discovery of the project.</p>  pyproject.toml <pre><code>[project]\n...\nkeywords = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#classifiers","title":"Classifiers","text":"<p>The trove classifiers that apply to the project.</p>  pyproject.toml <pre><code>[project]\n...\nclassifiers = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#urls","title":"URLs","text":"<p>A table of URLs where the key is the URL label and the value is the URL itself.</p>  pyproject.toml <pre><code>[project.urls]\nDocumentation = \"...\"\n\"Source code\" = \"...\"\n</code></pre>"},{"location":"config/metadata/#dependencies","title":"Dependencies","text":"<p>See the dependency specification page for more information.</p> <p>Entries support context formatting and disallow direct references by default.</p>"},{"location":"config/metadata/#required","title":"Required","text":"pyproject.toml <pre><code>[project]\n...\ndependencies = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#optional","title":"Optional","text":"pyproject.toml <pre><code>[project.optional-dependencies]\noption1 = [\n  \"...\",\n]\noption2 = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#entry-points","title":"Entry points","text":"<p>Entry points are a mechanism for the project to advertise components it provides to be discovered and used by other code.</p>"},{"location":"config/metadata/#cli","title":"CLI","text":"<p>After installing projects that define CLI scripts, each key will be available along your <code>PATH</code> as a command that will call its associated object.</p>  pyproject.toml <pre><code>[project.scripts]\ncli-name = \"pkg.subpkg:func\"\n</code></pre> <p>Using the above example, running <code>cli-name</code> would essentially execute the following Python script:</p> <pre><code>import sys\n\nfrom pkg.subpkg import func\n\nsys.exit(func())\n</code></pre>"},{"location":"config/metadata/#gui","title":"GUI","text":"<p>GUI scripts are exactly the same as CLI scripts except on Windows, where they are handled specially so that they can be started without a console.</p>  pyproject.toml <pre><code>[project.gui-scripts]\ngui-name = \"pkg.subpkg:func\"\n</code></pre>"},{"location":"config/metadata/#plugins","title":"Plugins","text":"pyproject.toml <pre><code>[project.entry-points.plugin-namespace]\nplugin-name1 = \"pkg.subpkg1\"\nplugin-name2 = \"pkg.subpkg2:func\"\n</code></pre>"},{"location":"config/metadata/#dynamic","title":"Dynamic","text":"<p>If any metadata fields are set dynamically, like the <code>version</code> may be, then they must be listed here.</p>  pyproject.toml <pre><code>[project]\n...\ndynamic = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/metadata/#metadata-options","title":"Metadata options","text":""},{"location":"config/metadata/#allowing-direct-references","title":"Allowing direct references","text":"<p>By default, dependencies are not allowed to define direct references. To disable this check, set <code>allow-direct-references</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata]\nallow-direct-references = true\n</code></pre> <pre><code>[metadata]\nallow-direct-references = true\n</code></pre>"},{"location":"config/metadata/#allowing-ambiguous-features","title":"Allowing ambiguous features","text":"<p>By default, names of optional dependencies are normalized to prevent ambiguity. To disable this normalization, set <code>allow-ambiguous-features</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata]\nallow-ambiguous-features = true\n</code></pre> <pre><code>[metadata]\nallow-ambiguous-features = true\n</code></pre> <p>Deprecated</p> <p>This option temporarily exists to provide better interoperability with tools that do not yet support PEP 685 and will be removed in the first minor release after Jan 1, 2024.</p>"},{"location":"config/project-templates/","title":"Project templates","text":"<p>You can control how new projects are created by the new command using Hatch's config file.</p>"},{"location":"config/project-templates/#author","title":"Author","text":"config.toml <pre><code>[template]\nname = \"...\"\nemail = \"...\"\n</code></pre>"},{"location":"config/project-templates/#licenses","title":"Licenses","text":"config.toml <pre><code>[template.licenses]\nheaders = true\ndefault = [\n  \"MIT\",\n]\n</code></pre> <p>The list of licenses should be composed of SPDX identifiers. If multiple licenses are specified, then they will be placed in a LICENSES directory.</p>"},{"location":"config/project-templates/#options","title":"Options","text":""},{"location":"config/project-templates/#tests","title":"Tests","text":"<p>This adds a <code>tests</code> directory with environments for testing and linting.</p>  config.toml <pre><code>[template.plugins.default]\ntests = true\n</code></pre>"},{"location":"config/project-templates/#ci","title":"CI","text":"<p>This adds a GitHub Actions workflow that runs tests on all platforms using modern versions of Python.</p>  config.toml <pre><code>[template.plugins.default]\nci = false\n</code></pre>"},{"location":"config/project-templates/#src-layout","title":"<code>src</code> layout","text":"<p>See this blog post.</p>  config.toml <pre><code>[template.plugins.default]\nsrc-layout = true\n</code></pre>"},{"location":"config/project-templates/#feature-flags","title":"Feature flags","text":""},{"location":"config/project-templates/#command-line-interface","title":"Command line interface","text":"<p>The <code>--cli</code> flag adds a CLI backed by Click that can also be invoked with <code>python -m &lt;PKG_NAME&gt;</code>.</p>"},{"location":"config/environment/advanced/","title":"Advanced environment configuration","text":""},{"location":"config/environment/advanced/#context-formatting","title":"Context formatting","text":"<p>All environments support the following extra context formatting fields:</p> Field Description <code>env_name</code> The name of the environment <code>env_type</code> The type of environment <code>matrix</code> Its modifier selects the value of that matrix variable. If the environment is not part of a matrix or was not generated with the variable, you must specify a default value as an additional modifier e.g. <code>{matrix:version:v1.0.0}</code>. <code>verbosity</code> The integer verbosity value of Hatch. A <code>flag</code> modifier is supported that will render the value as a CLI flag e.g. <code>-2</code> becomes <code>-qq</code>, <code>1</code> becomes <code>-v</code>, and <code>0</code> becomes an empty string. An additional flag integer modifier may be used to adjust the verbosity level. For example, if you wanted to make a command quiet by default, you could use <code>{verbosity:flag:-1}</code> within the command. <code>args</code> For executed commands only, any extra command line arguments with an optional default modifier if none were provided"},{"location":"config/environment/advanced/#matrix","title":"Matrix","text":"<p>Environments can define a series of matrices with the <code>matrix</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"pytest\"\n]\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[envs.test.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>Doing so will result in the product of each variable combination being its own environment.</p>"},{"location":"config/environment/advanced/#naming","title":"Naming","text":"<p>The name of the generated environments will be the variable values of each combination separated by hyphens, altogether prefixed by <code>&lt;ENV_NAME&gt;.</code>. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>would indicate the following unique environments:</p> <pre><code>test.42-foo\ntest.42-bar\n</code></pre> <p>The exceptions to this format are described below.</p>"},{"location":"config/environment/advanced/#python-variables","title":"Python variables","text":"<p>If the variables <code>py</code> or <code>python</code> are specified, then they will rank first in the product result and will be prefixed by <code>py</code> if the value is not. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.test.matrix]]\nversion = [\"42\"]\npython = [\"3.9\", \"pypy3\"]\n</code></pre> <pre><code>[[envs.test.matrix]]\nversion = [\"42\"]\npython = [\"3.9\", \"pypy3\"]\n</code></pre> <p>would generate the following environments:</p> <pre><code>test.py3.9-42\ntest.pypy3-42\n</code></pre> <p>Note</p> <p>The value of this variable sets the Python version.</p>"},{"location":"config/environment/advanced/#name-formatting","title":"Name formatting","text":"<p>You can set the <code>matrix-name-format</code> option to modify how each variable part is formatted which recognizes the placeholders <code>{variable}</code> and <code>{value}</code>. For example, the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\nmatrix-name-format = \"{variable}_{value}\"\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.test]\nmatrix-name-format = \"{variable}_{value}\"\n\n[[envs.test.matrix]]\nversion = [\"42\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>would produce the following environments:</p> <pre><code>test.version_42-feature_foo\ntest.version_42-feature_bar\n</code></pre> <p>By default this option is set to <code>{value}</code>.</p>"},{"location":"config/environment/advanced/#default-environment","title":"Default environment","text":"<p>If the <code>default</code> environment defines matrices, then the generated names will not be prefixed by the environment name. This can be useful for projects that only need a single series of matrices without any standalone environments.</p>"},{"location":"config/environment/advanced/#selection","title":"Selection","text":"<p>Rather than selecting a single generated environment, you can select the root environment to target all of them. For example, if you have the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[tool.hatch.envs.test.scripts]\ncov = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[envs.test.scripts]\ncov = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n</code></pre> <p>you could then run your tests consecutively in all 4 environments with:</p> <pre><code>hatch run test:cov\n</code></pre>"},{"location":"config/environment/advanced/#option-overrides","title":"Option overrides","text":"<p>You can modify options based on the conditions of different sources like matrix variables with the <code>overrides</code> table, using dotted key syntax for each declaration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;.overrides]\n&lt;SOURCE&gt;.&lt;CONDITION&gt;.&lt;OPTION&gt; = &lt;VALUE&gt;\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;.overrides]\n&lt;SOURCE&gt;.&lt;CONDITION&gt;.&lt;OPTION&gt; = &lt;VALUE&gt;\n</code></pre> <p>The type of the selected option determines the types of values.</p>"},{"location":"config/environment/advanced/#platform-overrides","title":"Platform overrides","text":"<p>Options can be modified based on the current platform using the <code>platform</code> source.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nplatform.windows.scripts = [\n  'run=pytest -m \"not io_uring\"',\n]\n</code></pre> <pre><code>[envs.test.overrides]\nplatform.windows.scripts = [\n  'run=pytest -m \"not io_uring\"',\n]\n</code></pre> <p>The following platforms are supported:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul>"},{"location":"config/environment/advanced/#environment-variable-overrides","title":"Environment variable overrides","text":"<p>Environment variables can modify options using the <code>env</code> source.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nenv.GITHUB_ACTIONS.dev-mode = { value = false, if = [\"true\"] }\n</code></pre> <pre><code>[envs.test.overrides]\nenv.GITHUB_ACTIONS.dev-mode = { value = false, if = [\"true\"] }\n</code></pre>"},{"location":"config/environment/advanced/#matrix-variable-overrides","title":"Matrix variable overrides","text":"<p>The matrix variables used to generate each environment can be used to modify options within using the <code>matrix</code> source.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.auth.features = [\n  { value = \"oauth\", if = [\"oauth2\"] },\n  { value = \"kerberos\", if = [\"kerberos\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"legacy\", \"latest\"]\nauth = [\"oauth2\", \"kerberos\", \"noauth\"]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.auth.features = [\n  { value = \"oauth\", if = [\"oauth2\"] },\n  { value = \"kerberos\", if = [\"kerberos\"] },\n]\n\n[[envs.test.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"legacy\", \"latest\"]\nauth = [\"oauth2\", \"kerberos\", \"noauth\"]\n</code></pre>"},{"location":"config/environment/advanced/#name-overrides","title":"Name overrides","text":"<p>When a matrix is defined, the <code>name</code> source can be used for regular expression matching on the generated name, minus the prefix for non-default environments.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nname.\"^0\".env-vars = \"TESTING_UNSTABLE=true\"\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"0.1.0\", \"0.2.0\", \"1.0.0\"]\n</code></pre> <pre><code>[envs.test.overrides]\nname.\"^0\".env-vars = \"TESTING_UNSTABLE=true\"\n\n[[envs.test.matrix]]\nversion = [\"0.1.0\", \"0.2.0\", \"1.0.0\"]\n</code></pre>"},{"location":"config/environment/advanced/#types","title":"Types","text":"<ul> <li> <p>Literal types like strings for the Python version or booleans for skipping installation can be set using the value itself, an inline table, or an array. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.python = \"3.10\"\nmatrix.bar.skip-install = { value = true, if = [\"...\"] }\nenv.CI.dev-mode = [\n  { value = false, if = [\"...\"] },\n  true,\n]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.python = \"3.10\"\nmatrix.bar.skip-install = { value = true, if = [\"...\"] }\nenv.CI.dev-mode = [\n  { value = false, if = [\"...\"] },\n  true,\n]\n</code></pre> <p>For arrays, the first allowed value will be used.</p> </li> <li> <p>Array types like dependencies or commands can be appended to using an array of strings or inline tables. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.dependencies = [\n  \"httpx\",\n  { value = \"cryptography\" },\n]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.dependencies = [\n  \"httpx\",\n  { value = \"cryptography\" },\n]\n</code></pre> </li> <li> <p>Mapping types like environment variables or scripts can have keys set using a string, or an array of strings or inline tables. For example:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.env-vars = \"KEY=VALUE\"\nmatrix.bar.env-vars = [\n  \"KEY1=VALUE1\",\n  { key = \"KEY2\", value = \"VALUE2\" },\n]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.env-vars = \"KEY=VALUE\"\nmatrix.bar.env-vars = [\n  \"KEY1=VALUE1\",\n  { key = \"KEY2\", value = \"VALUE2\" },\n]\n</code></pre> <p>If the value is missing (no <code>=</code> for strings, no <code>value</code> key for inline tables), then the value will be set to the value of the source condition.</p> </li> </ul>"},{"location":"config/environment/advanced/#overwriting","title":"Overwriting","text":"<p>Rather than supplementing the values within mapping types or array types, you can overwrite the option as a whole by prefixing the name with <code>set-</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.foo.set-platforms = [\"macos\", \"linux\"]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.foo.set-platforms = [\"macos\", \"linux\"]\n</code></pre> <p>When overwriting entire options or keys within mappings, override sources are applied in the following order:</p> <ol> <li>platform</li> <li>environment variables</li> <li>matrix variables</li> <li>names</li> </ol>"},{"location":"config/environment/advanced/#conditions","title":"Conditions","text":"<p>You may specify certain extra keys for any inline table that will determine whether or not to apply that entry. These modifiers may be combined with others and any negative evaluation will immediately cause the entry to be skipped.</p>"},{"location":"config/environment/advanced/#allowed-values","title":"Allowed values","text":"<p>The <code>if</code> key represents the allowed values for that condition. If the value of the condition is not listed, then that entry will not be applied:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nmatrix.version.python = { value = \"pypy\", if = [\"3.14\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test.overrides]\nmatrix.version.python = { value = \"pypy\", if = [\"3.14\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre>"},{"location":"config/environment/advanced/#specific-platforms","title":"Specific platforms","text":"<p>The <code>platform</code> key represents the desired platforms. If the current platform is not listed, then that entry will not be applied:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nenv.EXPERIMENTAL.python = { value = \"pypy\", if = [\"1\"], platform = [\"macos\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], platform = [\"linux\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test.overrides]\nenv.EXPERIMENTAL.python = { value = \"pypy\", if = [\"1\"], platform = [\"macos\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], platform = [\"linux\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre>"},{"location":"config/environment/advanced/#required-environment-variables","title":"Required environment variables","text":"<p>The <code>env</code> key represents the required environment variables. If any of the listed environment variables are not set or the defined value does not match, then that entry will not be applied:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.overrides]\nplatform.windows.python = { value = \"pypy\", env = [\"EXPERIMENTAL\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], env = [\"FOO\", \"BAR=BAZ\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[tool.hatch.envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre> <pre><code>[envs.test.overrides]\nplatform.windows.python = { value = \"pypy\", env = [\"EXPERIMENTAL\"] }\nmatrix.version.env-vars = [\n  { key = \"KEY1\", value = \"VALUE1\", if = [\"42\"], env = [\"FOO\", \"BAR=BAZ\"] },\n  { key = \"KEY2\", value = \"VALUE2\", if = [\"3.14\"] },\n]\n\n[[envs.test.matrix]]\nversion = [\"42\", \"3.14\"]\n</code></pre>"},{"location":"config/environment/overview/","title":"Environment configuration","text":"<p>All environments are defined as sections within the <code>tool.hatch.envs</code> table.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\n</code></pre> <p>The storage location for environments is completely configurable.</p> <p>Unless an environment is explicitly selected on the command line, the <code>default</code> environment will be used. The type of this environment defaults to <code>virtual</code>.</p> <p>Info</p> <p>Environments prefixed by <code>hatch-</code> are used for special purposes e.g. testing.</p>"},{"location":"config/environment/overview/#inheritance","title":"Inheritance","text":"<p>All environments inherit from the environment defined by its <code>template</code> option, which defaults to <code>default</code>.</p> <p>So for the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.foo]\ntype = \"baz\"\nskip-install = true\n\n[tool.hatch.envs.bar]\ntemplate = \"foo\"\nskip-install = false\n</code></pre> <pre><code>[envs.foo]\ntype = \"baz\"\nskip-install = true\n\n[envs.bar]\ntemplate = \"foo\"\nskip-install = false\n</code></pre> <p>the environment <code>bar</code> will be of type <code>baz</code> with <code>skip-install</code> set to <code>false</code>.</p> <p>Note</p> <p>Environments do not inherit matrices.</p>"},{"location":"config/environment/overview/#self-referential-environments","title":"Self-referential environments","text":"<p>You can disable inheritance by setting <code>template</code> to the environment's own name:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.foo]\ntemplate = \"foo\"\n</code></pre> <pre><code>[envs.foo]\ntemplate = \"foo\"\n</code></pre>"},{"location":"config/environment/overview/#detached-environments","title":"Detached environments","text":"<p>A common use case is standalone environments that do not require inheritance nor the installation of the project, such as for linting or sometimes building documentation. Enabling the <code>detached</code> option will make the environment self-referential and will skip project installation:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.lint]\ndetached = true\n</code></pre> <pre><code>[envs.lint]\ndetached = true\n</code></pre>"},{"location":"config/environment/overview/#dependencies","title":"Dependencies","text":"<p>You can install dependencies in addition to the ones defined by your project's metadata. Entries support context formatting.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n</code></pre> <p>If you define environments with dependencies that only slightly differ from their inherited environments, you can use the <code>extra-dependencies</code> option to avoid redeclaring the <code>dependencies</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"foo\",\n  \"bar\",\n]\n\n[tool.hatch.envs.experimental]\nextra-dependencies = [\n  \"baz\",\n]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"foo\",\n  \"bar\",\n]\n\n[envs.experimental]\nextra-dependencies = [\n  \"baz\",\n]\n</code></pre> <p>Tip</p> <p>Hatch uses pip to install dependencies so any configuration it supports Hatch does as well. For example, if you wanted to only use a private repository you could set the <code>PIP_INDEX_URL</code> environment variable.</p>"},{"location":"config/environment/overview/#installation","title":"Installation","text":""},{"location":"config/environment/overview/#features","title":"Features (extras)","text":"<p>If your project defines optional dependencies, you can select which groups to install using the <code>features</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.nightly]\nfeatures = [\n  \"server\",\n  \"grpc\",\n]\n</code></pre> <pre><code>[envs.nightly]\nfeatures = [\n  \"server\",\n  \"grpc\",\n]\n</code></pre> <p>Note</p> <p>Features/optional dependencies are also known as <code>extras</code> in other tools.</p>"},{"location":"config/environment/overview/#dev-mode","title":"Dev mode","text":"<p>By default, environments will always reflect the current state of your project on disk. Set <code>dev-mode</code> to <code>false</code> to disable this behavior:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.static]\ndev-mode = false\n</code></pre> <pre><code>[envs.static]\ndev-mode = false\n</code></pre>"},{"location":"config/environment/overview/#skip-install","title":"Skip install","text":"<p>By default, environments will install your project during creation. To ignore this step, set <code>skip-install</code> to <code>true</code>:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.lint]\nskip-install = true\n</code></pre> <pre><code>[envs.lint]\nskip-install = true\n</code></pre>"},{"location":"config/environment/overview/#environment-variables","title":"Environment variables","text":""},{"location":"config/environment/overview/#defined","title":"Defined","text":"<p>You can define environment variables with the <code>env-vars</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[tool.hatch.envs.docs.env-vars]\nSOURCE_DATE_EPOCH = \"1580601600\"\n</code></pre> <pre><code>[envs.docs]\ndependencies = [\n  \"mkdocs\"\n]\n[envs.docs.env-vars]\nSOURCE_DATE_EPOCH = \"1580601600\"\n</code></pre> <p>Values support context formatting.</p>"},{"location":"config/environment/overview/#filters","title":"Filters","text":"<p>By default, environments will have access to all environment variables. You can filter with wildcard patterns using the <code>env-include</code>/<code>env-exclude</code> options:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nenv-include = [\n  \"FOO*\",\n]\nenv-exclude = [\n  \"BAR\",\n]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nenv-include = [\n  \"FOO*\",\n]\nenv-exclude = [\n  \"BAR\",\n]\n</code></pre> <p>Exclusion patterns take precedence but will never affect defined environment variables.</p>"},{"location":"config/environment/overview/#scripts","title":"Scripts","text":"<p>You can define named scripts that may be executed or referenced at the beginning of other scripts. Context formatting is supported.</p> <p>For example, in the following configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n[tool.hatch.envs.test.scripts]\nrun-coverage = \"pytest --cov-config=pyproject.toml --cov=pkg --cov=tests\"\nrun = \"run-coverage --no-cov\"\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n  \"pytest-mock\",\n]\n[envs.test.scripts]\nrun-coverage = \"pytest --cov-config=pyproject.toml --cov=pkg --cov=tests\"\nrun = \"run-coverage --no-cov\"\n</code></pre> <p>the <code>run</code> script would be expanded to:</p> <pre><code>pytest --cov-config=pyproject.toml --cov=pkg --cov=tests --no-cov\n</code></pre> <p>Scripts can also be defined as an array of strings.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.style]\ndetached = true\ndependencies = [\n  \"flake8\",\n  \"black\",\n  \"isort\",\n]\n[tool.hatch.envs.style.scripts]\ncheck = [\n  \"flake8 .\",\n  \"black --check --diff .\",\n  \"isort --check-only --diff .\",\n]\nfmt = [\n  \"isort .\",\n  \"black .\",\n  \"check\",\n]\n</code></pre> <pre><code>[envs.style]\ndetached = true\ndependencies = [\n  \"flake8\",\n  \"black\",\n  \"isort\",\n]\n[envs.style.scripts]\ncheck = [\n  \"flake8 .\",\n  \"black --check --diff .\",\n  \"isort --check-only --diff .\",\n]\nfmt = [\n  \"isort .\",\n  \"black .\",\n  \"check\",\n]\n</code></pre> <p>Similar to make, you can ignore the exit code of commands that start with <code>-</code> (a hyphen). For example, the script <code>error</code> defined by the following configuration would halt after the second command with <code>3</code> as the exit code:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test.scripts]\nerror = [\n  \"- exit 1\",\n  \"exit 3\",\n  \"exit 0\",\n]\n</code></pre> <pre><code>[envs.test.scripts]\nerror = [\n  \"- exit 1\",\n  \"exit 3\",\n  \"exit 0\",\n]\n</code></pre> <p>Tip</p> <p>Individual scripts inherit from parent environments just like options.</p>"},{"location":"config/environment/overview/#commands","title":"Commands","text":"<p>All commands are able to use any defined scripts. Also like scripts, context formatting is supported and the exit code of commands that start with a hyphen will be ignored.</p>"},{"location":"config/environment/overview/#pre-install","title":"Pre-install","text":"<p>You can run commands immediately before environments install your project.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\npre-install-commands = [\n  \"...\",\n]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\npre-install-commands = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/environment/overview/#post-install","title":"Post-install","text":"<p>You can run commands immediately after environments install your project.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\npost-install-commands = [\n  \"...\",\n]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\npost-install-commands = [\n  \"...\",\n]\n</code></pre>"},{"location":"config/environment/overview/#python-version","title":"Python version","text":"<p>The <code>python</code> option specifies which version of Python to use, or an absolute path to a Python interpreter:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\npython = \"3.10\"\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\npython = \"3.10\"\n</code></pre> <p>All environment types should respect this option.</p>"},{"location":"config/environment/overview/#supported-platforms","title":"Supported platforms","text":"<p>The <code>platforms</code> option indicates the operating systems with which the environment is compatible:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nplatforms = [\"linux\", \"windows\", \"macos\"]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nplatforms = [\"linux\", \"windows\", \"macos\"]\n</code></pre> <p>The following platforms are supported:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul> <p>If unspecified, the environment is assumed to be compatible with all platforms.</p>"},{"location":"config/environment/overview/#description","title":"Description","text":"<p>The <code>description</code> option is purely informational and is displayed in the output of the <code>env show</code> command:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ndescription = \"\"\"\nLorem ipsum ...\n\"\"\"\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ndescription = \"\"\"\nLorem ipsum ...\n\"\"\"\n</code></pre>"},{"location":"config/environment/overview/#type","title":"Type","text":"<p>An environment's <code>type</code> determines which environment plugin will be used for management. The only built-in environment type is <code>virtual</code>, which uses virtual Python environments.</p>"},{"location":"config/internal/static-analysis/","title":"Static analysis configuration","text":"<p>Static analysis performed by the <code>fmt</code> command is (by default) backed entirely by Ruff.</p> <p>Hatch provides default settings that user configuration can extend.</p>"},{"location":"config/internal/static-analysis/#extending-config","title":"Extending config","text":"<p>When defining your configuration, be sure to use options that are prefixed by <code>extend-</code> such as <code>extend-select</code>, for example:</p>  pyproject.toml ruff.toml <pre><code>[tool.ruff.format]\npreview = true\nquote-style = \"single\"\n\n[tool.ruff.lint]\npreview = true\nextend-select = [\"C901\"]\n\n[tool.ruff.lint.extend-per-file-ignores]\n\"docs/.hooks/*\" = [\"INP001\", \"T201\"]\n\n[tool.ruff.lint.isort]\nknown-first-party = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[format]\npreview = true\nquote-style = \"single\"\n\n[lint]\npreview = true\nextend-select = [\"C901\"]\n\n[lint.extend-per-file-ignores]\n\"docs/.hooks/*\" = [\"INP001\", \"T201\"]\n\n[lint.isort]\nknown-first-party = [\"foo\", \"bar\"]\n</code></pre> <p>Note</p> <p>When not persisting config, there is no need to explicitly extend the defaults as Hatch automatically handles that.</p>"},{"location":"config/internal/static-analysis/#persistent-config","title":"Persistent config","text":"<p>If you want to store the default configuration in the project, set an explicit path like so:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\nconfig-path = \"ruff_defaults.toml\"\n</code></pre> <pre><code>[envs.hatch-static-analysis]\nconfig-path = \"ruff_defaults.toml\"\n</code></pre> <p>Then instruct Ruff to consider your configuration as an extension of the default file:</p>  pyproject.toml ruff.toml <pre><code>[tool.ruff]\nextend = \"ruff_defaults.toml\"\n</code></pre> <pre><code>extend = \"ruff_defaults.toml\"\n</code></pre> <p>Anytime you wish to update the defaults (such as when upgrading Hatch), you must run the <code>fmt</code> command once with the <code>--sync</code> flag e.g.:</p> <pre><code>hatch fmt --check --sync\n</code></pre> <p>Tip</p> <p>This is the recommended approach since it allows other tools like IDEs to use the default configuration.</p>"},{"location":"config/internal/static-analysis/#no-config","title":"No config","text":"<p>If you don't want Hatch to use any of its default configuration and rely entirely on yours, set the path to anything and then simply don't <code>extend</code> in your Ruff config:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\nconfig-path = \"none\"\n</code></pre> <pre><code>[envs.hatch-static-analysis]\nconfig-path = \"none\"\n</code></pre>"},{"location":"config/internal/static-analysis/#customize-behavior","title":"Customize behavior","text":"<p>You can fully alter the behavior of the environment used by the <code>fmt</code> command. See the how-to for a detailed example.</p>"},{"location":"config/internal/static-analysis/#dependencies","title":"Dependencies","text":"<p>Pin the particular version of Ruff by explicitly defining the environment dependencies:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre> <pre><code>[envs.hatch-static-analysis]\ndependencies = [\"ruff==X.Y.Z\"]\n</code></pre>"},{"location":"config/internal/static-analysis/#scripts","title":"Scripts","text":"<p>If you want to change the default commands that are executed, you can override the scripts. The following four scripts must be defined:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis.scripts]\nformat-check = \"...\"\nformat-fix = \"...\"\nlint-check = \"...\"\nlint-fix = \"...\"\n</code></pre> <pre><code>[envs.hatch-static-analysis.scripts]\nformat-check = \"...\"\nformat-fix = \"...\"\nlint-check = \"...\"\nlint-fix = \"...\"\n</code></pre> <p>The <code>format-*</code> scripts correspond to the <code>--formatter</code>/<code>-f</code> flag while the <code>lint-*</code> scripts correspond to the <code>--linter</code>/<code>-l</code> flag. The <code>*-fix</code> scripts run by default while the <code>*-check</code> scripts correspond to the <code>--check</code> flag.</p> <p>Reminder</p> <p>If you choose to use different tools for static analysis, be sure to update the required dependencies.</p>"},{"location":"config/internal/static-analysis/#default-settings","title":"Default settings","text":""},{"location":"config/internal/static-analysis/#non-rule-settings","title":"Non-rule settings","text":"<ul> <li>Line length set to 120</li> <li>Docstring formatting enabled with line length set to 80</li> <li>Only absolute imports are allowed, except for tests</li> <li>The normalized project name is a known first party import</li> </ul>"},{"location":"config/internal/static-analysis/#per-file-ignored-rules","title":"Per-file ignored rules","text":"<ul> <li><code>**/scripts/*</code>: INP001, T201</li> <li><code>**/tests/**/*</code>: PLC1901, PLR2004, PLR6301, S, TID252</li> </ul>"},{"location":"config/internal/static-analysis/#selected-rules","title":"Selected rules","text":"<p>The following rules are based on version 0.3.1 of Ruff. Rules with a <sup>P</sup> are only selected when preview mode is enabled.</p> <ul> <li>A001, A002, A003</li> <li>ARG001, ARG002, ARG003, ARG004, ARG005</li> <li>ASYNC100, ASYNC101, ASYNC102</li> <li>B002, B003, B004, B005, B006, B007, B008, B009, B010, B011, B012, B013, B014, B015, B016, B017, B018, B019, B020, B021, B022, B023, B024, B025, B026, B028, B029, B030, B031, B032, B033, B034, B035, B904, B905</li> <li>BLE001</li> <li>C400, C401, C402, C403, C404, C405, C406, C408, C409, C410, C411, C413, C414, C415, C416, C417, C418, C419</li> <li>COM818</li> <li>DTZ001, DTZ002, DTZ003, DTZ004, DTZ005, DTZ006, DTZ007, DTZ011, DTZ012</li> <li>E101, E112<sup>P</sup>, E113<sup>P</sup>, E115<sup>P</sup>, E116<sup>P</sup>, E201<sup>P</sup>, E202<sup>P</sup>, E203<sup>P</sup>, E211<sup>P</sup>, E221<sup>P</sup>, E222<sup>P</sup>, E223<sup>P</sup>, E224<sup>P</sup>, E225<sup>P</sup>, E226<sup>P</sup>, E227<sup>P</sup>, E228<sup>P</sup>, E231<sup>P</sup>, E241<sup>P</sup>, E242<sup>P</sup>, E251<sup>P</sup>, E252<sup>P</sup>, E261<sup>P</sup>, E262<sup>P</sup>, E265<sup>P</sup>, E266<sup>P</sup>, E271<sup>P</sup>, E272<sup>P</sup>, E273<sup>P</sup>, E274<sup>P</sup>, E275<sup>P</sup>, E401, E402, E501, E701, E702, E703, E711, E712, E713, E714, E721, E722, E731, E741, E742, E743, E902, E999</li> <li>EM101, EM102, EM103</li> <li>EXE001, EXE002, EXE003, EXE004, EXE005</li> <li>F401, F402, F403, F404, F405, F406, F407, F501, F502, F503, F504, F505, F506, F507, F508, F509, F521, F522, F523, F524, F525, F541, F601, F602, F621, F622, F631, F632, F633, F634, F701, F702, F704, F706, F707, F722, F811, F821, F822, F823, F841, F842, F901</li> <li>FA100, FA102</li> <li>FBT001, FBT002</li> <li>FLY002</li> <li>FURB105<sup>P</sup>, FURB113<sup>P</sup>, FURB118<sup>P</sup>, FURB129<sup>P</sup>, FURB131<sup>P</sup>, FURB132<sup>P</sup>, FURB136<sup>P</sup>, FURB145<sup>P</sup>, FURB148<sup>P</sup>, FURB152<sup>P</sup>, FURB161<sup>P</sup>, FURB163<sup>P</sup>, FURB167<sup>P</sup>, FURB168<sup>P</sup>, FURB169<sup>P</sup>, FURB171<sup>P</sup>, FURB177<sup>P</sup>, FURB180<sup>P</sup>, FURB181<sup>P</sup></li> <li>G001, G002, G003, G004, G010, G101, G201, G202</li> <li>I001, I002</li> <li>ICN001, ICN002, ICN003</li> <li>INP001</li> <li>INT001, INT002, INT003</li> <li>ISC003</li> <li>LOG001, LOG002, LOG007, LOG009</li> <li>N801, N802, N803, N804, N805, N806, N807, N811, N812, N813, N814, N815, N816, N817, N818, N999</li> <li>PERF101, PERF102, PERF401, PERF402, PERF403<sup>P</sup></li> <li>PGH005</li> <li>PIE790, PIE794, PIE796, PIE800, PIE804, PIE807, PIE808, PIE810</li> <li>PLC0105, PLC0131, PLC0132, PLC0205, PLC0208, PLC0414, PLC0415<sup>P</sup>, PLC1901<sup>P</sup>, PLC2401<sup>P</sup>, PLC2403<sup>P</sup>, PLC2701<sup>P</sup>, PLC2801<sup>P</sup>, PLC3002</li> <li>PLE0100, PLE0101, PLE0116, PLE0117, PLE0118, PLE0237, PLE0241, PLE0302, PLE0307, PLE0604, PLE0605, PLE0643<sup>P</sup>, PLE0704<sup>P</sup>, PLE1132<sup>P</sup>, PLE1141<sup>P</sup>, PLE1142, PLE1205, PLE1206, PLE1300, PLE1307, PLE1310, PLE1507, PLE1519<sup>P</sup>, PLE1700, PLE2502, PLE2510, PLE2512, PLE2513, PLE2514, PLE2515</li> <li>PLR0124, PLR0133, PLR0202<sup>P</sup>, PLR0203<sup>P</sup>, PLR0206, PLR0402, PLR1701, PLR1704<sup>P</sup>, PLR1711, PLR1714, PLR1722, PLR1733<sup>P</sup>, PLR1736<sup>P</sup>, PLR2004, PLR2044<sup>P</sup>, PLR5501, PLR6201<sup>P</sup>, PLR6301<sup>P</sup></li> <li>PLW0108<sup>P</sup>, PLW0120, PLW0127, PLW0129, PLW0131, PLW0133<sup>P</sup>, PLW0245<sup>P</sup>, PLW0406, PLW0602, PLW0603, PLW0604<sup>P</sup>, PLW0711, PLW1501<sup>P</sup>, PLW1508, PLW1509, PLW1510, PLW1514<sup>P</sup>, PLW1641<sup>P</sup>, PLW2101<sup>P</sup>, PLW2901, PLW3201<sup>P</sup>, PLW3301</li> <li>PT001, PT002, PT003, PT006, PT007, PT008, PT009, PT010, PT011, PT012, PT013, PT014, PT015, PT016, PT017, PT018, PT019, PT020, PT021, PT022, PT023, PT024, PT025, PT026, PT027</li> <li>PYI001, PYI002, PYI003, PYI004, PYI005, PYI006, PYI007, PYI008, PYI009, PYI010, PYI011, PYI012, PYI013, PYI014, PYI015, PYI016, PYI017, PYI018, PYI019, PYI020, PYI021, PYI024, PYI025, PYI026, PYI029, PYI030, PYI032, PYI033, PYI034, PYI035, PYI036, PYI041, PYI042, PYI043, PYI044, PYI045, PYI046, PYI047, PYI048, PYI049, PYI050, PYI051, PYI052, PYI053, PYI054, PYI055, PYI056, PYI058</li> <li>RET503, RET504, RET505, RET506, RET507, RET508</li> <li>RSE102</li> <li>RUF001, RUF002, RUF003, RUF005, RUF006, RUF007, RUF008, RUF009, RUF010, RUF012, RUF013, RUF015, RUF016, RUF017, RUF018, RUF019, RUF020, RUF021<sup>P</sup>, RUF022<sup>P</sup>, RUF023<sup>P</sup>, RUF024<sup>P</sup>, RUF025<sup>P</sup>, RUF026<sup>P</sup>, RUF027<sup>P</sup>, RUF028<sup>P</sup>, RUF100, RUF200</li> <li>S101, S102, S103, S104, S105, S106, S107, S108, S110, S112, S113, S201, S202, S301, S302, S303, S304, S305, S306, S307, S308, S310, S311, S312, S313, S314, S315, S316, S317, S318, S319, S320, S321, S323, S324, S401<sup>P</sup>, S402<sup>P</sup>, S403<sup>P</sup>, S405<sup>P</sup>, S406<sup>P</sup>, S407<sup>P</sup>, S408<sup>P</sup>, S409<sup>P</sup>, S411<sup>P</sup>, S412<sup>P</sup>, S413<sup>P</sup>, S415<sup>P</sup>, S501, S502, S503, S504, S505, S506, S507, S508, S509, S601, S602, S604, S605, S606, S607, S608, S609, S611, S612, S701, S702</li> <li>SIM101, SIM102, SIM103, SIM105, SIM107, SIM108, SIM109, SIM110, SIM112, SIM113, SIM114, SIM115, SIM116, SIM117, SIM118, SIM201, SIM202, SIM208, SIM210, SIM211, SIM212, SIM220, SIM221, SIM222, SIM223, SIM300, SIM910, SIM911</li> <li>SLF001</li> <li>SLOT000, SLOT001, SLOT002</li> <li>T100, T201, T203</li> <li>TCH001, TCH002, TCH003, TCH004, TCH005, TCH010</li> <li>TD004, TD005, TD006, TD007</li> <li>TID251, TID252, TID253</li> <li>TRIO100, TRIO105, TRIO109, TRIO110, TRIO115</li> <li>TRY002, TRY003, TRY004, TRY201, TRY300, TRY301, TRY302, TRY400, TRY401</li> <li>UP001, UP003, UP004, UP005, UP006, UP007, UP008, UP009, UP010, UP011, UP012, UP013, UP014, UP015, UP017, UP018, UP019, UP020, UP021, UP022, UP023, UP024, UP025, UP026, UP027, UP028, UP029, UP030, UP031, UP032, UP033, UP034, UP035, UP036, UP037, UP038, UP039, UP040, UP041</li> <li>W291, W292, W293, W505, W605</li> <li>YTT101, YTT102, YTT103, YTT201, YTT202, YTT203, YTT204, YTT301, YTT302, YTT303</li> </ul>"},{"location":"config/internal/testing/","title":"Testing configuration","text":"<p>Check out the testing overview tutorial for a more comprehensive walk-through.</p>"},{"location":"config/internal/testing/#settings","title":"Settings","text":"<p>If an option has a corresponding <code>test</code> command flag, the flag will always take precedence.</p>"},{"location":"config/internal/testing/#default-arguments","title":"Default arguments","text":"<p>You can define default arguments for the <code>test</code> command by setting the <code>default-args</code> option, which must be an array of strings. The following is the default configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\ndefault-args = [\"tests\"]\n</code></pre> <pre><code>[envs.hatch-test]\ndefault-args = [\"tests\"]\n</code></pre>"},{"location":"config/internal/testing/#extra-arguments","title":"Extra arguments","text":"<p>You can define extra internal arguments for test scripts by setting the <code>extra-args</code> option, which must be an array of strings. For example, if you wanted to increase the verbosity of <code>pytest</code>, you could set the following:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nextra-args = [\"-vv\"]\n</code></pre> <pre><code>[envs.hatch-test]\nextra-args = [\"-vv\"]\n</code></pre>"},{"location":"config/internal/testing/#randomize-test-order","title":"Randomize test order","text":"<p>You can randomize the order of tests by enabling the <code>randomize</code> option which corresponds to the <code>--randomize</code>/<code>-r</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nrandomize = true\n</code></pre> <pre><code>[envs.hatch-test]\nrandomize = true\n</code></pre>"},{"location":"config/internal/testing/#parallelize-test-execution","title":"Parallelize test execution","text":"<p>You can parallelize test execution by enabling the <code>parallel</code> option which corresponds to the <code>--parallel</code>/<code>-p</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nparallel = true\n</code></pre> <pre><code>[envs.hatch-test]\nparallel = true\n</code></pre>"},{"location":"config/internal/testing/#retry-failed-tests","title":"Retry failed tests","text":"<p>You can retry failed tests by setting the <code>retries</code> option which corresponds to the <code>--retries</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nretries = 2\n</code></pre> <pre><code>[envs.hatch-test]\nretries = 2\n</code></pre> <p>You can also set the number of seconds to wait between retries by setting the <code>retry-delay</code> option which corresponds to the <code>--retry-delay</code> flag:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nretry-delay = 1\n</code></pre> <pre><code>[envs.hatch-test]\nretry-delay = 1\n</code></pre>"},{"location":"config/internal/testing/#customize-environment","title":"Customize environment","text":"<p>You can fully alter the behavior of the environment used by the <code>test</code> command.</p>"},{"location":"config/internal/testing/#dependencies","title":"Dependencies","text":"<p>You can define extra dependencies that your tests may require:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\nextra-dependencies = [\n  \"pyfakefs\",\n  \"pytest-asyncio\",\n  \"pytest-benchmark\",\n  \"pytest-memray\",\n  \"pytest-playwright\",\n  \"pytest-print\",\n]\n</code></pre> <pre><code>[envs.hatch-test]\nextra-dependencies = [\n  \"pyfakefs\",\n  \"pytest-asyncio\",\n  \"pytest-benchmark\",\n  \"pytest-memray\",\n  \"pytest-playwright\",\n  \"pytest-print\",\n]\n</code></pre> <p>The following is the default configuration:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test]\ndependencies = [\n  \"coverage-enable-subprocess==1.0\",\n  \"coverage[toml]~=7.4\",\n  \"pytest~=8.1\",\n  \"pytest-mock~=3.12\",\n  \"pytest-randomly~=3.15\",\n  \"pytest-rerunfailures~=14.0\",\n  \"pytest-xdist[psutil]~=3.5\",\n]\n</code></pre> <pre><code>[envs.hatch-test]\ndependencies = [\n  \"coverage-enable-subprocess==1.0\",\n  \"coverage[toml]~=7.4\",\n  \"pytest~=8.1\",\n  \"pytest-mock~=3.12\",\n  \"pytest-randomly~=3.15\",\n  \"pytest-rerunfailures~=14.0\",\n  \"pytest-xdist[psutil]~=3.5\",\n]\n</code></pre>"},{"location":"config/internal/testing/#matrix","title":"Matrix","text":"<p>You can override the default series of matrices:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\", \"3.10\", \"3.9\", \"3.8\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\", \"3.10\", \"3.9\", \"3.8\"]\n</code></pre>"},{"location":"config/internal/testing/#scripts","title":"Scripts","text":"<p>If you want to change the default commands that are executed, you can override the scripts. The following default scripts must be redefined:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-test.scripts]\nrun = \"pytest{env:HATCH_TEST_ARGS:} {args}\"\nrun-cov = \"coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}\"\ncov-combine = \"coverage combine\"\ncov-report = \"coverage report\"\n</code></pre> <pre><code>[envs.hatch-test.scripts]\nrun = \"pytest{env:HATCH_TEST_ARGS:} {args}\"\nrun-cov = \"coverage run -m pytest{env:HATCH_TEST_ARGS:} {args}\"\ncov-combine = \"coverage combine\"\ncov-report = \"coverage report\"\n</code></pre> <p>The <code>run</code> script is the default behavior while the <code>run-cov</code> script is used instead when measuring code coverage. The <code>cov-combine</code> script runs after all tests complete when measuring code coverage, as well as the <code>cov-report</code> script when not using the <code>--cover-quiet</code> flag.</p> <p>Note</p> <p>The <code>HATCH_TEST_ARGS</code> environment variable is how the <code>test</code> command's flags are translated and internally populated without affecting the user's arguments. This is also the way that extra arguments are passed.</p>"},{"location":"history/hatch/","title":"Hatch history","text":"<p>All notable changes to Hatch will be documented in this file.</p> <p>The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.</p>"},{"location":"history/hatch/#unreleased","title":"Unreleased","text":"<p>Added:</p> <ul> <li>Add <code>test</code> command</li> <li>Add <code>self report</code> command for submitting pre-populated bug reports to GitHub</li> <li>The reserved environment used for static analysis is now completely configurable</li> <li>Add the following methods to the <code>environment</code> interface for complete control over output during life cycle management: <code>app_status_creation</code>, <code>app_status_pre_installation</code>, <code>app_status_post_installation</code>, <code>app_status_project_installation</code>, <code>app_status_dependency_state_check</code>, <code>app_status_dependency_installation_check</code>, <code>app_status_dependency_synchronization</code></li> <li>Add binaries for 32-bit versions of Windows</li> <li>Read configuration from any <code>~/.pypirc</code> file for the <code>index</code> publisher</li> <li>Use the Git user as the default username for new project URL metadata</li> <li>Add <code>HATCH_DEBUG</code> environment variable that when enabled will show local variables in the case of unhandled tracebacks</li> <li>Upgrade default CPython distributions to 20240224</li> <li>Upgrade Ruff to 0.3.1</li> <li>Upgrade PyApp to 0.15.1 for binary builds</li> <li>Bump the minimum supported version of Hatchling to 1.22.2</li> </ul> <p>Fixed:</p> <ul> <li>When projects derive dependencies from metadata hooks, there is now by default a status indicator for when the hooks are executed for better responsiveness</li> <li>Properly support projects with a <code>pyproject.toml</code> file but no <code>project</code> table e.g. applications</li> <li>Fix dependency inheritance for the template of the <code>types</code> environment for new projects</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.4","title":"1.9.4 - 2024-03-12","text":"<p>Fixed:</p> <ul> <li>Limit the maximum version of Hatchling in anticipation of backward incompatible changes</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.3","title":"1.9.3 - 2024-01-25","text":"<p>Fixed:</p> <ul> <li>Fix loading of local plugins to account for newly released versions of a dependency</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.2","title":"1.9.2 - 2024-01-21","text":"<p>Fixed:</p> <ul> <li>Fix the default token variable name for publishing to PyPI</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.1","title":"1.9.1 - 2023-12-25","text":"<p>Fixed:</p> <ul> <li>Ensure that the <code>dependency_hash</code> method of the <code>environment</code> interface is called after <code>sync_dependencies</code> for cases where the hash is only known at that point, such as for dependency lockers</li> <li>Only acknowledge the <code>HATCH_PYTHON_VARIANT_*</code> environment variables for Python resolution for supported platforms and architectures</li> <li>Fix Python resolution when there are metadata hooks with unsatisfied dependencies</li> </ul>"},{"location":"history/hatch/#hatch-v1.9.0","title":"1.9.0 - 2023-12-19","text":"<p>Changed:</p> <ul> <li>Environments prefixed by <code>hatch-</code> are now considered internal and used for special purposes such as configuration for static analysis</li> </ul> <p>Added:</p> <ul> <li>Enable docstring formatting by default for static analysis</li> <li>Allow for overriding config of internal environments</li> <li>Concretely state the expected API contract for the environment interface methods <code>find</code> and <code>check_compatibility</code></li> <li>Upgrade Ruff to 0.1.8</li> <li>Bump the minimum supported version of Hatchling to 1.21.0</li> </ul> <p>Fixed:</p> <ul> <li>Ignore a project's Python requirement for environments where the project is not installed</li> <li>When not persisting config for static analysis, properly manage internal settings when Ruff's top level table already exists</li> <li>Ignore compatibility checks when environments have already been created, significantly improving performance of environment usage</li> <li>Properly allow overriding of the <code>path</code> option for the <code>virtual</code> environment type</li> <li>Fix nushell activation on non-Windows systems</li> </ul>"},{"location":"history/hatch/#hatch-v1.8.1","title":"1.8.1 - 2023-12-14","text":"<p>Fixed:</p> <ul> <li>Fix regression in calling subprocesses with updated PATH</li> <li>Fix automatic installation of environment plugins when running as a standalone binary</li> <li>Change default location of Python installations</li> </ul>"},{"location":"history/hatch/#hatch-v1.8.0","title":"1.8.0 - 2023-12-11","text":"<p>Changed:</p> <ul> <li>Drop support for Python 3.7</li> <li>The <code>get_build_process</code> method of the <code>environment</code> interface has been removed; plugins should use the new <code>run_builder</code> method instead</li> <li>Remove <code>pyperclip</code> dependency and the <code>--copy</code> flag of the <code>config find</code> command</li> <li>When running the <code>build</code> command all output from builders is now displayed as-is in real time without the stripping of ANSI codes</li> <li>Version information (for Hatch itself) is now derived from Git</li> </ul> <p>Added:</p> <ul> <li>Support Python 3.12</li> <li>Add installers and standalone binaries</li> <li>Add the ability to manage Python installations</li> <li>Add <code>fmt</code> command</li> <li>The <code>virtual</code> environment type can now automatically download requested versions of Python that are not installed</li> <li>Add <code>dependency_hash</code> method to the <code>environment</code> interface</li> <li>The state of installed dependencies for environments is saved as metadata so if dependency definitions have not changed then no checking is performed, which can be computationally expensive</li> <li>The <code>build</code> command now supports backends other than Hatchling</li> <li>Allow the use of <code>features</code> for environments when <code>skip-install</code> is enabled</li> <li>The default is now <code>__token__</code> when prompting for a username for the <code>publish</code> command</li> <li>Add a new <code>run_builder</code> method to the <code>environment</code> interface</li> <li>Bump the minimum supported version of Hatchling to 1.19.0</li> <li>Bump the minimum supported version of <code>click</code> to 8.0.6</li> </ul> <p>Fixed:</p> <ul> <li>Fix nushell activation</li> <li>Better handling of flat storage directory hierarchies for the <code>virtual</code> environment type</li> <li>Display useful information when running the <code>version</code> command outside of a project rather than erroring</li> <li>Fix the <code>project metadata</code> command by only capturing stdout from the backend</li> <li>Properly support Google Artifact Registry</li> <li>Fix parsing dependencies for environments when warnings are emitted</li> </ul>"},{"location":"history/hatch/#hatch-v1.7.0","title":"1.7.0 - 2023-04-03","text":"<p>Changed:</p> <ul> <li>The <code>src-layout</code> project template option is now enabled by default</li> <li>Non-critical output now goes to stderr</li> </ul> <p>Added:</p> <ul> <li>Add <code>tool.hatch.env.requires</code> configuration to automatically install dependencies for environment and environment collector plugins</li> <li>Add <code>custom</code> environment collector</li> <li>Improve syncing of dependencies provided through Git direct references</li> <li>Add <code>isolated_data_directory</code> attribute to the environment interface</li> <li>Increase the timeout for and add retries to the <code>index</code> publisher</li> <li>Expand home and environment variables in configured cache and data directories</li> <li>Improve readability of exceptions</li> <li>Update project templates</li> <li>Bump the minimum supported version of Hatchling to 1.14.0</li> </ul> <p>Fixed:</p> <ul> <li>Fix displaying the version with the <code>version</code> command when the version is static and build dependencies are unmet</li> <li>Fix build environments for the <code>virtual</code> environment type when storing within a relative path</li> <li>Work around System Integrity Protection on macOS when running commands</li> <li>Allow setuptools metadata migration for projects without <code>setup.py</code> if <code>setup.cfg</code> is present</li> <li>Handle additional edge cases for setuptools metadata migration</li> <li>Support boolean values for the <code>config set</code> command</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.3","title":"1.6.3 - 2022-10-24","text":"<p>Fixed:</p> <ul> <li>Fix <code>version</code> command when the version is dynamic and build dependencies are unmet</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.2","title":"1.6.2 - 2022-10-20","text":"<p>Fixed:</p> <ul> <li>Fix getting dynamic metadata from hooks for environments when dependencies are not dynamic</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.1","title":"1.6.1 - 2022-10-16","text":"<p>Fixed:</p> <ul> <li>Computing the path to the user's home directory now gracefully falls back to <code>~</code> when it cannot be determined</li> </ul>"},{"location":"history/hatch/#hatch-v1.6.0","title":"1.6.0 - 2022-10-08","text":"<p>Changed:</p> <ul> <li>The <code>run_shell_command</code> environment interface method now accepts arbitrary <code>subprocess.Popen</code> keyword arguments. This is not strictly breaking, but will be utilized in upcoming features.</li> <li>The internal directory structure for storing <code>virtual</code> environments is now more nested. This is not breaking, but any local environments will be created anew.</li> </ul> <p>Added:</p> <ul> <li>Add <code>project</code> command group to view details about the project like PEP 621 metadata</li> <li>Better support for auto-detection of environments by tools like Visual Studio Code now that the storage directory of <code>virtual</code> environments will be flat if Hatch's configured <code>virtual</code> environment directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory</li> <li>Build environments for the <code>virtual</code> environment type are now cached for improved performance</li> <li>Add <code>build_environment_exists</code> method to the environment interface for implementations that cache the build environment</li> <li>Add <code>path</code> option to the <code>virtual</code> environment type</li> <li>Add <code>--initialize-auth</code> flag to the <code>index</code> publisher to allow for the saving of authentication information before publishing</li> <li>Support Bash on Windows for the <code>shell</code> command</li> <li>The <code>setuptools</code> migration script no longer modifies the formatting of existing <code>pyproject.toml</code> configuration</li> <li>Bump the minimum supported version of Hatchling to 1.11.0</li> </ul> <p>Fixed:</p> <ul> <li>Environments now respect dynamically defined project dependencies</li> <li>The <code>dep hash</code> and all <code>dep show</code> commands now respect dynamically defined project dependencies</li> <li>The <code>env show</code>, <code>dep hash</code>, and all <code>dep show</code> commands now honor context formatting</li> <li>Fix matrix variable inclusion filtering of the <code>run</code> and <code>env run</code> commands when there are multiple possible variables</li> <li>Build environment compatibility is now checked before use</li> <li>Decreasing verbosity now has no affect on output that should always be displayed</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> <li>Environments now respect user defined environment variables for context formatting</li> <li>Update the scripts in the generated test environment template for new projects to reflect the documentation</li> <li>Allow <code>extra-dependencies</code> in environment overrides</li> <li>Depend on <code>packaging</code> explicitly rather than relying on it being a transitive dependency of Hatchling</li> </ul>"},{"location":"history/hatch/#hatch-v1.5.0","title":"1.5.0 - 2022-08-28","text":"<p>Added:</p> <ul> <li>The <code>index</code> publisher now recognizes repository-specific options</li> <li>Add the <code>--ignore-compat</code> flag to the <code>env run</code> command</li> <li>Setting the <code>HATCH_PYTHON</code> environment variable to <code>self</code> will now force the use of the Python executable Hatch is running on for <code>virtual</code> environment creation</li> </ul> <p>Fixed:</p> <ul> <li>Fix the <code>--force-continue</code> flag of the <code>env run</code> command</li> <li>Handle more edge cases in the <code>setuptools</code> migration script</li> </ul>"},{"location":"history/hatch/#hatch-v1.4.2","title":"1.4.2 - 2022-08-16","text":"<p>Fixed:</p> <ul> <li>Fix check for updating static versions with the <code>version</code> command when metadata hooks are in use</li> </ul>"},{"location":"history/hatch/#hatch-v1.4.1","title":"1.4.1 - 2022-08-13","text":"<p>Fixed:</p> <ul> <li>Fix non-detached inheritance disabling for environments</li> </ul>"},{"location":"history/hatch/#hatch-v1.4.0","title":"1.4.0 - 2022-08-06","text":"<p>Added:</p> <ul> <li>The default Python for <code>virtual</code> environments now checks PATH before using the one Hatch is running on</li> <li>Values for environment <code>env-vars</code> now support context formatting</li> <li>Add <code>name</code> override for environments to allow for regular expression matching</li> <li>The <code>index</code> publisher now better supports non-PyPI indices</li> <li>Add certificate options to the <code>index</code> publisher</li> <li>Display waiting text when checking dependencies and removing environments</li> <li>Display help text the first time the <code>shell</code> command is executed</li> <li>Update project templates with Python 3.11 and the latest versions of various GitHub Actions</li> <li>Add support for Almquist (<code>ash</code>) shells</li> <li>Add <code>hyperlink</code> as a dependency for better handling of package index URLs</li> <li>Bump the minimum supported version of <code>virtualenv</code> to 20.16.2</li> <li>Bump the minimum supported version of <code>tomlkit</code> to 0.11.1</li> </ul> <p>Fixed:</p> <ul> <li>Acknowledge <code>extra-dependencies</code> for the <code>env show</code> command</li> <li>Fix locating executables within virtual environments on Debian</li> <li>Fix managing the terminal size inside the <code>shell</code> command</li> <li>Fix default code coverage file omission for the <code>src-layout</code> project template option</li> </ul>"},{"location":"history/hatch/#hatch-v1.3.1","title":"1.3.1 - 2022-07-11","text":"<p>Fixed:</p> <ul> <li>Support <code>-h</code>/<code>--help</code> flag for the <code>run</code> command</li> </ul>"},{"location":"history/hatch/#hatch-v1.3.0","title":"1.3.0 - 2022-07-10","text":"<p>Changed:</p> <ul> <li>Rename the default publishing plugin from <code>pypi</code> to the more generic <code>index</code></li> </ul> <p>Added:</p> <ul> <li>Support the absence of <code>pyproject.toml</code> files, as is the case for apps and non-Python projects</li> <li>Hide scripts that start with an underscore for the <code>env show</code> command by default</li> <li>Ignoring the exit codes of commands by prefixing with hyphens now works with entire named scripts</li> <li>Add a way to require confirmation for publishing</li> <li>Add <code>--force-continue</code> flag to the <code>env run</code> command</li> <li>Make tracebacks colorful and less verbose</li> <li>When shell configuration has not been defined, attempt to use the current shell based on parent processes before resorting to the defaults</li> <li>The shell name <code>pwsh</code> is now an alias for <code>powershell</code></li> <li>Remove <code>atomicwrites</code> dependency</li> <li>Relax constraint on <code>userpath</code> dependency</li> <li>Bump the minimum supported version of Hatchling to 1.4.1</li> </ul> <p>Fixed:</p> <ul> <li>Keep environments in sync with the dependencies of the selected features</li> <li>Use <code>utf-8</code> for all files generated for new projects</li> <li>Escape special characters Git may return in the user name when writing generated files for new projects</li> <li>Normalize the package name to lowercase in <code>setuptools</code> migration script</li> <li>Fix parsing of source distributions during publishing</li> </ul>"},{"location":"history/hatch/#hatch-v1.2.1","title":"1.2.1 - 2022-05-30","text":"<p>Fixed:</p> <ul> <li>Fix handling of top level <code>data_files</code> in <code>setuptools</code> migration script</li> </ul>"},{"location":"history/hatch/#hatch-v1.2.0","title":"1.2.0 - 2022-05-22","text":"<p>Changed:</p> <ul> <li>The <code>enter_shell</code> environment plugin method now accepts an additional <code>args</code> parameter</li> </ul> <p>Added:</p> <ul> <li>Allow context string formatting for environment dependencies</li> <li>Add environment context string formatting fields <code>env_name</code>, <code>env_type</code>, <code>matrix</code>, <code>verbosity</code>, and <code>args</code></li> <li>Support overriding the default arguments used to spawn shells on non-Windows systems</li> <li>Bump the minimum supported version of Hatchling to 1.3.0</li> </ul> <p>Fixed:</p> <ul> <li>Improve <code>setuptools</code> migration script</li> </ul>"},{"location":"history/hatch/#hatch-v1.1.2","title":"1.1.2 - 2022-05-20","text":"<p>Fixed:</p> <ul> <li>Bump the minimum supported version of Hatchling to 1.2.0</li> <li>Update project metadata to reflect support for Python 3.11</li> </ul>"},{"location":"history/hatch/#hatch-v1.1.1","title":"1.1.1 - 2022-05-12","text":"<p>Fixed:</p> <ul> <li>Fix <code>setuptools</code> migration script for non-Windows systems</li> </ul>"},{"location":"history/hatch/#hatch-v1.1.0","title":"1.1.0 - 2022-05-12","text":"<p>Changed:</p> <ul> <li>In order to simplify the implementation of command execution for environment plugins, the <code>run_shell_commands</code> method has been replaced by the singular <code>run_shell_command</code>. A new <code>command_context</code> method has been added to more easily satisfy complex use cases.</li> <li>The <code>finalize_command</code> environment plugin method has been removed in favor of the newly introduced context formatting functionality.</li> </ul> <p>Added:</p> <ul> <li>Add context formatting functionality i.e. the ability to insert values into configuration like environment variables and command line arguments</li> <li>Any verbosity for command execution will now always display headers, even for single environments</li> <li>Every executed command is now displayed when running multiple commands or when verbosity is enabled</li> <li>Similar to <code>make</code>, ignore the exit code of executed commands that start with <code>-</code> (a hyphen)</li> <li>Add ability for the <code>--init</code> flag of the <code>new</code> command to automatically migrate <code>setuptools</code> configuration</li> <li>Update project metadata to reflect the adoption by PyPA and production stability</li> </ul>"},{"location":"history/hatch/#hatch-v1.0.0","title":"1.0.0 - 2022-04-28","text":"<p>This is the first stable release of Hatch v1, a complete rewrite. Enjoy!</p>"},{"location":"history/hatchling/","title":"Hatchling history","text":"<p>All notable changes to Hatchling will be documented in this file.</p> <p>The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.</p>"},{"location":"history/hatchling/#unreleased","title":"Unreleased","text":""},{"location":"history/hatchling/#hatchling-v1.22.5","title":"1.22.5 - 2024-04-04","text":"<p>Fixed:</p> <ul> <li>Fix reading metadata from source distributions when fields are dynamic but not part of core metadata like entry points</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.4","title":"1.22.4 - 2024-03-23","text":"<p>Fixed:</p> <ul> <li>Only read source distribution metadata for fields that are explicitly defined as dynamic</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.3","title":"1.22.3 - 2024-03-19","text":"<p>Fixed:</p> <ul> <li>Fix the <code>custom</code> build hook when using dynamic dependencies</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.2","title":"1.22.2 - 2024-03-16","text":"<p>Fixed:</p> <ul> <li>Fix regression when loading metadata from source distributions</li> <li>Fix metadata hooks when building wheels from source distributions</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.1","title":"1.22.1 - 2024-03-16","text":"<p>Fixed:</p> <ul> <li>Update the default version of core metadata to 2.3</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.22.0","title":"1.22.0 - 2024-03-16","text":"<p>Deprecated:</p> <ul> <li>The <code>app</code> build target has been renamed to <code>binary</code> to reduce ambiguity with the name of an upcoming feature. The former name will still be usable for several minor releases.</li> </ul> <p>Added:</p> <ul> <li>Metadata for the <code>wheel</code> target now defaults to the <code>PKG-INFO</code> metadata within source distributions</li> <li>Add <code>dependencies</code> method to the build hook interface so that hooks can themselves dynamically define dependencies</li> <li>Update the default version of core metadata to 2.2</li> <li>Update SPDX license information to version 3.23</li> <li>Improve error message for when the default heuristics for wheel file inclusion fail</li> </ul> <p>Fixed:</p> <ul> <li>Properly support core metadata version 2.2</li> <li>Remove <code>editables</code> as a direct dependency</li> <li>Fix default wheel tag when the supported Python version declaration is strict</li> <li>Load VCS ignore patterns first so that whitelisted patterns can be excluded by project configuration</li> <li>Don't consider VCS ignore files that are outside of the VCS boundary</li> <li>The <code>sdist</code> build target now gracefully ignores UNIX socket files</li> <li>Begin ignoring certain files ubiquitously, like <code>.DS_Store</code> on macOS</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.21.1","title":"1.21.1 - 2024-01-25","text":"<p>Fixed:</p> <ul> <li>Fix loading of local plugins to account for newly released versions of a dependency</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.21.0","title":"1.21.0 - 2023-12-18","text":"<p>Added:</p> <ul> <li>Add <code>parent</code> context modifier for path fields</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.20.0","title":"1.20.0 - 2023-12-13","text":"<p>Added:</p> <ul> <li>Add <code>bypass-selection</code> option to the <code>wheel</code> build target to allow for empty (metadata-only) wheels</li> </ul> <p>Fixed:</p> <ul> <li>Fix regression in 1.19.1 that allowed <code>exclude</code> to count toward inclusion selection, thus bypassing the default inclusion selection heuristics</li> <li>Fix writing optional dependency core metadata in situations where there are multiple environment markers</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.19.1","title":"1.19.1 - 2023-12-12","text":"<p>Fixed:</p> <ul> <li>Add better error message when the <code>wheel</code> build target cannot determine what to ship</li> <li>Consider forced inclusion patterns and build-time artifacts as file selection since some build hooks generate the entire wheel contents without user configuration</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.19.0","title":"1.19.0 - 2023-12-11","text":"<p>Changed:</p> <ul> <li>An error will now be raised if a force-included path does not exist</li> <li>An error will now be raised for the <code>wheel</code> build target if no file selection options are defined</li> </ul> <p>Added:</p> <ul> <li>Officially support Python 3.12</li> <li>Allow using an empty string for the <code>sources</code> option to add a prefix to distribution paths</li> </ul> <p>Fixed:</p> <ul> <li>Properly handle non-zero version epoch for the <code>standard</code> version scheme</li> <li>Fix the <code>wheel</code> build target for case insensitive file systems when the project metadata name does not match the directory name on disk</li> <li>The <code>app</code> build target no longer has suppressed output</li> <li>Prevent duplicate paths when projects require the <code>sources</code> option while build hooks overwrite included paths</li> <li>Properly escape spaces for URI context formatting</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.18.0","title":"1.18.0 - 2023-06-12","text":"<p>Changed:</p> <ul> <li>Drop support for Python 3.7</li> </ul> <p>Added:</p> <ul> <li>Update the list of directories that are always excluded for builds</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.17.1","title":"1.17.1 - 2023-06-03","text":"<p>Fixed:</p> <ul> <li>Fix dev mode when the project has symlinks and file inclusion is defined with the <code>packages</code> or <code>only-include</code> options</li> <li>Change the name of generated PTH files for dev mode so they come first lexicographically and therefore load first</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.17.0","title":"1.17.0 - 2023-05-12","text":"<p>Added:</p> <ul> <li>The <code>app</code> build target now embeds the project version in the name of binaries</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.16.1","title":"1.16.1 - 2023-05-11","text":"<p>Fixed:</p> <ul> <li>Fix determining the built executable path for the <code>app</code> build target option when using a local copy of PyApp when there is an explicit target triple set</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.16.0","title":"1.16.0 - 2023-05-11","text":"<p>Added:</p> <ul> <li>Add <code>app</code> build target option to build using a local copy of the PyApp repository</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.15.0","title":"1.15.0 - 2023-05-09","text":"<p>Added:</p> <ul> <li>Add <code>app</code> build target</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.14.1","title":"1.14.1 - 2023-04-23","text":"<p>Fixed:</p> <ul> <li>Fix internal archive root naming for the <code>sdist</code> target when <code>strict-naming</code> is disabled to match the file name in order to support the expectation of some frontends</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.14.0","title":"1.14.0 - 2023-04-02","text":"<p>Added:</p> <ul> <li>Add <code>trove-classifiers</code> as a dependency</li> </ul> <p>Fixed:</p> <ul> <li>Properly normalize metadata descriptions that contain line breaks</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.13.0","title":"1.13.0 - 2023-02-09","text":"<p>Added:</p> <ul> <li>Update the set of known trove classifiers to version 2023.2.8</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.12.2","title":"1.12.2 - 2023-01-05","text":"<p>Fixed:</p> <ul> <li>Add <code>macos-max-compat</code> option to the <code>wheel</code> target that is enabled by default to support the latest version 22.0 of the <code>packaging</code> library</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.12.1","title":"1.12.1 - 2022-12-31","text":"<p>Fixed:</p> <ul> <li>Fix minor regression in the PEP 517/660 function signatures that was discovered by Fedora</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.12.0","title":"1.12.0 - 2022-12-30","text":"<p>Added:</p> <ul> <li>Improve readability of exceptions</li> <li>Add <code>extra_metadata</code> build data to the <code>wheel</code> target</li> <li>Retroactively support <code>License-Expression</code> core metadata starting at version 2.1</li> <li>Add more type hints</li> <li>Update the set of known trove classifiers to version 2022.12.22</li> <li>Update SPDX license information to version 3.19</li> <li>Store Hatchling's metadata in <code>pyproject.toml</code></li> </ul> <p>Fixed:</p> <ul> <li>Acknowledge the <code>ARCHFLAGS</code> environment variable on macOS for the <code>wheel</code> target when build hooks set the <code>infer_tag</code> build data to <code>true</code></li> <li>Fix dependency checking when encountering broken distributions</li> <li>Fix the <code>support-legacy</code> option for the <code>sdist</code> target when using a src-layout project structure</li> <li>Remove unnecessary encoding declaration in the default template for the <code>version</code> build hook</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.11.1","title":"1.11.1 - 2022-10-19","text":"<p>Fixed:</p> <ul> <li>Fix default file selection behavior of the <code>wheel</code> target when there is a single top-level module</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.11.0","title":"1.11.0 - 2022-10-08","text":"<p>Added:</p> <ul> <li>Add <code>env</code> version source to retrieve the version from an environment variable</li> <li>Add <code>validate-bump</code> option to the <code>standard</code> version scheme</li> </ul> <p>Fixed:</p> <ul> <li>Use proper CSV formatting for the <code>RECORD</code> metadata file of the <code>wheel</code> target to avoid warnings during installation by <code>pip</code> if, for example, file names contain commas</li> <li>Fix installations with pip for build hooks that modify runtime dependencies</li> <li>Decreasing verbosity now has no affect on output that should always be displayed</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.10.0","title":"1.10.0 - 2022-09-18","text":"<p>Added:</p> <ul> <li>Add the following to the list of directories that cannot be traversed: <code>__pypackages__</code>, <code>.hg</code>, <code>.hatch</code>, <code>.tox</code>, <code>.nox</code></li> <li>Add deprecated option to allow ambiguous features</li> </ul> <p>Fixed:</p> <ul> <li>Improve tracking of dynamic metadata</li> <li>Fix core metadata for entries in <code>project.optional-dependencies</code> that use direct references</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.9.0","title":"1.9.0 - 2022-09-09","text":"<p>Changed:</p> <ul> <li>File pattern matching now more closely resembles Git's behavior</li> </ul> <p>Added:</p> <ul> <li>Implement a minimal version of <code>prepare_metadata_for_build_wheel</code> and <code>prepare_metadata_for_build_editable</code> for non-frontend tools that only need to inspect a project's metadata</li> <li>Add <code>metadata</code> command to view PEP 621 project metadata</li> <li>Improve error messages for SPDX license errors</li> <li>Retroactively support <code>License-File</code> for core metadata starting at version 2.1</li> <li>Bump the minimum supported version of <code>pathspec</code> to 0.10.1</li> </ul> <p>Fixed:</p> <ul> <li>Allow the valid non-SPDX <code>license</code> values <code>LicenseRef-Public-Domain</code> and <code>LicenseRef-Proprietary</code></li> <li>Show the help text of the CLI when no subcommand is selected</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.8.1","title":"1.8.1 - 2022-08-25","text":"<p>Fixed:</p> <ul> <li>Fix default file inclusion for <code>wheel</code> build targets when both the project name and package directory name are not normalized</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.8.0","title":"1.8.0 - 2022-08-16","text":"<p>Added:</p> <ul> <li>Add <code>get_known_classifiers</code> method to metadata hooks</li> </ul> <p>Fixed:</p> <ul> <li>Fix check for updating static versions with the <code>version</code> command when metadata hooks are in use</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.7.1","title":"1.7.1 - 2022-08-13","text":"<p>Fixed:</p> <ul> <li>Fix the value of the <code>relative_path</code> attribute of included files, that some build plugins may use, when selecting explicit paths</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.7.0","title":"1.7.0 - 2022-08-12","text":"<p>Added:</p> <ul> <li>Add <code>require-runtime-features</code> option for builders and build hooks</li> <li>Check for unknown trove classifiers</li> <li>Update SPDX license information to version 3.18</li> </ul> <p>Fixed:</p> <ul> <li>Add better error message for <code>wheel</code> target dev mode installations that define path rewrites with the <code>sources</code> option</li> <li>Note the <code>allow-direct-references</code> option in the relevant error messages</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.6.0","title":"1.6.0 - 2022-07-23","text":"<p>Changed:</p> <ul> <li>When no build targets are specified on the command line, now default to <code>sdist</code> and <code>wheel</code> targets rather than what happens to be defined in config</li> <li>The <code>code</code> version source now only supports files with known extensions</li> <li>Global build hooks now run before target-specific build hooks to better match expected behavior</li> </ul> <p>Added:</p> <ul> <li>The <code>code</code> version source now supports loading extension modules</li> <li>Add <code>search-paths</code> option for the <code>code</code> version source</li> </ul> <p>Fixed:</p> <ul> <li>Fix removing <code>sources</code> using an empty string value in the mapping</li> <li>The <code>strict-naming</code> option now also applies to the metadata directory of <code>wheel</code> targets</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.5.0","title":"1.5.0 - 2022-07-11","text":"<p>Added:</p> <ul> <li>Support the final draft of PEP 639</li> <li>Add <code>strict-naming</code> option for <code>sdist</code> and <code>wheel</code> targets</li> </ul> <p>Fixed:</p> <ul> <li>Project names are now stored in <code>sdist</code> and <code>wheel</code> target core metadata exactly as defined in <code>pyproject.toml</code> without normalization to allow control of how PyPI displays them</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.4.1","title":"1.4.1 - 2022-07-04","text":"<p>Fixed:</p> <ul> <li>Fix forced inclusion of important files like licenses for <code>sdist</code> targets when using the explicit selection options</li> <li>Don't sort project URL metadata so that the rendered order on PyPI can be controlled</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.4.0","title":"1.4.0 - 2022-07-03","text":"<p>Changed:</p> <ul> <li>The <code>packages</code> option uses the new <code>only-include</code> option to provide targeted inclusion, since that is desired most of the time. You can retain the old behavior by using the <code>include</code> and <code>sources</code> options together.</li> </ul> <p>Added:</p> <ul> <li>Support PEP 561 type hinting</li> <li>Add <code>version</code> build hook</li> <li>Add <code>only-include</code> option</li> <li>The <code>editable</code> version of <code>wheel</code> targets now respects the <code>force-include</code> option by default</li> <li>The <code>force-include</code> option now supports path rewriting with the <code>sources</code> option</li> <li>The <code>wheel</code> target <code>shared-data</code> and <code>extra-metadata</code> options now respect file selection options</li> <li>The <code>wheel</code> target now auto-detects single module layouts</li> <li>Improve performance by never entering directories that are guaranteed to be undesirable like <code>__pycache__</code> rather than excluding individual files within</li> <li>Update SPDX license information to version 3.17</li> </ul> <p>Fixed:</p> <ul> <li>Don't write empty entry points file for <code>wheel</code> targets if there are no entry points defined</li> <li>Allow metadata hooks to set the <code>version</code> in all cases</li> <li>Prevent duplicate file entries from inclusion when using the <code>force-include</code> option</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.3.1","title":"1.3.1 - 2022-05-30","text":"<p>Fixed:</p> <ul> <li>Better populate global variables for the <code>code</code> version source</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.3.0","title":"1.3.0 - 2022-05-22","text":"<p>Removed:</p> <ul> <li>Remove unused global <code>args</code> context string formatting field</li> </ul> <p>Added:</p> <ul> <li>Improve error messages for the <code>env</code> context string formatting field</li> </ul> <p>Fixed:</p> <ul> <li>Fix <code>uri</code> context string formatting modifier on Windows</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.2.0","title":"1.2.0 - 2022-05-20","text":"<p>Added:</p> <ul> <li>Allow context formatting for <code>project.dependencies</code> and <code>project.optional-dependencies</code></li> </ul>"},{"location":"history/hatchling/#hatchling-v1.1.0","title":"1.1.0 - 2022-05-19","text":"<p>Added:</p> <ul> <li>Add <code>uri</code> and <code>real</code> context string formatting modifiers for file system paths</li> </ul>"},{"location":"history/hatchling/#hatchling-v1.0.0","title":"1.0.0 - 2022-05-17","text":"<p>Changed:</p> <ul> <li>Drop support for Python 2</li> </ul> <p>Added:</p> <ul> <li>Improve error messaging for invalid versions</li> <li>Update project metadata to reflect support for Python 3.11</li> </ul>"},{"location":"history/hatchling/#hatchling-v0.25.1","title":"0.25.1 - 2022-06-14","text":"<p>Fixed:</p> <ul> <li>Fix support for Windows on Python 2 by removing its support for symlinks</li> </ul>"},{"location":"history/hatchling/#hatchling-v0.25.0","title":"0.25.0 - 2022-05-15","text":"<p>Added:</p> <ul> <li>Add <code>skip-excluded-dirs</code> build option</li> <li>Allow build data to add additional project dependencies for <code>wheel</code> and <code>sdist</code> build targets</li> <li>Add <code>force_include_editable</code> build data for the <code>wheel</code> build target</li> <li>Add <code>build_hooks</code> build data</li> <li>Add support for Mercurial's <code>.hgignore</code> files when using glob syntax</li> <li>Update project metadata to reflect the adoption by PyPA</li> </ul> <p>Fixed:</p> <ul> <li>Properly use underscores for the name of <code>force_include</code> build data</li> <li>No longer greedily skip excluded directories by default</li> </ul>"},{"location":"history/hatchling/#hatchling-v0.24.0","title":"0.24.0 - 2022-04-28","text":"<p>This is the initial public release of the Hatchling build system. Support for Python 2 will be dropped in version 1.</p>"},{"location":"how-to/config/dynamic-metadata/","title":"How to configure custom dynamic metadata","text":"<p>If you have project metadata that is not appropriate for static entry into <code>pyproject.toml</code> you will need to provide a custom metadata hook to apply such data during builds.</p> <p>Alternatives</p> <p>Dynamic metadata is a way to have a single source of truth that will be available at build time and at run time. Another way to achieve that is to enter the build data statically and then look up the same information dynamically in the program or package, using importlib.metadata.</p> <p>If the version field is the only metadata of concern, Hatchling provides a few built-in ways such as the <code>regex</code> version source and also third-party plugins. The approach here will also work, but is more complex.</p>"},{"location":"how-to/config/dynamic-metadata/#update-project-metadata","title":"Update project metadata","text":"<p>Change the <code>[project]</code> section of <code>pyproject.toml</code>:</p> <ol> <li>Define the dynamic field as an array of all the fields you will set dynamically e.g. <code>dynamic = [\"version\", \"license\", \"authors\", \"maintainers\"]</code></li> <li>If any of those fields have static definitions in <code>pyproject.toml</code>, delete those definitions. It is verboten to define a field statically and dynamically.</li> </ol> <p>Add a section to trigger loading of dynamic metadata plugins: <code>[tool.hatch.metadata.hooks.custom]</code>. Use exactly that name, regardless of the name of the class you will use or its <code>PLUGIN_NAME</code>. There doesn't need to be anything in the section.</p> <p>If your plugin requires additional third-party packages to do its work, add them to the <code>requires</code> array in the <code>[build-system]</code> section of <code>pyproject.toml</code>.</p>"},{"location":"how-to/config/dynamic-metadata/#implement-hook","title":"Implement hook","text":"<p>The dynamic lookup must happen in a custom plugin that you write. The default expectation is that it is in a <code>hatch_build.py</code> file at the root of the project. Subclass <code>MetadataHookInterface</code> and implement <code>update()</code>; for example, here's plugin that reads metadata from a JSON file:</p>  hatch_build.py <pre><code>import json\nimport os\n\nfrom hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\nclass JSONMetaDataHook(MetadataHookInterface):\n    def update(self, metadata):\n        src_file = os.path.join(self.root, \"gnumeric\", \".constants.json\")\n        with open(src_file) as src:\n            constants = json.load(src)\n            metadata[\"version\"] = constants[\"__version__\"]\n            metadata[\"license\"] = constants[\"__license__\"]\n            metadata[\"authors\"] = [\n                {\"name\": constants[\"__author__\"], \"email\": constants[\"__author_email__\"]},\n            ]\n</code></pre> <ol> <li>You must import the MetadataHookInterface to subclass it.</li> <li>Do your operations inside the <code>update</code> method.</li> <li><code>metadata</code> refers to project metadata.</li> <li>When writing to metadata, use <code>list</code> for TOML arrays. Note that if a list is expected, it is required even if there is a single element.</li> <li>Use <code>dict</code> for TOML tables e.g. <code>authors</code>.</li> </ol> <p>If you want to store the hook in a different location, set the <code>path</code> option:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata.hooks.custom]\npath = \"some/where.py\"\n</code></pre> <pre><code>[metadata.hooks.custom]\npath = \"some/where.py\"\n</code></pre>"},{"location":"how-to/environment/package-indices/","title":"How to configure package indices","text":"<p>Most Hatch environment types, like the default virtual, simply use pip to install dependencies. Therefore, you can use the standard environment variables that influence <code>pip</code>'s behavior to choose where to search for packages.</p> <p>Here's an example of setting up the default environment to look at 2 private indices (using context formatting for authentication) before finally falling back to PyPI:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default.env-vars]\nPIP_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group1_path&gt;/-/packages/pypi/simple/\"\nPIP_EXTRA_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group2_path&gt;/-/packages/pypi/simple/ https://pypi.org/simple/\"\n</code></pre> <pre><code>[envs.default.env-vars]\nPIP_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group1_path&gt;/-/packages/pypi/simple/\"\nPIP_EXTRA_INDEX_URL = \"https://token:{env:GITLAB_API_TOKEN}@gitlab.com/api/v4/groups/&lt;group2_path&gt;/-/packages/pypi/simple/ https://pypi.org/simple/\"\n</code></pre>"},{"location":"how-to/meta/report-issues/","title":"How to report issues","text":"<p>All reports regarding unexpected behavior should be generated with the <code>self report</code> command:</p> <pre><code>$ hatch self report\n</code></pre> <p>By default, this will open a new tab in your default browser with pre-populated information about your environment.</p> <p>If Hatch is not installed alongside a web browser, you may also pass the <code>--no-open</code>/<code>-n</code> command which will output the URL with correct parameters for copying elsewhere:</p> <pre><code>$ hatch self report -n\nhttps://github.com/pypa/hatch/issues/new?body=%23%23+Current+behavior%0A%3C%21--+A+clear+and+concise+description+of+the+behavior.+--%3E%0A%0A%23%23+Expected+behavior%0A%3C%21--+A+clear+and+concise+description+of+what+you+expected+to+happen.+--%3E%0A%0A%23%23+Additional+context%0A%3C%21--+Add+any+other+context+about+the+problem+here.+If+applicable%2C+add+screenshots+to+help+explain.+--%3E%0A%0A%23%23+Debug%0A%0A%23%23%23+Installation%0A%0A-+Source%3A+pip%0A-+Version%3A+1.9.2.dev5%0A-+Platform%3A+Windows%0A-+Python+version%3A%0A++++%60%60%60%0A++++3.11.1+%28tags%2Fv3.11.1%3Aa7a450f%2C+Dec++6+2022%2C+19%3A58%3A39%29+%5BMSC+v.1934+64+bit+%28AMD64%29%5D%0A++++%60%60%60%0A%0A%23%23%23+Configuration%0A%0A%60%60%60toml%0Amode+%3D+%22local%22%0Ashell+%3D+%22nu%22%0A%60%60%60%0A\n</code></pre>"},{"location":"how-to/plugins/testing-builds/","title":"Testing build plugins","text":"<p>For testing Hatchling plugins, you'll usually want to generate a project to execute builds as a real user would. For example, as a minimal pytest fixture:</p> <pre><code>from pathlib import Path\n\nimport pytest\n\n\n@pytest.fixture\ndef new_project(tmp_path):\n    project_dir = tmp_path / 'my-app'\n    project_dir.mkdir()\n\n    project_file = project_dir / 'pyproject.toml'\n    project_file.write_text(\n        f\"\"\"\\\n[build-system]\nrequires = [\"hatchling\", \"hatch-plugin-name @ {Path.cwd().as_uri()}\"]\nbuild-backend = \"hatchling.build\"\n\n[project]\nname = \"my-app\"\nversion = \"0.1.0\"\n\"\"\",\n        encoding='utf-8',\n    )\n    ...\n</code></pre> <p>The issue with this is that after the first test session, the project will be forever cached by pip based on the file path. Therefore, subsequent tests runs will never use updated code.</p> <p>To invalidate the cache, copy your code to a new path for every test session:</p> <pre><code>import shutil\nfrom pathlib import Path\nfrom tempfile import TemporaryDirectory\n\nimport pytest\n\n\n@pytest.fixture(scope='session')\ndef plugin_dir():\n    with TemporaryDirectory() as d:\n        directory = Path(d, 'plugin')\n        shutil.copytree(\n            Path.cwd(), directory, ignore=shutil.ignore_patterns('.git')\n        )\n\n        yield directory.resolve()\n\n\n@pytest.fixture\ndef new_project(tmp_path, plugin_dir):\n    project_dir = tmp_path / 'my-app'\n    project_dir.mkdir()\n\n    project_file = project_dir / 'pyproject.toml'\n    project_file.write_text(\n        f\"\"\"\\\n[build-system]\nrequires = [\"hatchling\", \"hatch-plugin-name @ {plugin_dir.as_uri()}\"]\nbuild-backend = \"hatchling.build\"\n\n[project]\nname = \"my-app\"\nversion = \"0.1.0\"\n\"\"\",\n        encoding='utf-8',\n    )\n    ...\n</code></pre> <p>Note</p> <p>This example chooses to ignore copying <code>.git</code> for performance reasons. You may want to ignore more patterns, or copy only specific paths like this plugin does.</p>"},{"location":"how-to/publish/auth/","title":"How to authenticate for index publishing","text":"<p>The username is derived from the following sources, in order of precedence:</p> <ol> <li>The  <code>--user</code> / <code>-u</code> cli option.</li> <li>The <code>HATCH_INDEX_USER</code> environment variable.</li> <li>The <code>repos</code> tables.</li> <li>The <code>~/.pypirc</code> file.</li> <li>The input to an interactive prompt.</li> </ol> <p>As a fallback the value <code>__token__</code> is applied.</p> <p>The password is looked up in these:</p> <ol> <li>The <code>~/.pypirc</code> file    if the username was provided by it.</li> <li>The <code>--auth</code> / <code>-a</code> cli option.</li> <li>The <code>HATCH_INDEX_AUTH</code> environment variable.</li> <li>The <code>repos</code> tables.</li> <li>A variety of OS-level credentials services backed by keyring.</li> <li>The input to an interactive prompt.</li> </ol> <p>If interactively provided credentials were used, the username will be stored in Hatch's cache and the password stored in the available keyring backed credentials stores.</p> <p>For automated releasing to PyPI, it is recommended to use \"Trusted Publishing\" with OIDC (e.g. PyPA's <code>pypi-publish</code> GitHub Action) or per-project API tokens.</p>"},{"location":"how-to/publish/repo/","title":"How to configure repositories for index publishing","text":"<p>You can select the repository with which to upload using the <code>-r</code>/<code>--repo</code> option or by setting the <code>HATCH_INDEX_REPO</code> environment variable.</p> <p>Rather than specifying the full URL of a repository, you can use a named repository from a <code>publish.index.repos</code> table defined in Hatch's config file:</p>  config.toml <pre><code>[publish.index.repos.private]\nurl = \"...\"\n...\n</code></pre> <p>The following repository names are reserved by Hatch and cannot be overridden:</p> Name Repository <code>main</code> https://upload.pypi.org/legacy/ <code>test</code> https://test.pypi.org/legacy/ <p>The <code>main</code> repository is used by default.</p>"},{"location":"how-to/static-analysis/behavior/","title":"Customize static analysis behavior","text":"<p>You can fully alter the static analysis performed by the <code>fmt</code> command by modifing the reserved environment named <code>hatch-static-analysis</code>. For example, you could define the following if you wanted to replace the default behavior with a mix of Black, isort and basic flake8:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.hatch-static-analysis]\ndependencies = [\"black\", \"flake8\", \"isort\"]\n\n[tool.hatch.envs.hatch-static-analysis.scripts]\nformat-check = [\n  \"black --check --diff {args:.}\",\n  \"isort --check-only --diff {args:.}\",\n]\nformat-fix = [\n  \"isort {args:.}\",\n  \"black {args:.}\",\n]\nlint-check = \"flake8 {args:.}\"\nlint-fix = \"lint-check\"\n</code></pre> <pre><code>[envs.hatch-static-analysis]\ndependencies = [\"black\", \"flake8\", \"isort\"]\n\n[envs.hatch-static-analysis.scripts]\nformat-check = [\n  \"black --check --diff {args:.}\",\n  \"isort --check-only --diff {args:.}\",\n]\nformat-fix = [\n  \"isort {args:.}\",\n  \"black {args:.}\",\n]\nlint-check = \"flake8 {args:.}\"\nlint-fix = \"lint-check\"\n</code></pre> <p>The <code>format-*</code> scripts correspond to the <code>--formatter</code>/<code>-f</code> flag while the <code>lint-*</code> scripts correspond to the <code>--linter</code>/<code>-l</code> flag. The <code>*-fix</code> scripts run by default while the <code>*-check</code> scripts correspond to the <code>--check</code> flag. Based on this example, the following shows how the various scripts influence behavior:</p> Command Expanded scripts <code>hatch fmt</code> <ul><li><code>flake8 .</code></li><li><code>isort .</code></li><li><code>black .</code></li></ul> <code>hatch fmt src tests</code> <ul><li><code>flake8 src tests</code></li><li><code>isort src tests</code></li><li><code>black src tests</code></li></ul> <code>hatch fmt -f</code> <ul><li><code>isort .</code></li><li><code>black .</code></li></ul> <code>hatch fmt -l</code> <ul><li><code>flake8 .</code></li></ul> <code>hatch fmt --check</code> <ul><li><code>flake8 .</code></li><li><code>black --check --diff .</code></li><li><code>isort --check-only --diff .</code></li></ul> <code>hatch fmt --check -f</code> <ul><li><code>black --check --diff .</code></li><li><code>isort --check-only --diff .</code></li></ul> <code>hatch fmt --check -l</code> <ul><li><code>flake8 .</code></li></ul>"},{"location":"meta/authors/","title":"Authors","text":""},{"location":"meta/authors/#maintainers","title":"Maintainers","text":"<ul> <li>Ofek Lev  </li> </ul>"},{"location":"meta/authors/#contributors","title":"Contributors","text":"<ul> <li>Amjith Ramanujam </li> <li>Arnaud Crowther </li> <li>Chaojie  </li> <li>Chris Warrick </li> <li>Lum\u00edr 'Frenzy' Balhar  </li> <li>Ofek Lev  </li> <li>Olga Matoula  </li> <li>Philip Blair </li> <li>Robert Rosca </li> </ul>"},{"location":"meta/faq/","title":"FAQ","text":""},{"location":"meta/faq/#interoperability","title":"Interoperability","text":"<p>Q: What is the risk of lock-in?</p> <p>A: Not much! Other than the plugin system, everything uses Python's established standards by default. Project metadata is based entirely on the standard, the build system is compatible with PEP 517/PEP 660, versioning uses the scheme specified by PEP 440, dependencies are defined with PEP 508 strings, and environments use virtualenv.</p> <p>Q: Must one use all features?</p> <p>A: No, all features are optional! You can use just the build system, publish wheels and source distributions that were built by other tools, only use the environment management, etc.</p>"},{"location":"meta/faq/#libraries-vs-applications","title":"Libraries vs applications","text":"<p>Q: Are workflows for both libraries and applications supported?</p> <p>A: Yes, mostly! Applications can utilize environment management just like libraries, and plugins can be used to build projects in arbitrary formats or publish artifacts to arbitrary destinations.</p> <p>The only caveat is that currently there is no support for re-creating an environment given a set of dependencies in a reproducible manner. Although a standard lock file format may be far off since PEP 665 was rejected, resolving capabilities are coming to pip. When that is stabilized, Hatch will add locking functionality and dedicated documentation for managing applications.</p>"},{"location":"meta/faq/#tool-migration","title":"Tool migration","text":"<p>Q: How to migrate to Hatch?</p>"},{"location":"meta/faq/#build-system","title":"Build system","text":"SetuptoolsHatch  setup.py MANIFEST.in <pre><code>import os\nfrom io import open\n\nfrom setuptools import find_packages, setup\n\nabout = {}\nwith open(os.path.join('src', 'foo', '__about__.py'), 'r', 'utf-8') as f:\n    exec(f.read(), about)\n\nwith open('README.md', 'r', 'utf-8') as f:\n    readme = f.read()\n\nsetup(\n    # Metadata\n    name='foo',\n    version=about['__version__'],\n    description='...',\n    long_description=readme,\n    long_description_content_type='text/markdown',\n    author='...',\n    author_email='...',\n    project_urls={\n        'Documentation': '...',\n        'Source': '...',\n    },\n    classifiers=[\n        '...',\n    ],\n    keywords=[\n        '...',\n    ],\n    python_requires='&gt;=3.8',\n    install_requires=[\n        '...',\n    ],\n    extras_require={\n        'feature': ['...'],\n    },\n\n    # Packaging\n    packages=find_packages(where='src'),\n    package_dir={'': 'src'},\n    package_data={\n        'foo': ['py.typed'],\n    },\n    zip_safe=False,\n    entry_points={\n        'console_scripts': [\n            'foo = foo.cli:main',\n        ],\n    },\n)\n</code></pre> <pre><code>graft tests\n\nglobal-exclude *.py[cod] __pycache__\n</code></pre>  pyproject.toml <pre><code>[build-system]\nrequires = [\"hatchling\"]\nbuild-backend = \"hatchling.build\"\n\n[project]\nname = \"foo\"\ndescription = \"...\"\nreadme = \"README.md\"\nauthors = [\n  { name = \"...\", email = \"...\" },\n]\nclassifiers = [\n  \"...\",\n]\nkeywords = [\n  \"...\",\n]\nrequires-python = \"&gt;=3.8\"\ndependencies = [\n  \"...\",\n]\ndynamic = [\"version\"]\n\n[project.urls]\nDocumentation = \"...\"\nSource = \"...\"\n\n[project.optional-dependencies]\nfeature = [\"...\"]\n\n[project.scripts]\nfoo = \"foo.cli:main\"\n\n[tool.hatch.version]\npath = \"src/foo/__about__.py\"\n\n[tool.hatch.build.targets.sdist]\ninclude = [\n  \"/src\",\n  \"/tests\",\n]\n</code></pre>"},{"location":"meta/faq/#environments","title":"Environments","text":"ToxHatch <p>Invocation:</p> <pre><code>tox\n</code></pre>  tox.ini <pre><code>[tox]\nenvlist =\n    py{27,38}-{42,3.14}\n    py{38,39}-{9000}-{foo,bar}\n\n[testenv]\nusedevelop = true\ndeps =\n    coverage[toml]\n    pytest\n    pytest-cov\n    foo: cryptography\ncommands =\n    pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests {posargs}\nsetenv =\n    3.14: PRODUCT_VERSION=3.14\n    42: PRODUCT_VERSION=42\n    9000: PRODUCT_VERSION=9000\n    {foo,bar}: EXPERIMENTAL=true\n</code></pre> <p>Invocation:</p> <pre><code>hatch run test\n</code></pre>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[tool.hatch.envs.default.scripts]\ntest = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[tool.hatch.envs.default.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.features.env-vars = \"EXPERIMENTAL=true\"\nmatrix.features.dependencies = [\n  { value = \"cryptography\", if = [\"foo\"] },\n]\n\n[[tool.hatch.envs.default.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[tool.hatch.envs.default.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"coverage[toml]\",\n  \"pytest\",\n  \"pytest-cov\",\n]\n\n[envs.default.scripts]\ntest = 'pytest --cov-report=term-missing --cov-config=pyproject.toml --cov=pkg --cov=tests'\n\n[envs.default.overrides]\nmatrix.version.env-vars = \"PRODUCT_VERSION\"\nmatrix.features.env-vars = \"EXPERIMENTAL=true\"\nmatrix.features.dependencies = [\n  { value = \"cryptography\", if = [\"foo\"] },\n]\n\n[[envs.default.matrix]]\npython = [\"2.7\", \"3.8\"]\nversion = [\"42\", \"3.14\"]\n\n[[envs.default.matrix]]\npython = [\"3.8\", \"3.9\"]\nversion = [\"9000\"]\nfeatures = [\"foo\", \"bar\"]\n</code></pre>"},{"location":"meta/faq/#fast-cli","title":"Fast CLI?","text":"<p>The claim about being faster than other tools is based on timings that are always checked in CI.</p> <p>Hatch achieves this by using lazy imports, lazily performing computation manually and with functools.cached_property, using hacks like <code>not not ...</code> instead of <code>bool(...)</code>, etc.</p>"},{"location":"plugins/about/","title":"Plugins","text":"<p>Hatch utilizes pluggy for its plugin functionality.</p>"},{"location":"plugins/about/#overview","title":"Overview","text":"<p>All plugins provide registration hooks that return one or more classes that inherit from a particular type interface.</p> <p>Each registration hook must be decorated by Hatch's hook marker. For example, if you wanted to create a new kind of environment you could do:</p>  hooks.py <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialEnvironment\n\n\n@hookimpl\ndef hatch_register_environment():\n    return SpecialEnvironment\n</code></pre> <p>The hooks can return a single class or a list of classes.</p> <p>Every class must define an attribute called <code>PLUGIN_NAME</code> that users will select when they wish to use the plugin. So in the example above, the class might be defined like:</p>  plugin.py <pre><code>...\nclass SpecialEnvironment(...):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre>"},{"location":"plugins/about/#project-configuration","title":"Project configuration","text":""},{"location":"plugins/about/#naming","title":"Naming","text":"<p>It is recommended that plugin project names are prefixed with <code>hatch-</code>. For example, if you wanted to make a plugin that provides some functionality for a product named <code>foo</code> you might do:</p>  pyproject.toml <pre><code>[project]\nname = \"hatch-foo\"\n</code></pre>"},{"location":"plugins/about/#discovery","title":"Discovery","text":"<p>You'll need to define your project as a Python plugin for Hatch:</p>  pyproject.toml <pre><code>[project.entry-points.hatch]\nfoo = \"pkg.hooks\"\n</code></pre> <p>The name of the plugin should be the project name (excluding any <code>hatch-</code> prefix) and the path should represent the module that contains the registration hooks.</p>"},{"location":"plugins/about/#classifier","title":"Classifier","text":"<p>Add <code>Framework :: Hatch</code> to your project's classifiers to make it easy to search for Hatch plugins:</p>  pyproject.toml <pre><code>[project]\nclassifiers = [\n  ...\n  \"Framework :: Hatch\",\n  ...\n]\n</code></pre>"},{"location":"plugins/about/#types","title":"Types","text":""},{"location":"plugins/about/#hatchling","title":"Hatchling","text":"<p>These are all involved in building projects and therefore any defined dependencies are automatically installed in each build environment.</p> <ul> <li>Builder</li> <li>Build hook</li> <li>Metadata hook</li> <li>Version source</li> <li>Version scheme</li> </ul>"},{"location":"plugins/about/#hatch","title":"Hatch","text":"<p>These must be installed in the same environment as Hatch itself.</p> <ul> <li>Environment</li> <li>Environment collector</li> <li>Publisher</li> </ul>"},{"location":"plugins/utilities/","title":"Plugin utilities","text":""},{"location":"plugins/utilities/#hatchling.builders.utils.get_reproducible_timestamp","title":"<code>hatchling.builders.utils.get_reproducible_timestamp() -&gt; int</code>","text":"<p>Returns an <code>int</code> derived from the <code>SOURCE_DATE_EPOCH</code> environment variable; see https://reproducible-builds.org/specs/source-date-epoch/.</p> <p>The default value will always be: <code>1580601600</code></p> Source code in <code>backend/src/hatchling/builders/utils.py</code> <pre><code>def get_reproducible_timestamp() -&gt; int:\n    \"\"\"\n    Returns an `int` derived from the `SOURCE_DATE_EPOCH` environment variable; see\n    https://reproducible-builds.org/specs/source-date-epoch/.\n\n    The default value will always be: `1580601600`\n    \"\"\"\n    return int(os.environ.get('SOURCE_DATE_EPOCH', '1580601600'))\n</code></pre>"},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig","title":"<code>BuilderConfig</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.directory","title":"<code>directory: str</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.ignore_vcs","title":"<code>ignore_vcs: bool</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.reproducible","title":"<code>reproducible: bool</code>  <code>property</code>","text":"<p>Whether or not the target should be built in a reproducible manner, defaulting to true.</p>"},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.dev_mode_dirs","title":"<code>dev_mode_dirs: list[str]</code>  <code>property</code>","text":"<p>Directories which must be added to Python's search path in dev mode.</p>"},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.versions","title":"<code>versions: list[str]</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.dependencies","title":"<code>dependencies: list[str]</code>  <code>property</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_include","title":"<code>default_include() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_exclude","title":"<code>default_exclude() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_packages","title":"<code>default_packages() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.builders.config.BuilderConfig.default_only_include","title":"<code>default_only_include() -&gt; list</code>","text":""},{"location":"plugins/utilities/#hatchling.bridge.app.Application","title":"<code>Application</code>","text":"<p>The way output is displayed can be configured by users.</p> <p>Important</p> <p>Never import this directly; Hatch judiciously decides if a type of plugin requires the capabilities herein and will grant access via an attribute.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.verbosity","title":"<code>verbosity: int</code>  <code>property</code>","text":"<p>The verbosity level of the application, with 0 as the default.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.abort","title":"<code>abort(message: str = '', code: int = 1, **kwargs: Any) -&gt; None</code>","text":"<p>Terminate the program with the given return code.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_debug","title":"<code>display_debug(message: str = '', level: int = 1, **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages that are not useful for most user experiences. The <code>level</code> option must be between 1 and 3 (inclusive).</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_error","title":"<code>display_error(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages indicating some unrecoverable error.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_info","title":"<code>display_info(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages conveying basic information.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_success","title":"<code>display_success(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages indicating some positive outcome.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_waiting","title":"<code>display_waiting(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages shown before potentially time consuming operations.</p>"},{"location":"plugins/utilities/#hatchling.bridge.app.Application.display_warning","title":"<code>display_warning(message: str = '', **kwargs: Any) -&gt; None</code>","text":"<p>Meant to be used for messages conveying important information.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform","title":"<code>Platform</code>","text":""},{"location":"plugins/utilities/#hatch.utils.platform.Platform.default_shell","title":"<code>default_shell: str</code>  <code>property</code>","text":"<p>Returns the default shell of the system.</p> <p>On Windows systems first try the <code>SHELL</code> environment variable, if present, followed by the <code>COMSPEC</code> environment variable, defaulting to <code>cmd</code>. On all other platforms only the <code>SHELL</code> environment variable will be used, defaulting to <code>bash</code>.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.modules","title":"<code>modules: LazilyLoadedModules</code>  <code>property</code>","text":"<p>Accessor for lazily loading modules that either take multiple milliseconds to import (like <code>shutil</code> and <code>subprocess</code>) or are not used on all platforms (like <code>shlex</code>).</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.home","title":"<code>home: Path</code>  <code>property</code>","text":"<p>The user's home directory as a path-like object.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.name","title":"<code>name: str</code>  <code>property</code>","text":"<p>One of the following:</p> <ul> <li><code>linux</code></li> <li><code>windows</code></li> <li><code>macos</code></li> </ul>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.display_name","title":"<code>display_name: str</code>  <code>property</code>","text":"<p>One of the following:</p> <ul> <li><code>Linux</code></li> <li><code>Windows</code></li> <li><code>macOS</code></li> </ul>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.windows","title":"<code>windows: bool</code>  <code>property</code>","text":"<p>Indicates whether Hatch is running on Windows.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.macos","title":"<code>macos: bool</code>  <code>property</code>","text":"<p>Indicates whether Hatch is running on macOS.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.linux","title":"<code>linux: bool</code>  <code>property</code>","text":"<p>Indicates whether Hatch is running on neither Windows nor macOS.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.format_for_subprocess","title":"<code>format_for_subprocess(command: str | list[str], *, shell: bool) -&gt; str | list[str]</code>","text":"<p>Format the given command in a cross-platform manner for immediate consumption by subprocess utilities.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.run_command","title":"<code>run_command(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; CompletedProcess</code>","text":"<p>Equivalent to the standard library's subprocess.run, with the command first being properly formatted.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.check_command","title":"<code>check_command(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; CompletedProcess</code>","text":"<p>Equivalent to run_command, but non-zero exit codes will gracefully end program execution.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.check_command_output","title":"<code>check_command_output(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; str</code>","text":"<p>Equivalent to the output from the process returned by capture_process, but non-zero exit codes will gracefully end program execution.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.capture_process","title":"<code>capture_process(command: str | list[str], *, shell: bool = False, **kwargs: Any) -&gt; Popen</code>","text":"<p>Equivalent to the standard library's subprocess.Popen, with all output captured by <code>stdout</code> and the command first being properly formatted.</p>"},{"location":"plugins/utilities/#hatch.utils.platform.Platform.exit_with_command","title":"<code>exit_with_command(command: list[str]) -&gt; None</code>","text":"<p>Run the given command and exit with its exit code. On non-Windows systems, this uses the standard library's os.execvp.</p>"},{"location":"plugins/utilities/#hatch.env.context.EnvironmentContextFormatter","title":"<code>EnvironmentContextFormatter</code>","text":""},{"location":"plugins/utilities/#hatch.env.context.EnvironmentContextFormatter.formatters","title":"<code>formatters()</code>","text":"<p>This returns a mapping of supported field names to their respective formatting functions. Each function accepts 2 arguments:</p> <ul> <li>the <code>value</code> that was passed to the format call, defaulting to <code>None</code></li> <li>the modifier <code>data</code>, defaulting to an empty string</li> </ul>"},{"location":"plugins/build-hook/custom/","title":"Custom build hook","text":"<p>This is a custom class in a given Python file that inherits from the BuildHookInterface.</p>"},{"location":"plugins/build-hook/custom/#configuration","title":"Configuration","text":"<p>The build hook plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.custom]\n[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.custom]\n</code></pre> <pre><code>[build.hooks.custom]\n[build.targets.&lt;TARGET_NAME&gt;.hooks.custom]\n</code></pre>"},{"location":"plugins/build-hook/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_build.py</code> The path of the Python file"},{"location":"plugins/build-hook/custom/#example","title":"Example","text":"hatch_build.py <pre><code>from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\nclass CustomBuildHook(BuildHookInterface):\n    ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_build_hook</code> that returns the desired build hook.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/build-hook/reference/","title":"Build hook plugins","text":"<p>A build hook provides code that will be executed at various stages of the build process. See the documentation for build hook configuration.</p>"},{"location":"plugins/build-hook/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-autorun - used to inject code into an installation that will automatically run before the first import</li> <li>hatch-build-scripts - run arbitrary shell commands that create artifacts</li> <li>hatch-jupyter-builder - used for packages in the Project Jupyter ecosystem</li> <li>hatch-mypyc - compiles code with Mypyc</li> <li>hatch-odoo - package Odoo add-ons into the appropriate namespace</li> </ul>"},{"location":"plugins/build-hook/reference/#overview","title":"Overview","text":"<p>Build hooks run for every selected version of build targets.</p> <p>The initialization stage occurs immediately before each build and the finalization stage occurs immediately after. Each stage has the opportunity to view or modify build data.</p>"},{"location":"plugins/build-hook/reference/#build-data","title":"Build data","text":"<p>Build data is a simple mapping whose contents can influence the behavior of builds. Which fields exist and are recognized depends on each build target.</p> <p>The following fields are always present and recognized by the build system itself:</p> Field Type Description <code>artifacts</code> <code>list[str]</code> This is a list of extra <code>artifact</code> patterns and should generally only be appended to <code>force_include</code> <code>dict[str, str]</code> This is a mapping of extra forced inclusion paths, with this mapping taking precedence in case of conflicts <code>build_hooks</code> <code>tuple[str, ...]</code> This is an immutable sequence of the names of the configured build hooks and matches the order in which they run <p>Attention</p> <p>While user-facing TOML options are hyphenated, build data fields should be named with underscores to allow plugins to use them as valid Python identifiers.</p>"},{"location":"plugins/build-hook/reference/#notes","title":"Notes","text":"<p>In some cases it may be necessary to use <code>force_include</code> rather than <code>artifacts</code>. For example, say that you want to install a <code>lib.so</code> directly at the root of <code>site-packages</code> and a project defines a package <code>src/foo</code>. If you create <code>src/lib.so</code>, there will never be a match because the directory traversal starts at <code>src/foo</code> rather than <code>src</code>. In that case you must do either:</p> <pre><code>build_data['force_include']['src/lib.so'] = 'src/lib.so'\n</code></pre> <p>or</p> <pre><code>build_data['force_include']['/absolute/path/to/src/lib.so'] = 'src/lib.so'\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface","title":"<code>BuildHookInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\nclass SpecialBuildHook(BuildHookInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialBuildHook\n\n\n@hookimpl\ndef hatch_register_build_hook():\n    return SpecialBuildHook\n</code></pre> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>class BuildHookInterface(Generic[BuilderConfigBound]):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.builders.hooks.plugin.interface import BuildHookInterface\n\n\n    class SpecialBuildHook(BuildHookInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialBuildHook\n\n\n    @hookimpl\n    def hatch_register_build_hook():\n        return SpecialBuildHook\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(\n        self,\n        root: str,\n        config: dict[str, Any],\n        build_config: BuilderConfigBound,\n        metadata: ProjectMetadata,\n        directory: str,\n        target_name: str,\n        app: Application | None = None,\n    ) -&gt; None:\n        self.__root = root\n        self.__config = config\n        self.__build_config = build_config\n        self.__metadata = metadata\n        self.__directory = directory\n        self.__target_name = target_name\n        self.__app = app\n\n    @property\n    def app(self) -&gt; Application:\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        if self.__app is None:\n            from hatchling.bridge.app import Application\n\n            self.__app = cast(Application, Application().get_safe_application())\n\n        return self.__app\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict[str, Any]:\n        \"\"\"\n        The cumulative hook configuration.\n\n        ```toml config-example\n        [tool.hatch.build.hooks.&lt;PLUGIN_NAME&gt;]\n        [tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    @property\n    def metadata(self) -&gt; ProjectMetadata:\n        # Undocumented for now\n        return self.__metadata\n\n    @property\n    def build_config(self) -&gt; BuilderConfigBound:\n        \"\"\"\n        An instance of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n        \"\"\"\n        return self.__build_config\n\n    @property\n    def directory(self) -&gt; str:\n        \"\"\"\n        The build directory.\n        \"\"\"\n        return self.__directory\n\n    @property\n    def target_name(self) -&gt; str:\n        \"\"\"\n        The plugin name of the build target.\n        \"\"\"\n        return self.__target_name\n\n    def dependencies(self) -&gt; list[str]:  # noqa: PLR6301\n        \"\"\"\n        A list of extra [dependencies](../../config/dependency.md) that must be installed\n        prior to builds.\n\n        !!! warning\n            - For this to have any effect the hook dependency itself cannot be dynamic and\n                must always be defined in `build-system.requires`.\n            - As the hook must be imported to call this method, imports that require these\n                dependencies must be evaluated lazily.\n        \"\"\"\n        return []\n\n    def clean(self, versions: list[str]) -&gt; None:\n        \"\"\"\n        This occurs before the build process if the `-c`/`--clean` flag was passed to\n        the [`build`](../../cli/reference.md#hatch-build) command, or when invoking\n        the [`clean`](../../cli/reference.md#hatch-clean) command.\n        \"\"\"\n\n    def initialize(self, version: str, build_data: dict[str, Any]) -&gt; None:\n        \"\"\"\n        This occurs immediately before each build.\n\n        Any modifications to the build data will be seen by the build target.\n        \"\"\"\n\n    def finalize(self, version: str, build_data: dict[str, Any], artifact_path: str) -&gt; None:\n        \"\"\"\n        This occurs immediately after each build and will not run if the `--hooks-only` flag\n        was passed to the [`build`](../../cli/reference.md#hatch-build) command.\n\n        The build data will reflect any modifications done by the target during the build.\n        \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.app","title":"<code>app: Application</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.config","title":"<code>config: dict[str, Any]</code>  <code>property</code>","text":"<p>The cumulative hook configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.&lt;PLUGIN_NAME&gt;]\n[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[build.hooks.&lt;PLUGIN_NAME&gt;]\n[build.targets.&lt;TARGET_NAME&gt;.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.build_config","title":"<code>build_config: BuilderConfigBound</code>  <code>property</code>","text":"<p>An instance of BuilderConfig.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.target_name","title":"<code>target_name: str</code>  <code>property</code>","text":"<p>The plugin name of the build target.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.directory","title":"<code>directory: str</code>  <code>property</code>","text":"<p>The build directory.</p>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.dependencies","title":"<code>dependencies() -&gt; list[str]</code>","text":"<p>A list of extra dependencies that must be installed prior to builds.</p> <p>Warning</p> <ul> <li>For this to have any effect the hook dependency itself cannot be dynamic and     must always be defined in <code>build-system.requires</code>.</li> <li>As the hook must be imported to call this method, imports that require these     dependencies must be evaluated lazily.</li> </ul> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def dependencies(self) -&gt; list[str]:  # noqa: PLR6301\n    \"\"\"\n    A list of extra [dependencies](../../config/dependency.md) that must be installed\n    prior to builds.\n\n    !!! warning\n        - For this to have any effect the hook dependency itself cannot be dynamic and\n            must always be defined in `build-system.requires`.\n        - As the hook must be imported to call this method, imports that require these\n            dependencies must be evaluated lazily.\n    \"\"\"\n    return []\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.clean","title":"<code>clean(versions: list[str]) -&gt; None</code>","text":"<p>This occurs before the build process if the <code>-c</code>/<code>--clean</code> flag was passed to the <code>build</code> command, or when invoking the <code>clean</code> command.</p> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def clean(self, versions: list[str]) -&gt; None:\n    \"\"\"\n    This occurs before the build process if the `-c`/`--clean` flag was passed to\n    the [`build`](../../cli/reference.md#hatch-build) command, or when invoking\n    the [`clean`](../../cli/reference.md#hatch-clean) command.\n    \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.initialize","title":"<code>initialize(version: str, build_data: dict[str, Any]) -&gt; None</code>","text":"<p>This occurs immediately before each build.</p> <p>Any modifications to the build data will be seen by the build target.</p> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def initialize(self, version: str, build_data: dict[str, Any]) -&gt; None:\n    \"\"\"\n    This occurs immediately before each build.\n\n    Any modifications to the build data will be seen by the build target.\n    \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/reference/#hatchling.builders.hooks.plugin.interface.BuildHookInterface.finalize","title":"<code>finalize(version: str, build_data: dict[str, Any], artifact_path: str) -&gt; None</code>","text":"<p>This occurs immediately after each build and will not run if the <code>--hooks-only</code> flag was passed to the <code>build</code> command.</p> <p>The build data will reflect any modifications done by the target during the build.</p> Source code in <code>backend/src/hatchling/builders/hooks/plugin/interface.py</code> <pre><code>def finalize(self, version: str, build_data: dict[str, Any], artifact_path: str) -&gt; None:\n    \"\"\"\n    This occurs immediately after each build and will not run if the `--hooks-only` flag\n    was passed to the [`build`](../../cli/reference.md#hatch-build) command.\n\n    The build data will reflect any modifications done by the target during the build.\n    \"\"\"\n</code></pre>"},{"location":"plugins/build-hook/version/","title":"Version build hook","text":"<p>This writes the project's version to a file.</p>"},{"location":"plugins/build-hook/version/#configuration","title":"Configuration","text":"<p>The build hook plugin name is <code>version</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.hooks.version]\n[tool.hatch.build.targets.&lt;TARGET_NAME&gt;.hooks.version]\n</code></pre> <pre><code>[build.hooks.version]\n[build.targets.&lt;TARGET_NAME&gt;.hooks.version]\n</code></pre>"},{"location":"plugins/build-hook/version/#options","title":"Options","text":"Option Description <code>path</code> (required) A relative path to the desired file <code>template</code> A string representing the entire contents of <code>path</code> that will be formatted with a <code>version</code> variable <code>pattern</code> Rather than updating the entire file, a regular expression may be used that has a named group called <code>version</code> that represents the version. If set to <code>true</code>, a pattern will be used that looks for a variable named <code>__version__</code> or <code>VERSION</code> that is set to a string containing the version, optionally prefixed with the lowercase letter <code>v</code>."},{"location":"plugins/builder/binary/","title":"Binary builder","text":"<p>This uses PyApp to build an application that is able to bootstrap itself at runtime.</p> <p>Note</p> <p>This requires an installation of Rust.</p>"},{"location":"plugins/builder/binary/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>binary</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.binary]\n</code></pre> <pre><code>[build.targets.binary]\n</code></pre>"},{"location":"plugins/builder/binary/#options","title":"Options","text":"Option Default Description <code>scripts</code> all defined An array of defined script names to limit what gets built <code>python-version</code> latest compatible Python minor version The Python version ID to use <code>pyapp-version</code> The version of PyApp to use"},{"location":"plugins/builder/binary/#build-behavior","title":"Build behavior","text":"<p>If any scripts are defined then each one will be built (limited by the <code>scripts</code> option). Otherwise, a single executable will be built based on the project name assuming there is an equivalently named module with a <code>__main__.py</code> file.</p> <p>Every executable will be built inside an <code>app</code> directory in the output directory.</p> <p>If the <code>CARGO</code> environment variable is set then that path will be used as the executable for performing builds.</p> <p>If the <code>CARGO_BUILD_TARGET</code> environment variable is set then its value will be appended to the file name stems.</p> <p>If the <code>PYAPP_REPO</code> environment variable is set then a local build will be performed inside that directory rather than installing from crates.io. Note that this is required if the <code>CARGO</code> environment variable refers to cross.</p>"},{"location":"plugins/builder/custom/","title":"Custom builder","text":"<p>This is a custom class in a given Python file that inherits from the BuilderInterface.</p>"},{"location":"plugins/builder/custom/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.custom]\n</code></pre> <pre><code>[build.targets.custom]\n</code></pre>"},{"location":"plugins/builder/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_build.py</code> The path of the Python file"},{"location":"plugins/builder/custom/#example","title":"Example","text":"hatch_build.py <pre><code>from hatchling.builders.plugin.interface import BuilderInterface\n\n\nclass CustomBuilder(BuilderInterface):\n    ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_builder</code> that returns the desired builder.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/builder/reference/","title":"Builder plugins","text":"<p>See the documentation for build configuration.</p>"},{"location":"plugins/builder/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-aws - used for building AWS Lambda functions with SAM</li> <li>hatch-zipped-directory - used for building ZIP archives for installation into various foreign package installation systems</li> </ul>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface","title":"<code>BuilderInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.builders.plugin.interface import BuilderInterface\n\n\nclass SpecialBuilder(BuilderInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialBuilder\n\n\n@hookimpl\ndef hatch_register_builder():\n    return SpecialBuilder\n</code></pre> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>class BuilderInterface(ABC, Generic[BuilderConfigBound, PluginManagerBound]):\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.builders.plugin.interface import BuilderInterface\n\n\n    class SpecialBuilder(BuilderInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialBuilder\n\n\n    @hookimpl\n    def hatch_register_builder():\n        return SpecialBuilder\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(\n        self,\n        root: str,\n        plugin_manager: PluginManagerBound | None = None,\n        config: dict[str, Any] | None = None,\n        metadata: ProjectMetadata | None = None,\n        app: Application | None = None,\n    ) -&gt; None:\n        self.__root = root\n        self.__plugin_manager = cast(PluginManagerBound, plugin_manager)\n        self.__raw_config = config\n        self.__metadata = metadata\n        self.__app = app\n        self.__config = cast(BuilderConfigBound, None)\n        self.__project_config: dict[str, Any] | None = None\n        self.__hatch_config: dict[str, Any] | None = None\n        self.__build_config: dict[str, Any] | None = None\n        self.__build_targets: list[str] | None = None\n        self.__target_config: dict[str, Any] | None = None\n\n        # Metadata\n        self.__project_id: str | None = None\n\n    def build(\n        self,\n        *,\n        directory: str | None = None,\n        versions: list[str] | None = None,\n        hooks_only: bool | None = None,\n        clean: bool | None = None,\n        clean_hooks_after: bool | None = None,\n        clean_only: bool | None = False,\n    ) -&gt; Generator[str, None, None]:\n        # Fail early for invalid project metadata\n        self.metadata.validate_fields()\n\n        if directory is None:\n            directory = (\n                self.config.normalize_build_directory(os.environ[BuildEnvVars.LOCATION])\n                if BuildEnvVars.LOCATION in os.environ\n                else self.config.directory\n            )\n\n        if not os.path.isdir(directory):\n            os.makedirs(directory)\n\n        version_api = self.get_version_api()\n\n        versions = versions or self.config.versions\n        if versions:\n            unknown_versions = set(versions) - set(version_api)\n            if unknown_versions:\n                message = (\n                    f'Unknown versions for target `{self.PLUGIN_NAME}`: {\", \".join(map(str, sorted(unknown_versions)))}'\n                )\n                raise ValueError(message)\n\n        if hooks_only is None:\n            hooks_only = env_var_enabled(BuildEnvVars.HOOKS_ONLY)\n\n        configured_build_hooks = self.get_build_hooks(directory)\n        build_hooks = list(configured_build_hooks.values())\n\n        if clean_only:\n            clean = True\n        elif clean is None:\n            clean = env_var_enabled(BuildEnvVars.CLEAN)\n        if clean:\n            if not hooks_only:\n                self.clean(directory, versions)\n\n            for build_hook in build_hooks:\n                build_hook.clean(versions)\n\n            if clean_only:\n                return\n\n        if clean_hooks_after is None:\n            clean_hooks_after = env_var_enabled(BuildEnvVars.CLEAN_HOOKS_AFTER)\n\n        for version in versions:\n            self.app.display_debug(f'Building `{self.PLUGIN_NAME}` version `{version}`')\n\n            build_data = self.get_default_build_data()\n            self.set_build_data_defaults(build_data)\n\n            # Allow inspection of configured build hooks and the order in which they run\n            build_data['build_hooks'] = tuple(configured_build_hooks)\n\n            # Execute all `initialize` build hooks\n            for build_hook in build_hooks:\n                build_hook.initialize(version, build_data)\n\n            if hooks_only:\n                self.app.display_debug(f'Only ran build hooks for `{self.PLUGIN_NAME}` version `{version}`')\n                continue\n\n            # Build the artifact\n            with self.config.set_build_data(build_data):\n                artifact = version_api[version](directory, **build_data)\n\n            # Execute all `finalize` build hooks\n            for build_hook in build_hooks:\n                build_hook.finalize(version, build_data, artifact)\n\n            if clean_hooks_after:\n                for build_hook in build_hooks:\n                    build_hook.clean([version])\n\n            yield artifact\n\n    def recurse_included_files(self) -&gt; Iterable[IncludedFile]:\n        \"\"\"\n        Returns a consistently generated series of file objects for every file that should be distributed. Each file\n        object has three `str` attributes:\n\n        - `path` - the absolute path\n        - `relative_path` - the path relative to the project root; will be an empty string for external files\n        - `distribution_path` - the path to be distributed as\n        \"\"\"\n        yield from self.recurse_selected_project_files()\n        yield from self.recurse_forced_files(self.config.get_force_include())\n\n    def recurse_selected_project_files(self) -&gt; Iterable[IncludedFile]:\n        if self.config.only_include:\n            yield from self.recurse_explicit_files(self.config.only_include)\n        else:\n            yield from self.recurse_project_files()\n\n    def recurse_project_files(self) -&gt; Iterable[IncludedFile]:\n        for root, dirs, files in safe_walk(self.root):\n            relative_path = get_relative_path(root, self.root)\n\n            dirs[:] = sorted(d for d in dirs if not self.config.directory_is_excluded(d, relative_path))\n\n            files.sort()\n            is_package = '__init__.py' in files\n            for f in files:\n                if f in EXCLUDED_FILES:\n                    continue\n\n                relative_file_path = os.path.join(relative_path, f)\n                distribution_path = self.config.get_distribution_path(relative_file_path)\n                if self.config.path_is_reserved(distribution_path):\n                    continue\n\n                if self.config.include_path(relative_file_path, is_package=is_package):\n                    yield IncludedFile(\n                        os.path.join(root, f), relative_file_path, self.config.get_distribution_path(relative_file_path)\n                    )\n\n    def recurse_forced_files(self, inclusion_map: dict[str, str]) -&gt; Iterable[IncludedFile]:\n        for source, target_path in inclusion_map.items():\n            external = not source.startswith(self.root)\n            if os.path.isfile(source):\n                yield IncludedFile(\n                    source,\n                    '' if external else os.path.relpath(source, self.root),\n                    self.config.get_distribution_path(target_path),\n                )\n            elif os.path.isdir(source):\n                for root, dirs, files in safe_walk(source):\n                    relative_directory = get_relative_path(root, source)\n\n                    dirs[:] = sorted(d for d in dirs if d not in EXCLUDED_DIRECTORIES)\n\n                    files.sort()\n                    for f in files:\n                        if f in EXCLUDED_FILES:\n                            continue\n\n                        relative_file_path = os.path.join(target_path, relative_directory, f)\n                        distribution_path = self.config.get_distribution_path(relative_file_path)\n                        if not self.config.path_is_reserved(distribution_path):\n                            yield IncludedFile(\n                                os.path.join(root, f),\n                                '' if external else relative_file_path,\n                                distribution_path,\n                            )\n            else:\n                msg = f'Forced include not found: {source}'\n                raise FileNotFoundError(msg)\n\n    def recurse_explicit_files(self, inclusion_map: dict[str, str]) -&gt; Iterable[IncludedFile]:\n        for source, target_path in inclusion_map.items():\n            external = not source.startswith(self.root)\n            if os.path.isfile(source):\n                distribution_path = self.config.get_distribution_path(target_path)\n                if not self.config.path_is_reserved(distribution_path):\n                    yield IncludedFile(\n                        source,\n                        '' if external else os.path.relpath(source, self.root),\n                        self.config.get_distribution_path(target_path),\n                    )\n            elif os.path.isdir(source):\n                for root, dirs, files in safe_walk(source):\n                    relative_directory = get_relative_path(root, source)\n\n                    dirs[:] = sorted(d for d in dirs if d not in EXCLUDED_DIRECTORIES)\n\n                    files.sort()\n                    is_package = '__init__.py' in files\n                    for f in files:\n                        if f in EXCLUDED_FILES:\n                            continue\n\n                        relative_file_path = os.path.join(target_path, relative_directory, f)\n                        distribution_path = self.config.get_distribution_path(relative_file_path)\n                        if self.config.path_is_reserved(distribution_path):\n                            continue\n\n                        if self.config.include_path(relative_file_path, explicit=True, is_package=is_package):\n                            yield IncludedFile(\n                                os.path.join(root, f), '' if external else relative_file_path, distribution_path\n                            )\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree.\n        \"\"\"\n        return self.__root\n\n    @property\n    def plugin_manager(self) -&gt; PluginManagerBound:\n        if self.__plugin_manager is None:\n            from hatchling.plugin.manager import PluginManager\n\n            self.__plugin_manager = PluginManager()\n\n        return self.__plugin_manager\n\n    @property\n    def metadata(self) -&gt; ProjectMetadata:\n        if self.__metadata is None:\n            from hatchling.metadata.core import ProjectMetadata\n\n            self.__metadata = ProjectMetadata(self.root, self.plugin_manager, self.__raw_config)\n\n        return self.__metadata\n\n    @property\n    def app(self) -&gt; Application:\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        if self.__app is None:\n            from hatchling.bridge.app import Application\n\n            self.__app = cast(Application, Application().get_safe_application())\n\n        return self.__app\n\n    @property\n    def raw_config(self) -&gt; dict[str, Any]:\n        if self.__raw_config is None:\n            self.__raw_config = self.metadata.config\n\n        return self.__raw_config\n\n    @property\n    def project_config(self) -&gt; dict[str, Any]:\n        if self.__project_config is None:\n            self.__project_config = self.metadata.core.config\n\n        return self.__project_config\n\n    @property\n    def hatch_config(self) -&gt; dict[str, Any]:\n        if self.__hatch_config is None:\n            self.__hatch_config = self.metadata.hatch.config\n\n        return self.__hatch_config\n\n    @property\n    def config(self) -&gt; BuilderConfigBound:\n        \"\"\"\n        An instance of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n        \"\"\"\n        if self.__config is None:\n            self.__config = self.get_config_class()(\n                self, self.root, self.PLUGIN_NAME, self.build_config, self.target_config\n            )\n\n        return self.__config\n\n    @property\n    def build_config(self) -&gt; dict[str, Any]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.build]\n        ```\n        \"\"\"\n        if self.__build_config is None:\n            self.__build_config = self.metadata.hatch.build_config\n\n        return self.__build_config\n\n    @property\n    def target_config(self) -&gt; dict[str, Any]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.build.targets.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        if self.__target_config is None:\n            target_config: dict[str, Any] = self.metadata.hatch.build_targets.get(self.PLUGIN_NAME, {})\n            if not isinstance(target_config, dict):\n                message = f'Field `tool.hatch.build.targets.{self.PLUGIN_NAME}` must be a table'\n                raise TypeError(message)\n\n            self.__target_config = target_config\n\n        return self.__target_config\n\n    @property\n    def project_id(self) -&gt; str:\n        if self.__project_id is None:\n            self.__project_id = f'{self.normalize_file_name_component(self.metadata.core.name)}-{self.metadata.version}'\n\n        return self.__project_id\n\n    def get_build_hooks(self, directory: str) -&gt; dict[str, BuildHookInterface]:\n        configured_build_hooks = {}\n        for hook_name, config in self.config.hook_config.items():\n            build_hook = self.plugin_manager.build_hook.get(hook_name)\n            if build_hook is None:\n                from hatchling.plugin.exceptions import UnknownPluginError\n\n                message = f'Unknown build hook: {hook_name}'\n                raise UnknownPluginError(message)\n\n            configured_build_hooks[hook_name] = build_hook(\n                self.root, config, self.config, self.metadata, directory, self.PLUGIN_NAME, self.app\n            )\n\n        return configured_build_hooks\n\n    @abstractmethod\n    def get_version_api(self) -&gt; dict[str, Callable]:\n        \"\"\"\n        A mapping of `str` versions to a callable that is used for building.\n        Each callable must have the following signature:\n\n        ```python\n        def ...(build_dir: str, build_data: dict) -&gt; str:\n        ```\n\n        The return value must be the absolute path to the built artifact.\n        \"\"\"\n\n    def get_default_versions(self) -&gt; list[str]:\n        \"\"\"\n        A list of versions to build when users do not specify any, defaulting to all versions.\n        \"\"\"\n        return list(self.get_version_api())\n\n    def get_default_build_data(self) -&gt; dict[str, Any]:  # noqa: PLR6301\n        \"\"\"\n        A mapping that can be modified by [build hooks](../build-hook/reference.md) to influence the behavior of builds.\n        \"\"\"\n        return {}\n\n    def set_build_data_defaults(self, build_data: dict[str, Any]) -&gt; None:  # noqa: PLR6301\n        build_data.setdefault('artifacts', [])\n        build_data.setdefault('force_include', {})\n\n    def clean(self, directory: str, versions: list[str]) -&gt; None:\n        \"\"\"\n        Called before builds if the `-c`/`--clean` flag was passed to the\n        [`build`](../../cli/reference.md#hatch-build) command.\n        \"\"\"\n\n    @classmethod\n    def get_config_class(cls) -&gt; type[BuilderConfig]:\n        \"\"\"\n        Must return a subclass of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n        \"\"\"\n        return BuilderConfig\n\n    @staticmethod\n    def normalize_file_name_component(file_name: str) -&gt; str:\n        \"\"\"\n        https://peps.python.org/pep-0427/#escaping-and-unicode\n        \"\"\"\n        return re.sub(r'[^\\w\\d.]+', '_', file_name, flags=re.UNICODE)\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.app","title":"<code>app: Application</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.build_config","title":"<code>build_config: dict[str, Any]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.build]\n</code></pre> <pre><code>[build]\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.target_config","title":"<code>target_config: dict[str, Any]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[build.targets.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.config","title":"<code>config: BuilderConfigBound</code>  <code>property</code>","text":"<p>An instance of BuilderConfig.</p>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_config_class","title":"<code>get_config_class() -&gt; type[BuilderConfig]</code>  <code>classmethod</code>","text":"<p>Must return a subclass of BuilderConfig.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>@classmethod\ndef get_config_class(cls) -&gt; type[BuilderConfig]:\n    \"\"\"\n    Must return a subclass of [BuilderConfig](../utilities.md#hatchling.builders.config.BuilderConfig).\n    \"\"\"\n    return BuilderConfig\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_version_api","title":"<code>get_version_api() -&gt; dict[str, Callable]</code>  <code>abstractmethod</code>","text":"<p>A mapping of <code>str</code> versions to a callable that is used for building. Each callable must have the following signature:</p> <pre><code>def ...(build_dir: str, build_data: dict) -&gt; str:\n</code></pre> <p>The return value must be the absolute path to the built artifact.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>@abstractmethod\ndef get_version_api(self) -&gt; dict[str, Callable]:\n    \"\"\"\n    A mapping of `str` versions to a callable that is used for building.\n    Each callable must have the following signature:\n\n    ```python\n    def ...(build_dir: str, build_data: dict) -&gt; str:\n    ```\n\n    The return value must be the absolute path to the built artifact.\n    \"\"\"\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_default_versions","title":"<code>get_default_versions() -&gt; list[str]</code>","text":"<p>A list of versions to build when users do not specify any, defaulting to all versions.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def get_default_versions(self) -&gt; list[str]:\n    \"\"\"\n    A list of versions to build when users do not specify any, defaulting to all versions.\n    \"\"\"\n    return list(self.get_version_api())\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.clean","title":"<code>clean(directory: str, versions: list[str]) -&gt; None</code>","text":"<p>Called before builds if the <code>-c</code>/<code>--clean</code> flag was passed to the <code>build</code> command.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def clean(self, directory: str, versions: list[str]) -&gt; None:\n    \"\"\"\n    Called before builds if the `-c`/`--clean` flag was passed to the\n    [`build`](../../cli/reference.md#hatch-build) command.\n    \"\"\"\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.recurse_included_files","title":"<code>recurse_included_files() -&gt; Iterable[IncludedFile]</code>","text":"<p>Returns a consistently generated series of file objects for every file that should be distributed. Each file object has three <code>str</code> attributes:</p> <ul> <li><code>path</code> - the absolute path</li> <li><code>relative_path</code> - the path relative to the project root; will be an empty string for external files</li> <li><code>distribution_path</code> - the path to be distributed as</li> </ul> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def recurse_included_files(self) -&gt; Iterable[IncludedFile]:\n    \"\"\"\n    Returns a consistently generated series of file objects for every file that should be distributed. Each file\n    object has three `str` attributes:\n\n    - `path` - the absolute path\n    - `relative_path` - the path relative to the project root; will be an empty string for external files\n    - `distribution_path` - the path to be distributed as\n    \"\"\"\n    yield from self.recurse_selected_project_files()\n    yield from self.recurse_forced_files(self.config.get_force_include())\n</code></pre>"},{"location":"plugins/builder/reference/#hatchling.builders.plugin.interface.BuilderInterface.get_default_build_data","title":"<code>get_default_build_data() -&gt; dict[str, Any]</code>","text":"<p>A mapping that can be modified by build hooks to influence the behavior of builds.</p> Source code in <code>backend/src/hatchling/builders/plugin/interface.py</code> <pre><code>def get_default_build_data(self) -&gt; dict[str, Any]:  # noqa: PLR6301\n    \"\"\"\n    A mapping that can be modified by [build hooks](../build-hook/reference.md) to influence the behavior of builds.\n    \"\"\"\n    return {}\n</code></pre>"},{"location":"plugins/builder/sdist/","title":"Source distribution builder","text":"<p>A source distribution, or <code>sdist</code>, is an archive of Python \"source code\". Although largely unspecified, by convention it should include everything that is required to build a wheel without making network requests.</p>"},{"location":"plugins/builder/sdist/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>sdist</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.sdist]\n</code></pre> <pre><code>[build.targets.sdist]\n</code></pre>"},{"location":"plugins/builder/sdist/#options","title":"Options","text":"Option Default Description <code>core-metadata-version</code> <code>\"2.3\"</code> The version of core metadata to use <code>strict-naming</code> <code>true</code> Whether or not file names should contain the normalized version of the project name <code>support-legacy</code> <code>false</code> Whether or not to include a <code>setup.py</code> file to support legacy installation mechanisms"},{"location":"plugins/builder/sdist/#versions","title":"Versions","text":"Version Description <code>standard</code> (default) The latest conventional format"},{"location":"plugins/builder/sdist/#default-file-selection","title":"Default file selection","text":"<p>When the user has not set any file selection options, all files that are not ignored by your VCS will be included.</p> <p>Note</p> <p>The following files are always included and cannot be excluded:</p> <ul> <li><code>/pyproject.toml</code></li> <li><code>/hatch.toml</code></li> <li><code>/hatch_build.py</code></li> <li><code>/.gitignore</code> or <code>/.hgignore</code></li> <li>Any defined <code>readme</code> file</li> <li>All defined <code>license-files</code></li> </ul>"},{"location":"plugins/builder/sdist/#reproducibility","title":"Reproducibility","text":"<p>Reproducible builds are supported.</p>"},{"location":"plugins/builder/sdist/#build-data","title":"Build data","text":"<p>This is data that can be modified by build hooks.</p> Data Default Description <code>dependencies</code> Extra project dependencies"},{"location":"plugins/builder/wheel/","title":"Wheel builder","text":"<p>A wheel is a binary distribution of a Python package that can be installed directly into an environment.</p>"},{"location":"plugins/builder/wheel/#configuration","title":"Configuration","text":"<p>The builder plugin name is <code>wheel</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.build.targets.wheel]\n</code></pre> <pre><code>[build.targets.wheel]\n</code></pre>"},{"location":"plugins/builder/wheel/#options","title":"Options","text":"Option Default Description <code>core-metadata-version</code> <code>\"2.3\"</code> The version of core metadata to use <code>shared-data</code> A mapping similar to the forced inclusion option corresponding to data that will be installed globally in a given Python environment, usually under <code>sys.prefix</code> <code>extra-metadata</code> A mapping similar to the forced inclusion option corresponding to extra metadata that will be shipped in a directory named <code>extra_metadata</code> <code>strict-naming</code> <code>true</code> Whether or not file names should contain the normalized version of the project name <code>macos-max-compat</code> <code>true</code> Whether or not on macOS, when build hooks have set the <code>infer_tag</code> build data, the wheel name should signal broad support rather than specific versions for newer SDK versions.Note: The default will become <code>false</code>, and this option eventually removed, sometime after consumers like pip start supporting these newer SDK versions. <code>bypass-selection</code> <code>false</code> Whether or not to suppress the error when one has not defined any file selection options and all heuristics have failed to determine what to ship"},{"location":"plugins/builder/wheel/#versions","title":"Versions","text":"Version Description <code>standard</code> (default) The latest standardized format <code>editable</code> A wheel that only ships <code>.pth</code> files or import hooks for real-time development"},{"location":"plugins/builder/wheel/#default-file-selection","title":"Default file selection","text":"<p>When the user has not set any file selection options, the project name will be used to determine the package to ship in the following heuristic order:</p> <ol> <li><code>&lt;NAME&gt;/__init__.py</code></li> <li><code>src/&lt;NAME&gt;/__init__.py</code></li> <li><code>&lt;NAME&gt;.py</code></li> <li><code>&lt;NAMESPACE&gt;/&lt;NAME&gt;/__init__.py</code></li> </ol> <p>If none of these heuristics are satisfied, an error will be raised.</p>"},{"location":"plugins/builder/wheel/#reproducibility","title":"Reproducibility","text":"<p>Reproducible builds are supported.</p>"},{"location":"plugins/builder/wheel/#build-data","title":"Build data","text":"<p>This is data that can be modified by build hooks.</p> Data Default Description <code>tag</code> The full tag part of the filename (e.g. <code>py3-none-any</code>), defaulting to a cross-platform wheel with the supported major versions of Python based on project metadata <code>infer_tag</code> <code>False</code> When <code>tag</code> is not set, this may be enabled to use the one most specific to the platform, Python interpreter, and ABI <code>pure_python</code> <code>True</code> Whether or not to write metadata indicating that the package does not contain any platform-specific files <code>dependencies</code> Extra project dependencies <code>extra_metadata</code> Additional <code>extra-metadata</code> entries, which take precedence in case of conflicts <code>force_include_editable</code> Similar to the <code>force_include</code> option but specifically for the <code>editable</code> version and takes precedence"},{"location":"plugins/environment/reference/","title":"Environment plugins","text":"<p>See the documentation for environment configuration.</p>"},{"location":"plugins/environment/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-conda - environments backed by Conda/Mamba</li> <li>hatch-containers - environments run inside containers</li> <li>hatch-pip-compile - use pip-compile to manage project dependencies and lockfiles</li> <li>hatch-pip-deepfreeze - virtual environments with dependency locking by pip-deepfreeze</li> </ul>"},{"location":"plugins/environment/reference/#installation","title":"Installation","text":"<p>Any required environment types that are not built-in must be manually installed alongside Hatch or listed in the <code>tool.hatch.env.requires</code> array for automatic management:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env]\nrequires = [\n  \"...\",\n]\n</code></pre> <pre><code>[env]\nrequires = [\n  \"...\",\n]\n</code></pre>"},{"location":"plugins/environment/reference/#life-cycle","title":"Life cycle","text":"<p>Whenever an environment is used, the following logic is performed:</p> Source code in <code>src/hatch/cli/application.py</code> <pre><code>def prepare_environment(self, environment: EnvironmentInterface):\n    if not environment.exists():\n        self.env_metadata.reset(environment)\n\n        with environment.app_status_creation():\n            environment.create()\n\n        if not environment.skip_install:\n            if environment.pre_install_commands:\n                with environment.app_status_pre_installation():\n                    self.run_shell_commands(environment, environment.pre_install_commands, source='pre-install')\n\n            with environment.app_status_project_installation():\n                if environment.dev_mode:\n                    environment.install_project_dev_mode()\n                else:\n                    environment.install_project()\n\n            if environment.post_install_commands:\n                with environment.app_status_post_installation():\n                    self.run_shell_commands(environment, environment.post_install_commands, source='post-install')\n\n    with environment.app_status_dependency_state_check():\n        new_dep_hash = environment.dependency_hash()\n\n    current_dep_hash = self.env_metadata.dependency_hash(environment)\n    if new_dep_hash != current_dep_hash:\n        with environment.app_status_dependency_installation_check():\n            dependencies_in_sync = environment.dependencies_in_sync()\n\n        if not dependencies_in_sync:\n            with environment.app_status_dependency_synchronization():\n                environment.sync_dependencies()\n                new_dep_hash = environment.dependency_hash()\n\n        self.env_metadata.update_dependency_hash(environment, new_dep_hash)\n</code></pre>"},{"location":"plugins/environment/reference/#build-environments","title":"Build environments","text":"<p>All environment types should offer support for a special sub-environment in which projects can be built. This environment is used in the following scenarios:</p> <ul> <li>the <code>build</code> command</li> <li>commands that read dependencies, like <code>dep hash</code>, if any project dependencies are set dynamically</li> </ul>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface","title":"<code>EnvironmentInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>    from hatch.env.plugin.interface import EnvironmentInterface\n\n\n    class SpecialEnvironment(EnvironmentInterface):\n        PLUGIN_NAME = 'special'\n        ...\n</code></pre> <pre><code>    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialEnvironment\n\n\n    @hookimpl\n    def hatch_register_environment():\n        return SpecialEnvironment\n</code></pre> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>class EnvironmentInterface(ABC):\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n        from hatch.env.plugin.interface import EnvironmentInterface\n\n\n        class SpecialEnvironment(EnvironmentInterface):\n            PLUGIN_NAME = 'special'\n            ...\n    ```\n\n    ```python tab=\"hooks.py\"\n        from hatchling.plugin import hookimpl\n\n        from .plugin import SpecialEnvironment\n\n\n        @hookimpl\n        def hatch_register_environment():\n            return SpecialEnvironment\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(\n        self,\n        root,\n        metadata,\n        name,\n        config,\n        matrix_variables,\n        data_directory,\n        isolated_data_directory,\n        platform,\n        verbosity,\n        app=None,\n    ):\n        self.__root = root\n        self.__metadata = metadata\n        self.__name = name\n        self.__config = config\n        self.__matrix_variables = matrix_variables\n        self.__data_directory = data_directory\n        self.__isolated_data_directory = isolated_data_directory\n        self.__platform = platform\n        self.__verbosity = verbosity\n        self.__app = app\n        self.__context = None\n\n        self._system_python = None\n        self._env_vars = None\n        self._env_include = None\n        self._env_exclude = None\n        self._environment_dependencies_complex = None\n        self._environment_dependencies = None\n        self._dependencies_complex = None\n        self._dependencies = None\n        self._platforms = None\n        self._skip_install = None\n        self._dev_mode = None\n        self._features = None\n        self._description = None\n        self._scripts = None\n        self._pre_install_commands = None\n        self._post_install_commands = None\n\n    @property\n    def matrix_variables(self):\n        return self.__matrix_variables\n\n    @property\n    def app(self):\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        if self.__app is None:\n            from hatchling.bridge.app import Application\n\n            self.__app = Application().get_safe_application()\n\n        return self.__app\n\n    @property\n    def context(self):\n        if self.__context is None:\n            self.__context = self.get_context()\n\n        return self.__context\n\n    @property\n    def verbosity(self):\n        return self.__verbosity\n\n    @property\n    def root(self):\n        \"\"\"\n        The root of the project tree as a path-like object.\n        \"\"\"\n        return self.__root\n\n    @property\n    def metadata(self):\n        return self.__metadata\n\n    @property\n    def name(self) -&gt; str:\n        \"\"\"\n        The name of the environment.\n        \"\"\"\n        return self.__name\n\n    @property\n    def platform(self):\n        \"\"\"\n        An instance of [Platform](../utilities.md#hatch.utils.platform.Platform).\n        \"\"\"\n        return self.__platform\n\n    @property\n    def data_directory(self):\n        \"\"\"\n        The [directory](../../config/hatch.md#environments) this plugin should use for storage as a path-like object.\n        If the user has not configured one then this will be the same as the\n        [isolated data directory](reference.md#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory).\n        \"\"\"\n        return self.__data_directory\n\n    @property\n    def isolated_data_directory(self):\n        \"\"\"\n        The default [directory](../../config/hatch.md#environments) reserved exclusively for this plugin as a path-like\n        object.\n        \"\"\"\n        return self.__isolated_data_directory\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    @property\n    def system_python(self):\n        if self._system_python is None:\n            system_python = os.environ.get(AppEnvVars.PYTHON)\n            if system_python == 'self':\n                system_python = sys.executable\n\n            system_python = (\n                system_python\n                or self.platform.modules.shutil.which('python')\n                or self.platform.modules.shutil.which('python3')\n                or sys.executable\n            )\n            if not isabs(system_python):\n                system_python = self.platform.modules.shutil.which(system_python)\n\n            self._system_python = system_python\n\n        return self._system_python\n\n    @property\n    def env_vars(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;.env-vars]\n        ```\n        \"\"\"\n        if self._env_vars is None:\n            env_vars = self.config.get('env-vars', {})\n            if not isinstance(env_vars, dict):\n                message = f'Field `tool.hatch.envs.{self.name}.env-vars` must be a mapping'\n                raise TypeError(message)\n\n            for key, value in env_vars.items():\n                if not isinstance(value, str):\n                    message = (\n                        f'Environment variable `{key}` of field `tool.hatch.envs.{self.name}.env-vars` must be a string'\n                    )\n                    raise TypeError(message)\n\n            new_env_vars = {}\n            with self.metadata.context.apply_context(self.context):\n                for key, value in env_vars.items():\n                    new_env_vars[key] = self.metadata.context.format(value)\n\n            new_env_vars[AppEnvVars.ENV_ACTIVE] = self.name\n            self._env_vars = new_env_vars\n\n        return self._env_vars\n\n    @property\n    def env_include(self) -&gt; list[str]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        env-include = [...]\n        ```\n        \"\"\"\n        if self._env_include is None:\n            env_include = self.config.get('env-include', [])\n            if not isinstance(env_include, list):\n                message = f'Field `tool.hatch.envs.{self.name}.env-include` must be an array'\n                raise TypeError(message)\n\n            for i, pattern in enumerate(env_include, 1):\n                if not isinstance(pattern, str):\n                    message = f'Pattern #{i} of field `tool.hatch.envs.{self.name}.env-include` must be a string'\n                    raise TypeError(message)\n\n            if env_include:\n                self._env_include = ['HATCH_BUILD_*', *env_include]\n            else:\n                self._env_include = env_include\n\n        return self._env_include\n\n    @property\n    def env_exclude(self) -&gt; list[str]:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        env-exclude = [...]\n        ```\n        \"\"\"\n        if self._env_exclude is None:\n            env_exclude = self.config.get('env-exclude', [])\n            if not isinstance(env_exclude, list):\n                message = f'Field `tool.hatch.envs.{self.name}.env-exclude` must be an array'\n                raise TypeError(message)\n\n            for i, pattern in enumerate(env_exclude, 1):\n                if not isinstance(pattern, str):\n                    message = f'Pattern #{i} of field `tool.hatch.envs.{self.name}.env-exclude` must be a string'\n                    raise TypeError(message)\n\n            self._env_exclude = env_exclude\n\n        return self._env_exclude\n\n    @property\n    def environment_dependencies_complex(self):\n        if self._environment_dependencies_complex is None:\n            from packaging.requirements import InvalidRequirement, Requirement\n\n            dependencies_complex = []\n            with self.apply_context():\n                for option in ('dependencies', 'extra-dependencies'):\n                    dependencies = self.config.get(option, [])\n                    if not isinstance(dependencies, list):\n                        message = f'Field `tool.hatch.envs.{self.name}.{option}` must be an array'\n                        raise TypeError(message)\n\n                    for i, entry in enumerate(dependencies, 1):\n                        if not isinstance(entry, str):\n                            message = (\n                                f'Dependency #{i} of field `tool.hatch.envs.{self.name}.{option}` must be a string'\n                            )\n                            raise TypeError(message)\n\n                        try:\n                            dependencies_complex.append(Requirement(self.metadata.context.format(entry)))\n                        except InvalidRequirement as e:\n                            message = f'Dependency #{i} of field `tool.hatch.envs.{self.name}.{option}` is invalid: {e}'\n                            raise ValueError(message) from None\n\n            self._environment_dependencies_complex = dependencies_complex\n\n        return self._environment_dependencies_complex\n\n    @property\n    def environment_dependencies(self) -&gt; list[str]:\n        \"\"\"\n        The list of all [environment dependencies](../../config/environment/overview.md#dependencies).\n        \"\"\"\n        if self._environment_dependencies is None:\n            self._environment_dependencies = [str(dependency) for dependency in self.environment_dependencies_complex]\n\n        return self._environment_dependencies\n\n    @property\n    def dependencies_complex(self):\n        if self._dependencies_complex is None:\n            all_dependencies_complex = list(self.environment_dependencies_complex)\n\n            # Ensure these are checked last to speed up initial environment creation since\n            # they will already be installed along with the project\n            if (not self.skip_install and self.dev_mode) or self.features:\n                from hatch.utils.dep import get_project_dependencies_complex\n\n                dependencies_complex, optional_dependencies_complex = get_project_dependencies_complex(self)\n\n                if not self.skip_install and self.dev_mode:\n                    all_dependencies_complex.extend(dependencies_complex.values())\n\n                for feature in self.features:\n                    if feature not in optional_dependencies_complex:\n                        message = (\n                            f'Feature `{feature}` of field `tool.hatch.envs.{self.name}.features` is not '\n                            f'defined in the dynamic field `project.optional-dependencies`'\n                        )\n                        raise ValueError(message)\n\n                    all_dependencies_complex.extend(optional_dependencies_complex[feature].values())\n\n            self._dependencies_complex = all_dependencies_complex\n\n        return self._dependencies_complex\n\n    @property\n    def dependencies(self) -&gt; list[str]:\n        \"\"\"\n        The list of all [project dependencies](../../config/metadata.md#dependencies) (if\n        [installed](../../config/environment/overview.md#skip-install) and in\n        [dev mode](../../config/environment/overview.md#dev-mode)), selected\n        [optional dependencies](../../config/environment/overview.md#features), and\n        [environment dependencies](../../config/environment/overview.md#dependencies).\n        \"\"\"\n        if self._dependencies is None:\n            self._dependencies = [str(dependency) for dependency in self.dependencies_complex]\n\n        return self._dependencies\n\n    @property\n    def platforms(self) -&gt; list[str]:\n        \"\"\"\n        All names are stored as their lower-cased version.\n\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        platforms = [...]\n        ```\n        \"\"\"\n        if self._platforms is None:\n            platforms = self.config.get('platforms', [])\n            if not isinstance(platforms, list):\n                message = f'Field `tool.hatch.envs.{self.name}.platforms` must be an array'\n                raise TypeError(message)\n\n            for i, command in enumerate(platforms, 1):\n                if not isinstance(command, str):\n                    message = f'Platform #{i} of field `tool.hatch.envs.{self.name}.platforms` must be a string'\n                    raise TypeError(message)\n\n            self._platforms = [platform.lower() for platform in platforms]\n\n        return self._platforms\n\n    @property\n    def skip_install(self) -&gt; bool:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        skip-install = ...\n        ```\n        \"\"\"\n        if self._skip_install is None:\n            skip_install = self.config.get('skip-install', not self.metadata.has_project_file())\n            if not isinstance(skip_install, bool):\n                message = f'Field `tool.hatch.envs.{self.name}.skip-install` must be a boolean'\n                raise TypeError(message)\n\n            self._skip_install = skip_install\n\n        return self._skip_install\n\n    @property\n    def dev_mode(self) -&gt; bool:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        dev-mode = ...\n        ```\n        \"\"\"\n        if self._dev_mode is None:\n            dev_mode = self.config.get('dev-mode', True)\n            if not isinstance(dev_mode, bool):\n                message = f'Field `tool.hatch.envs.{self.name}.dev-mode` must be a boolean'\n                raise TypeError(message)\n\n            self._dev_mode = dev_mode\n\n        return self._dev_mode\n\n    @property\n    def features(self):\n        if self._features is None:\n            from hatchling.metadata.utils import normalize_project_name\n\n            features = self.config.get('features', [])\n            if not isinstance(features, list):\n                message = f'Field `tool.hatch.envs.{self.name}.features` must be an array of strings'\n                raise TypeError(message)\n\n            all_features = set()\n            for i, feature in enumerate(features, 1):\n                if not isinstance(feature, str):\n                    message = f'Feature #{i} of field `tool.hatch.envs.{self.name}.features` must be a string'\n                    raise TypeError(message)\n\n                if not feature:\n                    message = f'Feature #{i} of field `tool.hatch.envs.{self.name}.features` cannot be an empty string'\n                    raise ValueError(message)\n\n                normalized_feature = (\n                    feature\n                    if self.metadata.hatch.metadata.allow_ambiguous_features\n                    else normalize_project_name(feature)\n                )\n                if (\n                    not self.metadata.hatch.metadata.hook_config\n                    and normalized_feature not in self.metadata.core.optional_dependencies\n                ):\n                    message = (\n                        f'Feature `{normalized_feature}` of field `tool.hatch.envs.{self.name}.features` is not '\n                        f'defined in field `project.optional-dependencies`'\n                    )\n                    raise ValueError(message)\n\n                all_features.add(normalized_feature)\n\n            self._features = sorted(all_features)\n\n        return self._features\n\n    @property\n    def description(self) -&gt; str:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.envs.&lt;ENV_NAME&gt;]\n        description = ...\n        ```\n        \"\"\"\n        if self._description is None:\n            description = self.config.get('description', '')\n            if not isinstance(description, str):\n                message = f'Field `tool.hatch.envs.{self.name}.description` must be a string'\n                raise TypeError(message)\n\n            self._description = description\n\n        return self._description\n\n    @property\n    def scripts(self):\n        if self._scripts is None:\n            script_config = self.config.get('scripts', {})\n            if not isinstance(script_config, dict):\n                message = f'Field `tool.hatch.envs.{self.name}.scripts` must be a table'\n                raise TypeError(message)\n\n            config = {}\n\n            for name, data in script_config.items():\n                if ' ' in name:\n                    message = (\n                        f'Script name `{name}` in field `tool.hatch.envs.{self.name}.scripts` must not contain spaces'\n                    )\n                    raise ValueError(message)\n\n                commands = []\n\n                if isinstance(data, str):\n                    commands.append(data)\n                elif isinstance(data, list):\n                    for i, command in enumerate(data, 1):\n                        if not isinstance(command, str):\n                            message = (\n                                f'Command #{i} in field `tool.hatch.envs.{self.name}.scripts.{name}` must be a string'\n                            )\n                            raise TypeError(message)\n\n                        commands.append(command)\n                else:\n                    message = (\n                        f'Field `tool.hatch.envs.{self.name}.scripts.{name}` must be a string or an array of strings'\n                    )\n                    raise TypeError(message)\n\n                config[name] = commands\n\n            seen = {}\n            active = []\n            for script_name, commands in config.items():\n                commands[:] = expand_script_commands(self.name, script_name, commands, config, seen, active)\n\n            self._scripts = config\n\n        return self._scripts\n\n    @property\n    def pre_install_commands(self):\n        if self._pre_install_commands is None:\n            pre_install_commands = self.config.get('pre-install-commands', [])\n            if not isinstance(pre_install_commands, list):\n                message = f'Field `tool.hatch.envs.{self.name}.pre-install-commands` must be an array'\n                raise TypeError(message)\n\n            for i, command in enumerate(pre_install_commands, 1):\n                if not isinstance(command, str):\n                    message = (\n                        f'Command #{i} of field `tool.hatch.envs.{self.name}.pre-install-commands` must be a string'\n                    )\n                    raise TypeError(message)\n\n            self._pre_install_commands = list(pre_install_commands)\n\n        return self._pre_install_commands\n\n    @property\n    def post_install_commands(self):\n        if self._post_install_commands is None:\n            post_install_commands = self.config.get('post-install-commands', [])\n            if not isinstance(post_install_commands, list):\n                message = f'Field `tool.hatch.envs.{self.name}.post-install-commands` must be an array'\n                raise TypeError(message)\n\n            for i, command in enumerate(post_install_commands, 1):\n                if not isinstance(command, str):\n                    message = (\n                        f'Command #{i} of field `tool.hatch.envs.{self.name}.post-install-commands` must be a string'\n                    )\n                    raise TypeError(message)\n\n            self._post_install_commands = list(post_install_commands)\n\n        return self._post_install_commands\n\n    def activate(self):\n        \"\"\"\n        A convenience method called when using the environment as a context manager:\n\n        ```python\n        with environment:\n            ...\n        ```\n        \"\"\"\n\n    def deactivate(self):\n        \"\"\"\n        A convenience method called after using the environment as a context manager:\n\n        ```python\n        with environment:\n            ...\n        ```\n        \"\"\"\n\n    @abstractmethod\n    def find(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should return information about how to locate the environment or represent its ID in\n        some way. Additionally, this is expected to return something even if the environment is\n        [incompatible](reference.md#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility).\n        \"\"\"\n\n    @abstractmethod\n    def create(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should perform the necessary steps to set up the environment.\n        \"\"\"\n\n    @abstractmethod\n    def remove(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should perform the necessary steps to completely remove the environment from the system and will only\n        be triggered manually by users with the [`env remove`](../../cli/reference.md#hatch-env-remove) or\n        [`env prune`](../../cli/reference.md#hatch-env-prune) commands.\n\n        If the\n        [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n        has a caching mechanism, this should remove that as well.\n        \"\"\"\n\n    @abstractmethod\n    def exists(self) -&gt; bool:\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should indicate whether or not the environment has already been created.\n        \"\"\"\n\n    @abstractmethod\n    def install_project(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should install the project in the environment.\n        \"\"\"\n\n    @abstractmethod\n    def install_project_dev_mode(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should install the project in the environment such that the environment\n        always reflects the current state of the project.\n        \"\"\"\n\n    @abstractmethod\n    def dependencies_in_sync(self) -&gt; bool:\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should indicate whether or not the environment is compatible with the current\n        [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies).\n        \"\"\"\n\n    @abstractmethod\n    def sync_dependencies(self):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This should install the\n        [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n        in the environment.\n        \"\"\"\n\n    def dependency_hash(self):\n        \"\"\"\n        This should return a hash of the environment's\n        [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n        and any other data that is handled by the\n        [sync_dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies)\n        and\n        [dependencies_in_sync](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync)\n        methods.\n        \"\"\"\n        from hatch.utils.dep import hash_dependencies\n\n        return hash_dependencies(self.dependencies_complex)\n\n    @contextmanager\n    def app_status_creation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status(f'Creating environment: {self.name}'):\n            yield\n\n    @contextmanager\n    def app_status_pre_installation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Running pre-installation commands'):\n            yield\n\n    @contextmanager\n    def app_status_post_installation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Running post-installation commands'):\n            yield\n\n    @contextmanager\n    def app_status_project_installation(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        if self.dev_mode:\n            with self.app.status('Installing project in development mode'):\n                yield\n        else:\n            with self.app.status('Installing project'):\n                yield\n\n    @contextmanager\n    def app_status_dependency_state_check(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        if not self.skip_install and (\n            'dependencies' in self.metadata.dynamic or 'optional-dependencies' in self.metadata.dynamic\n        ):\n            with self.app.status('Polling dependency state'):\n                yield\n        else:\n            yield\n\n    @contextmanager\n    def app_status_dependency_installation_check(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Checking dependencies'):\n            yield\n\n    @contextmanager\n    def app_status_dependency_synchronization(self):\n        \"\"\"\n        See the [life cycle of environments](reference.md#life-cycle).\n        \"\"\"\n        with self.app.status('Syncing dependencies'):\n            yield\n\n    @contextmanager\n    def build_environment(\n        self,\n        dependencies: list[str],  # noqa: ARG002\n    ):\n        \"\"\"\n        This should set up an isolated environment in which to [`build`](../../cli/reference.md#hatch-build) the project\n        given a set of dependencies and must be a context manager:\n\n        ```python\n        with environment.build_environment([...]):\n            ...\n        ```\n\n        The build environment should reflect any\n        [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n        the user defined either currently or at the time of\n        [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n        \"\"\"\n        with self.get_env_vars():\n            yield\n\n    def run_builder(\n        self,\n        build_environment,  # noqa: ARG002\n        **kwargs,\n    ):\n        \"\"\"\n        This will be called when the\n        [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n        is active:\n\n        ```python\n        with environment.build_environment([...]) as build_env:\n            process = environment.run_builder(build_env, ...)\n        ```\n\n        This should return the standard library's\n        [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess).\n        The command is constructed by passing all keyword arguments to\n        [construct_build_command](reference.md#hatch.env.plugin.interface.EnvironmentInterface.construct_build_command).\n\n        For an example, open the default implementation below:\n        \"\"\"\n        return self.platform.run_command(self.construct_build_command(**kwargs))\n\n    def build_environment_exists(self):  # noqa: PLR6301\n        \"\"\"\n        If the\n        [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n        has a caching mechanism, this should indicate whether or not it has already been created.\n        \"\"\"\n        return False\n\n    def enter_shell(\n        self,\n        name: str,  # noqa: ARG002\n        path: str,\n        args: Iterable[str],\n    ):\n        \"\"\"\n        Spawn a [shell](../../config/hatch.md#shell) within the environment.\n\n        This should either use\n        [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n        directly or provide the same guarantee.\n        \"\"\"\n        with self.command_context():\n            self.platform.exit_with_command([path, *args])\n\n    def run_shell_command(self, command: str, **kwargs):\n        \"\"\"\n        This should return the standard library's\n        [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess)\n        and will always be called when the\n        [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n        is active, with the expectation of providing the same guarantee.\n        \"\"\"\n        kwargs.setdefault('shell', True)\n        return self.platform.run_command(command, **kwargs)\n\n    @contextmanager\n    def command_context(self):\n        \"\"\"\n        A context manager that when active should make executed shell commands reflect any\n        [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n        the user defined either currently or at the time of\n        [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n\n        For an example, open the default implementation below:\n        \"\"\"\n        with self.get_env_vars():\n            yield\n\n    def resolve_commands(self, commands: list[str]):\n        \"\"\"\n        This expands each command into one or more commands based on any\n        [scripts](../../config/environment/overview.md#scripts) that the user defined.\n        \"\"\"\n        for command in commands:\n            yield from self.expand_command(command)\n\n    def expand_command(self, command):\n        possible_script, args, _ignore_exit_code = parse_script_command(command)\n\n        # Indicate undefined\n        if not args:\n            args = None\n\n        with self.apply_context():\n            if possible_script in self.scripts:\n                for cmd in self.scripts[possible_script]:\n                    yield self.metadata.context.format(cmd, args=args).strip()\n            else:\n                yield self.metadata.context.format(command, args=args).strip()\n\n    def construct_build_command(  # noqa: PLR6301\n        self,\n        *,\n        directory=None,\n        targets=(),\n        hooks_only=False,\n        no_hooks=False,\n        clean=False,\n        clean_hooks_after=False,\n        clean_only=False,\n    ):\n        \"\"\"\n        This is the canonical way [`build`](../../cli/reference.md#hatch-build) command options are translated to\n        a subprocess command issued to [builders](../builder/reference.md).\n        \"\"\"\n        command = ['python', '-u', '-m', 'hatchling', 'build']\n\n        if directory:\n            command.extend(('--directory', directory))\n\n        if targets:\n            for target in targets:\n                command.extend(('--target', target))\n\n        if hooks_only:\n            command.append('--hooks-only')\n\n        if no_hooks:\n            command.append('--no-hooks')\n\n        if clean:\n            command.append('--clean')\n\n        if clean_hooks_after:\n            command.append('--clean-hooks-after')\n\n        if clean_only:\n            command.append('--clean-only')\n\n        return command\n\n    def construct_pip_install_command(self, args: list[str]):\n        \"\"\"\n        A convenience method for constructing a [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/)\n        command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.\n        \"\"\"\n        command = ['python', '-u', '-m', 'pip', 'install', '--disable-pip-version-check', '--no-python-version-warning']\n\n        # Default to -1 verbosity\n        add_verbosity_flag(command, self.verbosity, adjustment=-1)\n\n        command.extend(args)\n        return command\n\n    def join_command_args(self, args: list[str]):\n        \"\"\"\n        This is used by the [`run`](../../cli/reference.md#hatch-run) command to construct the root command string\n        from the received arguments.\n        \"\"\"\n        return self.platform.join_command_args(args)\n\n    def apply_features(self, requirement: str):\n        \"\"\"\n        A convenience method that applies any user defined [features](../../config/environment/overview.md#features)\n        to the given requirement.\n        \"\"\"\n        if self.features:\n            features = ','.join(self.features)\n            return f'{requirement}[{features}]'\n\n        return requirement\n\n    def check_compatibility(self):\n        \"\"\"\n        This raises an exception if the environment is not compatible with the user's setup. The default behavior\n        checks for [platform compatibility](../../config/environment/overview.md#supported-platforms)\n        and any method override should keep this check.\n\n        This check is never performed if the environment has been\n        [created](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n        \"\"\"\n        if self.platforms and self.platform.name not in self.platforms:\n            message = 'unsupported platform'\n            raise OSError(message)\n\n    def get_env_vars(self) -&gt; EnvVars:\n        \"\"\"\n        Returns a mapping of environment variables that should be available to the environment. The object can\n        be used as a context manager to temporarily apply the environment variables to the current process.\n\n        !!! note\n            The environment variable `HATCH_ENV_ACTIVE` will always be set to the name of the environment.\n        \"\"\"\n        return EnvVars(self.env_vars, self.env_include, self.env_exclude)\n\n    def get_env_var_option(self, option: str) -&gt; str:\n        \"\"\"\n        Returns the value of the upper-cased environment variable `HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;`.\n        \"\"\"\n        return os.environ.get(f'{AppEnvVars.ENV_OPTION_PREFIX}{self.PLUGIN_NAME}_{option}'.upper(), '')\n\n    def get_context(self):\n        \"\"\"\n        Returns a subclass of\n        [EnvironmentContextFormatter](../utilities.md#hatch.env.context.EnvironmentContextFormatter).\n        \"\"\"\n        from hatch.env.context import EnvironmentContextFormatter\n\n        return EnvironmentContextFormatter(self)\n\n    @staticmethod\n    def get_option_types() -&gt; dict:\n        \"\"\"\n        Returns a mapping of supported options to their respective types so that they can be used by\n        [overrides](../../config/environment/advanced.md#option-overrides).\n        \"\"\"\n        return {}\n\n    @contextmanager\n    def apply_context(self):\n        with self.get_env_vars(), self.metadata.context.apply_context(self.context):\n            yield\n\n    def __enter__(self):\n        self.activate()\n        return self\n\n    def __exit__(self, exc_type, exc_value, traceback):\n        self.deactivate()\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app","title":"<code>app</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.root","title":"<code>root</code>  <code>property</code>","text":"<p>The root of the project tree as a path-like object.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.name","title":"<code>name: str</code>  <code>property</code>","text":"<p>The name of the environment.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.data_directory","title":"<code>data_directory</code>  <code>property</code>","text":"<p>The directory this plugin should use for storage as a path-like object. If the user has not configured one then this will be the same as the isolated data directory.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.isolated_data_directory","title":"<code>isolated_data_directory</code>  <code>property</code>","text":"<p>The default directory reserved exclusively for this plugin as a path-like object.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.platform","title":"<code>platform</code>  <code>property</code>","text":"<p>An instance of Platform.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.environment_dependencies","title":"<code>environment_dependencies: list[str]</code>  <code>property</code>","text":"<p>The list of all environment dependencies.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dependencies","title":"<code>dependencies: list[str]</code>  <code>property</code>","text":"<p>The list of all project dependencies (if installed and in dev mode), selected optional dependencies, and environment dependencies.</p>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.env_vars","title":"<code>env_vars: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;.env-vars]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;.env-vars]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.env_include","title":"<code>env_include: list[str]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nenv-include = [...]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nenv-include = [...]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.env_exclude","title":"<code>env_exclude: list[str]</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nenv-exclude = [...]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nenv-exclude = [...]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.platforms","title":"<code>platforms: list[str]</code>  <code>property</code>","text":"<p>All names are stored as their lower-cased version.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nplatforms = [...]\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nplatforms = [...]\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.skip_install","title":"<code>skip_install: bool</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\nskip-install = ...\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\nskip-install = ...\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dev_mode","title":"<code>dev_mode: bool</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ndev-mode = ...\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ndev-mode = ...\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.description","title":"<code>description: str</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ndescription = ...\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ndescription = ...\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.find","title":"<code>find()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should return information about how to locate the environment or represent its ID in some way. Additionally, this is expected to return something even if the environment is incompatible.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef find(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should return information about how to locate the environment or represent its ID in\n    some way. Additionally, this is expected to return something even if the environment is\n    [incompatible](reference.md#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility).\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.create","title":"<code>create()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should perform the necessary steps to set up the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef create(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should perform the necessary steps to set up the environment.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.remove","title":"<code>remove()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should perform the necessary steps to completely remove the environment from the system and will only be triggered manually by users with the <code>env remove</code> or <code>env prune</code> commands.</p> <p>If the build environment has a caching mechanism, this should remove that as well.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef remove(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should perform the necessary steps to completely remove the environment from the system and will only\n    be triggered manually by users with the [`env remove`](../../cli/reference.md#hatch-env-remove) or\n    [`env prune`](../../cli/reference.md#hatch-env-prune) commands.\n\n    If the\n    [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n    has a caching mechanism, this should remove that as well.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.exists","title":"<code>exists() -&gt; bool</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should indicate whether or not the environment has already been created.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef exists(self) -&gt; bool:\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should indicate whether or not the environment has already been created.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.install_project","title":"<code>install_project()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should install the project in the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef install_project(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should install the project in the environment.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.install_project_dev_mode","title":"<code>install_project_dev_mode()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should install the project in the environment such that the environment always reflects the current state of the project.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef install_project_dev_mode(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should install the project in the environment such that the environment\n    always reflects the current state of the project.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync","title":"<code>dependencies_in_sync() -&gt; bool</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should indicate whether or not the environment is compatible with the current dependencies.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef dependencies_in_sync(self) -&gt; bool:\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should indicate whether or not the environment is compatible with the current\n    [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies).\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies","title":"<code>sync_dependencies()</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This should install the dependencies in the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@abstractmethod\ndef sync_dependencies(self):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This should install the\n    [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n    in the environment.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.dependency_hash","title":"<code>dependency_hash()</code>","text":"<p>This should return a hash of the environment's dependencies and any other data that is handled by the sync_dependencies and dependencies_in_sync methods.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def dependency_hash(self):\n    \"\"\"\n    This should return a hash of the environment's\n    [dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies)\n    and any other data that is handled by the\n    [sync_dependencies](reference.md#hatch.env.plugin.interface.EnvironmentInterface.sync_dependencies)\n    and\n    [dependencies_in_sync](reference.md#hatch.env.plugin.interface.EnvironmentInterface.dependencies_in_sync)\n    methods.\n    \"\"\"\n    from hatch.utils.dep import hash_dependencies\n\n    return hash_dependencies(self.dependencies_complex)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.build_environment","title":"<code>build_environment(dependencies: list[str])</code>","text":"<p>This should set up an isolated environment in which to <code>build</code> the project given a set of dependencies and must be a context manager:</p> <pre><code>with environment.build_environment([...]):\n    ...\n</code></pre> <p>The build environment should reflect any environment variables the user defined either currently or at the time of creation.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef build_environment(\n    self,\n    dependencies: list[str],  # noqa: ARG002\n):\n    \"\"\"\n    This should set up an isolated environment in which to [`build`](../../cli/reference.md#hatch-build) the project\n    given a set of dependencies and must be a context manager:\n\n    ```python\n    with environment.build_environment([...]):\n        ...\n    ```\n\n    The build environment should reflect any\n    [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n    the user defined either currently or at the time of\n    [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n    \"\"\"\n    with self.get_env_vars():\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.build_environment_exists","title":"<code>build_environment_exists()</code>","text":"<p>If the build environment has a caching mechanism, this should indicate whether or not it has already been created.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def build_environment_exists(self):  # noqa: PLR6301\n    \"\"\"\n    If the\n    [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n    has a caching mechanism, this should indicate whether or not it has already been created.\n    \"\"\"\n    return False\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.activate","title":"<code>activate()</code>","text":"<p>A convenience method called when using the environment as a context manager:</p> <pre><code>with environment:\n    ...\n</code></pre> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def activate(self):\n    \"\"\"\n    A convenience method called when using the environment as a context manager:\n\n    ```python\n    with environment:\n        ...\n    ```\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.deactivate","title":"<code>deactivate()</code>","text":"<p>A convenience method called after using the environment as a context manager:</p> <pre><code>with environment:\n    ...\n</code></pre> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def deactivate(self):\n    \"\"\"\n    A convenience method called after using the environment as a context manager:\n\n    ```python\n    with environment:\n        ...\n    ```\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_creation","title":"<code>app_status_creation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_creation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status(f'Creating environment: {self.name}'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_pre_installation","title":"<code>app_status_pre_installation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_pre_installation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Running pre-installation commands'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_post_installation","title":"<code>app_status_post_installation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_post_installation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Running post-installation commands'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_project_installation","title":"<code>app_status_project_installation()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_project_installation(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    if self.dev_mode:\n        with self.app.status('Installing project in development mode'):\n            yield\n    else:\n        with self.app.status('Installing project'):\n            yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_state_check","title":"<code>app_status_dependency_state_check()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_dependency_state_check(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    if not self.skip_install and (\n        'dependencies' in self.metadata.dynamic or 'optional-dependencies' in self.metadata.dynamic\n    ):\n        with self.app.status('Polling dependency state'):\n            yield\n    else:\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_installation_check","title":"<code>app_status_dependency_installation_check()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_dependency_installation_check(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Checking dependencies'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.app_status_dependency_synchronization","title":"<code>app_status_dependency_synchronization()</code>","text":"<p>See the life cycle of environments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef app_status_dependency_synchronization(self):\n    \"\"\"\n    See the [life cycle of environments](reference.md#life-cycle).\n    \"\"\"\n    with self.app.status('Syncing dependencies'):\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.run_builder","title":"<code>run_builder(build_environment, **kwargs)</code>","text":"<p>This will be called when the build environment is active:</p> <pre><code>with environment.build_environment([...]) as build_env:\n    process = environment.run_builder(build_env, ...)\n</code></pre> <p>This should return the standard library's subprocess.CompletedProcess. The command is constructed by passing all keyword arguments to construct_build_command.</p> <p>For an example, open the default implementation below:</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def run_builder(\n    self,\n    build_environment,  # noqa: ARG002\n    **kwargs,\n):\n    \"\"\"\n    This will be called when the\n    [build environment](reference.md#hatch.env.plugin.interface.EnvironmentInterface.build_environment)\n    is active:\n\n    ```python\n    with environment.build_environment([...]) as build_env:\n        process = environment.run_builder(build_env, ...)\n    ```\n\n    This should return the standard library's\n    [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess).\n    The command is constructed by passing all keyword arguments to\n    [construct_build_command](reference.md#hatch.env.plugin.interface.EnvironmentInterface.construct_build_command).\n\n    For an example, open the default implementation below:\n    \"\"\"\n    return self.platform.run_command(self.construct_build_command(**kwargs))\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.construct_build_command","title":"<code>construct_build_command(*, directory=None, targets=(), hooks_only=False, no_hooks=False, clean=False, clean_hooks_after=False, clean_only=False)</code>","text":"<p>This is the canonical way <code>build</code> command options are translated to a subprocess command issued to builders.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def construct_build_command(  # noqa: PLR6301\n    self,\n    *,\n    directory=None,\n    targets=(),\n    hooks_only=False,\n    no_hooks=False,\n    clean=False,\n    clean_hooks_after=False,\n    clean_only=False,\n):\n    \"\"\"\n    This is the canonical way [`build`](../../cli/reference.md#hatch-build) command options are translated to\n    a subprocess command issued to [builders](../builder/reference.md).\n    \"\"\"\n    command = ['python', '-u', '-m', 'hatchling', 'build']\n\n    if directory:\n        command.extend(('--directory', directory))\n\n    if targets:\n        for target in targets:\n            command.extend(('--target', target))\n\n    if hooks_only:\n        command.append('--hooks-only')\n\n    if no_hooks:\n        command.append('--no-hooks')\n\n    if clean:\n        command.append('--clean')\n\n    if clean_hooks_after:\n        command.append('--clean-hooks-after')\n\n    if clean_only:\n        command.append('--clean-only')\n\n    return command\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.command_context","title":"<code>command_context()</code>","text":"<p>A context manager that when active should make executed shell commands reflect any environment variables the user defined either currently or at the time of creation.</p> <p>For an example, open the default implementation below:</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@contextmanager\ndef command_context(self):\n    \"\"\"\n    A context manager that when active should make executed shell commands reflect any\n    [environment variables](reference.md#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars)\n    the user defined either currently or at the time of\n    [creation](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n\n    For an example, open the default implementation below:\n    \"\"\"\n    with self.get_env_vars():\n        yield\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.enter_shell","title":"<code>enter_shell(name: str, path: str, args: Iterable[str])</code>","text":"<p>Spawn a shell within the environment.</p> <p>This should either use command_context directly or provide the same guarantee.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def enter_shell(\n    self,\n    name: str,  # noqa: ARG002\n    path: str,\n    args: Iterable[str],\n):\n    \"\"\"\n    Spawn a [shell](../../config/hatch.md#shell) within the environment.\n\n    This should either use\n    [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n    directly or provide the same guarantee.\n    \"\"\"\n    with self.command_context():\n        self.platform.exit_with_command([path, *args])\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.run_shell_command","title":"<code>run_shell_command(command: str, **kwargs)</code>","text":"<p>This should return the standard library's subprocess.CompletedProcess and will always be called when the command_context is active, with the expectation of providing the same guarantee.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def run_shell_command(self, command: str, **kwargs):\n    \"\"\"\n    This should return the standard library's\n    [subprocess.CompletedProcess](https://docs.python.org/3/library/subprocess.html#subprocess.CompletedProcess)\n    and will always be called when the\n    [command_context](reference.md#hatch.env.plugin.interface.EnvironmentInterface.command_context)\n    is active, with the expectation of providing the same guarantee.\n    \"\"\"\n    kwargs.setdefault('shell', True)\n    return self.platform.run_command(command, **kwargs)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.resolve_commands","title":"<code>resolve_commands(commands: list[str])</code>","text":"<p>This expands each command into one or more commands based on any scripts that the user defined.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def resolve_commands(self, commands: list[str]):\n    \"\"\"\n    This expands each command into one or more commands based on any\n    [scripts](../../config/environment/overview.md#scripts) that the user defined.\n    \"\"\"\n    for command in commands:\n        yield from self.expand_command(command)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_env_vars","title":"<code>get_env_vars() -&gt; EnvVars</code>","text":"<p>Returns a mapping of environment variables that should be available to the environment. The object can be used as a context manager to temporarily apply the environment variables to the current process.</p> <p>Note</p> <p>The environment variable <code>HATCH_ENV_ACTIVE</code> will always be set to the name of the environment.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def get_env_vars(self) -&gt; EnvVars:\n    \"\"\"\n    Returns a mapping of environment variables that should be available to the environment. The object can\n    be used as a context manager to temporarily apply the environment variables to the current process.\n\n    !!! note\n        The environment variable `HATCH_ENV_ACTIVE` will always be set to the name of the environment.\n    \"\"\"\n    return EnvVars(self.env_vars, self.env_include, self.env_exclude)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.apply_features","title":"<code>apply_features(requirement: str)</code>","text":"<p>A convenience method that applies any user defined features to the given requirement.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def apply_features(self, requirement: str):\n    \"\"\"\n    A convenience method that applies any user defined [features](../../config/environment/overview.md#features)\n    to the given requirement.\n    \"\"\"\n    if self.features:\n        features = ','.join(self.features)\n        return f'{requirement}[{features}]'\n\n    return requirement\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.construct_pip_install_command","title":"<code>construct_pip_install_command(args: list[str])</code>","text":"<p>A convenience method for constructing a <code>pip install</code> command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def construct_pip_install_command(self, args: list[str]):\n    \"\"\"\n    A convenience method for constructing a [`pip install`](https://pip.pypa.io/en/stable/cli/pip_install/)\n    command with the given verbosity. The default verbosity is set to one less than Hatch's verbosity.\n    \"\"\"\n    command = ['python', '-u', '-m', 'pip', 'install', '--disable-pip-version-check', '--no-python-version-warning']\n\n    # Default to -1 verbosity\n    add_verbosity_flag(command, self.verbosity, adjustment=-1)\n\n    command.extend(args)\n    return command\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.join_command_args","title":"<code>join_command_args(args: list[str])</code>","text":"<p>This is used by the <code>run</code> command to construct the root command string from the received arguments.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def join_command_args(self, args: list[str]):\n    \"\"\"\n    This is used by the [`run`](../../cli/reference.md#hatch-run) command to construct the root command string\n    from the received arguments.\n    \"\"\"\n    return self.platform.join_command_args(args)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.check_compatibility","title":"<code>check_compatibility()</code>","text":"<p>This raises an exception if the environment is not compatible with the user's setup. The default behavior checks for platform compatibility and any method override should keep this check.</p> <p>This check is never performed if the environment has been created.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def check_compatibility(self):\n    \"\"\"\n    This raises an exception if the environment is not compatible with the user's setup. The default behavior\n    checks for [platform compatibility](../../config/environment/overview.md#supported-platforms)\n    and any method override should keep this check.\n\n    This check is never performed if the environment has been\n    [created](reference.md#hatch.env.plugin.interface.EnvironmentInterface.create).\n    \"\"\"\n    if self.platforms and self.platform.name not in self.platforms:\n        message = 'unsupported platform'\n        raise OSError(message)\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_option_types","title":"<code>get_option_types() -&gt; dict</code>  <code>staticmethod</code>","text":"<p>Returns a mapping of supported options to their respective types so that they can be used by overrides.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>@staticmethod\ndef get_option_types() -&gt; dict:\n    \"\"\"\n    Returns a mapping of supported options to their respective types so that they can be used by\n    [overrides](../../config/environment/advanced.md#option-overrides).\n    \"\"\"\n    return {}\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_env_var_option","title":"<code>get_env_var_option(option: str) -&gt; str</code>","text":"<p>Returns the value of the upper-cased environment variable <code>HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;</code>.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def get_env_var_option(self, option: str) -&gt; str:\n    \"\"\"\n    Returns the value of the upper-cased environment variable `HATCH_ENV_TYPE_&lt;PLUGIN_NAME&gt;_&lt;option&gt;`.\n    \"\"\"\n    return os.environ.get(f'{AppEnvVars.ENV_OPTION_PREFIX}{self.PLUGIN_NAME}_{option}'.upper(), '')\n</code></pre>"},{"location":"plugins/environment/reference/#hatch.env.plugin.interface.EnvironmentInterface.get_context","title":"<code>get_context()</code>","text":"<p>Returns a subclass of EnvironmentContextFormatter.</p> Source code in <code>src/hatch/env/plugin/interface.py</code> <pre><code>def get_context(self):\n    \"\"\"\n    Returns a subclass of\n    [EnvironmentContextFormatter](../utilities.md#hatch.env.context.EnvironmentContextFormatter).\n    \"\"\"\n    from hatch.env.context import EnvironmentContextFormatter\n\n    return EnvironmentContextFormatter(self)\n</code></pre>"},{"location":"plugins/environment/virtual/","title":"Virtual environment","text":"<p>This uses virtual environments backed by the standard virtualenv tool.</p>"},{"location":"plugins/environment/virtual/#configuration","title":"Configuration","text":"<p>The environment plugin name is <code>virtual</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.&lt;ENV_NAME&gt;]\ntype = \"virtual\"\n</code></pre> <pre><code>[envs.&lt;ENV_NAME&gt;]\ntype = \"virtual\"\n</code></pre>"},{"location":"plugins/environment/virtual/#options","title":"Options","text":"Option Default Description <code>python</code> The version of Python to find on your system and subsequently use to create the environment, defaulting to the <code>HATCH_PYTHON</code> environment variable, followed by the normal resolution logic. Setting the <code>HATCH_PYTHON</code> environment variable to <code>self</code> will force the use of the Python executable Hatch is running on. For more information, see the documentation. <code>python-sources</code> <code>['external', 'internal']</code> This may be set to an array of strings that are either the literal <code>internal</code> or <code>external</code>. External considers only Python executables that are already on <code>PATH</code>. Internal considers only internally managed Python distributions. <code>path</code> An explicit path to the virtual environment. The path may be absolute or relative to the project root. Any environments that inherit this option will also use this path. The environment variable <code>HATCH_ENV_TYPE_VIRTUAL_PATH</code> may be used, which will take precedence. <code>system-packages</code> <code>false</code> Whether or not to give the virtual environment access to the system <code>site-packages</code> directory"},{"location":"plugins/environment/virtual/#location","title":"Location","text":"<p>The location of environments is determined in the following heuristic order:</p> <ol> <li>The <code>path</code> option</li> <li>A directory named after the environment within the configured <code>virtual</code> environment directory if the directory resides somewhere within the project root or if it is set to a <code>.virtualenvs</code> directory within the user's home directory</li> <li>Otherwise, environments are stored within the configured <code>virtual</code> environment directory in a deeply nested structure in order to support multiple projects</li> </ol> <p>Additionally, when the <code>path</code> option is not used, the name of the directory for the <code>default</code> environment will be the normalized project name to provide a more meaningful default shell prompt.</p>"},{"location":"plugins/environment/virtual/#python-resolution","title":"Python resolution","text":"<p>Virtual environments necessarily require a parent installation of Python. The following rules determine how the parent is resolved.</p> <p>The Python choice is determined by the <code>python</code> option followed by the <code>HATCH_PYTHON</code> environment variable. If the choice is via the environment variable, then resolution stops and that path is used unconditionally.</p> <p>The resolvers will be based on the <code>python-sources</code> option and all resolved interpreters will ensure compatibility with the project's defined Python support.</p> <p>If a Python version has been chosen then each resolver will try to find an interpreter that satisfies that version.</p> <p>If no version has been chosen, then each resolver will try to find a version that matches the version of Python that Hatch is currently running on. If not found then each resolver will try to find the highest compatible version.</p> <p>Note</p> <p>Some external Python paths are considered unstable and are ignored during resolution. For example, if Hatch is installed via Homebrew then <code>sys.executable</code> will be ignored because the interpreter could change or be removed at any time.</p> <p>Note</p> <p>When resolution finds a match using an internally managed distribution and an update is available, the latest distribution will automatically be downloaded before environment creation.</p>"},{"location":"plugins/environment/virtual/#internal-distributions","title":"Internal distributions","text":"<p>The following options are recognized for internal Python resolution.</p>"},{"location":"plugins/environment/virtual/#cpython","title":"CPython","text":"ID <code>3.7</code> <code>3.8</code> <code>3.9</code> <code>3.10</code> <code>3.11</code> <code>3.12</code> <p>The source of distributions is the python-build-standalone project.</p> <p>Some distributions have variants that may be configured with the <code>HATCH_PYTHON_VARIANT_&lt;PLATFORM&gt;</code> environment variable where <code>&lt;PLATFORM&gt;</code> is the uppercase version of one of the following:</p> Platform Options Linux <ul><li><code>v1</code></li><li><code>v2</code></li><li><code>v3</code> (default)</li><li><code>v4</code></li></ul> Windows <ul><li><code>shared</code> (default)</li><li><code>static</code></li></ul>"},{"location":"plugins/environment/virtual/#pypy","title":"PyPy","text":"ID <code>pypy2.7</code> <code>pypy3.9</code> <code>pypy3.10</code> <p>The source of distributions is the PyPy project.</p>"},{"location":"plugins/environment/virtual/#troubleshooting","title":"Troubleshooting","text":""},{"location":"plugins/environment/virtual/#macos-sip","title":"macOS SIP","text":"<p>If you need to set linker environment variables like those starting with <code>DYLD_</code> or <code>LD_</code>, any executable secured by System Integrity Protection that is invoked when running commands will not see those environment variable modifications as macOS strips those.</p> <p>Hatch interprets such commands as shell commands but deliberately ignores such paths to protected shells. This workaround suffices for the majority of use cases but there are 2 situations in which it may not:</p> <ol> <li>There are no unprotected <code>sh</code>, <code>bash</code>, <code>zsh</code>, nor <code>fish</code> executables found along PATH.</li> <li>The desired executable is a project's script, and the location of environments contains spaces or is longer than 124<sup>1</sup> characters. In this case <code>pip</code> and other installers will create such an entry point with a shebang pointing to <code>/bin/sh</code> (which is protected) to avoid shebang limitations. Rather than changing the location, you could invoke the script as e.g. <code>python -m pytest</code> (if the project supports that method of invocation by shipping a <code>__main__.py</code>).</li> </ol> <ol> <li> <p>The shebang length limit is usually 127 but 3 characters surround the executable path: <code>#!&lt;EXE_PATH&gt;\\n</code> \u21a9</p> </li> </ol>"},{"location":"plugins/environment-collector/custom/","title":"Custom environment collector","text":"<p>This is a custom class in a given Python file that inherits from the EnvironmentCollectorInterface.</p>"},{"location":"plugins/environment-collector/custom/#configuration","title":"Configuration","text":"<p>The environment collector plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env.collectors.custom]\n</code></pre> <pre><code>[env.collectors.custom]\n</code></pre>"},{"location":"plugins/environment-collector/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_plugins.py</code> The path of the Python file"},{"location":"plugins/environment-collector/custom/#example","title":"Example","text":"hatch_plugins.py <pre><code>    from hatch.env.collectors.plugin.interface import EnvironmentCollectorInterface\n\n\n    class CustomEnvironmentCollector(EnvironmentCollectorInterface):\n        ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_environment_collector</code> that returns the desired environment collector.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/environment-collector/default/","title":"Default environment collector","text":"<p>This adds the <code>default</code> environment with type set to virtual and will always be applied.</p>"},{"location":"plugins/environment-collector/default/#configuration","title":"Configuration","text":"<p>The environment collector plugin name is <code>default</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env.collectors.default]\n</code></pre> <pre><code>[env.collectors.default]\n</code></pre>"},{"location":"plugins/environment-collector/default/#options","title":"Options","text":"<p>There are no options available currently.</p>"},{"location":"plugins/environment-collector/reference/","title":"Environment collector plugins","text":"<p>Environment collectors allow for dynamically modifying environments or adding environments beyond those defined in config. Users can override default values provided by each environment.</p>"},{"location":"plugins/environment-collector/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-mkdocs - integrate MkDocs and infer dependencies into an env</li> </ul>"},{"location":"plugins/environment-collector/reference/#installation","title":"Installation","text":"<p>Any required environment collectors that are not built-in must be manually installed alongside Hatch or listed in the <code>tool.hatch.env.requires</code> array for automatic management:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.env]\nrequires = [\n  \"...\",\n]\n</code></pre> <pre><code>[env]\nrequires = [\n  \"...\",\n]\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface","title":"<code>EnvironmentCollectorInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>    from hatch.env.collectors.plugin.interface import EnvironmentCollectorInterface\n\n\n    class SpecialEnvironmentCollector(EnvironmentCollectorInterface):\n        PLUGIN_NAME = 'special'\n        ...\n</code></pre> <pre><code>    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialEnvironmentCollector\n\n\n    @hookimpl\n    def hatch_register_environment_collector():\n        return SpecialEnvironmentCollector\n</code></pre> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>class EnvironmentCollectorInterface:\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n        from hatch.env.collectors.plugin.interface import EnvironmentCollectorInterface\n\n\n        class SpecialEnvironmentCollector(EnvironmentCollectorInterface):\n            PLUGIN_NAME = 'special'\n            ...\n    ```\n\n    ```python tab=\"hooks.py\"\n        from hatchling.plugin import hookimpl\n\n        from .plugin import SpecialEnvironmentCollector\n\n\n        @hookimpl\n        def hatch_register_environment_collector():\n            return SpecialEnvironmentCollector\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root, config):\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self):\n        \"\"\"\n        The root of the project tree as a path-like object.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.env.collectors.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    def get_initial_config(self) -&gt; dict[str, dict]:  # noqa: PLR6301\n        \"\"\"\n        Returns configuration for environments keyed by the environment or matrix name.\n        \"\"\"\n        return {}\n\n    def finalize_config(self, config: dict[str, dict]):\n        \"\"\"\n        Finalizes configuration for environments keyed by the environment or matrix name. This will override\n        any user-defined settings and any collectors that ran before this call.\n\n        This is called before matrices are turned into concrete environments.\n        \"\"\"\n\n    def finalize_environments(self, config: dict[str, dict]):\n        \"\"\"\n        Finalizes configuration for environments keyed by the environment name. This will override\n        any user-defined settings and any collectors that ran before this call.\n\n        This is called after matrices are turned into concrete environments.\n        \"\"\"\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.root","title":"<code>root</code>  <code>property</code>","text":"<p>The root of the project tree as a path-like object.</p>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.env.collectors.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[env.collectors.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.get_initial_config","title":"<code>get_initial_config() -&gt; dict[str, dict]</code>","text":"<p>Returns configuration for environments keyed by the environment or matrix name.</p> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>def get_initial_config(self) -&gt; dict[str, dict]:  # noqa: PLR6301\n    \"\"\"\n    Returns configuration for environments keyed by the environment or matrix name.\n    \"\"\"\n    return {}\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.finalize_config","title":"<code>finalize_config(config: dict[str, dict])</code>","text":"<p>Finalizes configuration for environments keyed by the environment or matrix name. This will override any user-defined settings and any collectors that ran before this call.</p> <p>This is called before matrices are turned into concrete environments.</p> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>def finalize_config(self, config: dict[str, dict]):\n    \"\"\"\n    Finalizes configuration for environments keyed by the environment or matrix name. This will override\n    any user-defined settings and any collectors that ran before this call.\n\n    This is called before matrices are turned into concrete environments.\n    \"\"\"\n</code></pre>"},{"location":"plugins/environment-collector/reference/#hatch.env.collectors.plugin.interface.EnvironmentCollectorInterface.finalize_environments","title":"<code>finalize_environments(config: dict[str, dict])</code>","text":"<p>Finalizes configuration for environments keyed by the environment name. This will override any user-defined settings and any collectors that ran before this call.</p> <p>This is called after matrices are turned into concrete environments.</p> Source code in <code>src/hatch/env/collectors/plugin/interface.py</code> <pre><code>def finalize_environments(self, config: dict[str, dict]):\n    \"\"\"\n    Finalizes configuration for environments keyed by the environment name. This will override\n    any user-defined settings and any collectors that ran before this call.\n\n    This is called after matrices are turned into concrete environments.\n    \"\"\"\n</code></pre>"},{"location":"plugins/metadata-hook/custom/","title":"Custom metadata hook","text":"<p>This is a custom class in a given Python file that inherits from the MetadataHookInterface.</p>"},{"location":"plugins/metadata-hook/custom/#configuration","title":"Configuration","text":"<p>The metadata hook plugin name is <code>custom</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata.hooks.custom]\n</code></pre> <pre><code>[metadata.hooks.custom]\n</code></pre>"},{"location":"plugins/metadata-hook/custom/#options","title":"Options","text":"Option Default Description <code>path</code> <code>hatch_build.py</code> The path of the Python file"},{"location":"plugins/metadata-hook/custom/#example","title":"Example","text":"hatch_build.py <pre><code>from hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\nclass CustomMetadataHook(MetadataHookInterface):\n    ...\n</code></pre> <p>If multiple subclasses are found, you must define a function named <code>get_metadata_hook</code> that returns the desired build hook.</p> <p>Note</p> <p>Any defined PLUGIN_NAME is ignored and will always be <code>custom</code>.</p>"},{"location":"plugins/metadata-hook/reference/","title":"Metadata hook plugins","text":"<p>Metadata hooks allow for the modification of project metadata after it has been loaded.</p>"},{"location":"plugins/metadata-hook/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-docstring-description - set the project description using docstrings</li> <li>hatch-fancy-pypi-readme - dynamically construct the README</li> <li>hatch-nodejs-version - uses fields from NodeJS <code>package.json</code> files</li> <li>hatch-odoo - determine dependencies based on manifests of Odoo add-ons</li> <li>hatch-requirements-txt - read project dependencies from <code>requirements.txt</code> files</li> <li>UniDep - for unified <code>pip</code> and <code>conda</code> dependency management using a single <code>requirements.yaml</code> file for both </li> </ul>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface","title":"<code>MetadataHookInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\nclass SpecialMetadataHook(MetadataHookInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialMetadataHook\n\n\n@hookimpl\ndef hatch_register_metadata_hook():\n    return SpecialMetadataHook\n</code></pre> Source code in <code>backend/src/hatchling/metadata/plugin/interface.py</code> <pre><code>class MetadataHookInterface(ABC):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.metadata.plugin.interface import MetadataHookInterface\n\n\n    class SpecialMetadataHook(MetadataHookInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialMetadataHook\n\n\n    @hookimpl\n    def hatch_register_metadata_hook():\n        return SpecialMetadataHook\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root: str, config: dict) -&gt; None:\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        The hook configuration.\n\n        ```toml config-example\n        [tool.hatch.metadata.hooks.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__config\n\n    @abstractmethod\n    def update(self, metadata: dict) -&gt; None:\n        \"\"\"\n        This updates the metadata mapping of the `project` table in-place.\n        \"\"\"\n\n    def get_known_classifiers(self) -&gt; list[str]:  # noqa: PLR6301\n        \"\"\"\n        This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.\n        \"\"\"\n        return []\n</code></pre>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree.</p>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"<p>The hook configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.metadata.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[metadata.hooks.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.update","title":"<code>update(metadata: dict) -&gt; None</code>  <code>abstractmethod</code>","text":"<p>This updates the metadata mapping of the <code>project</code> table in-place.</p> Source code in <code>backend/src/hatchling/metadata/plugin/interface.py</code> <pre><code>@abstractmethod\ndef update(self, metadata: dict) -&gt; None:\n    \"\"\"\n    This updates the metadata mapping of the `project` table in-place.\n    \"\"\"\n</code></pre>"},{"location":"plugins/metadata-hook/reference/#hatchling.metadata.plugin.interface.MetadataHookInterface.get_known_classifiers","title":"<code>get_known_classifiers() -&gt; list[str]</code>","text":"<p>This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.</p> Source code in <code>backend/src/hatchling/metadata/plugin/interface.py</code> <pre><code>def get_known_classifiers(self) -&gt; list[str]:  # noqa: PLR6301\n    \"\"\"\n    This returns extra classifiers that should be considered valid in addition to the ones known to PyPI.\n    \"\"\"\n    return []\n</code></pre>"},{"location":"plugins/publisher/package-index/","title":"Index publisher","text":"<p>See the documentation for publishing.</p>"},{"location":"plugins/publisher/package-index/#options","title":"Options","text":"Flag Config name Description <code>-r</code>/<code>--repo</code> <code>repo</code> The repository with which to publish artifacts <code>-u</code>/<code>--user</code> <code>user</code> The user with which to authenticate <code>-a</code>/<code>--auth</code> <code>auth</code> The credentials to use for authentication <code>--ca-cert</code> <code>ca-cert</code> The path to a CA bundle <code>--client-cert</code> <code>client-cert</code> The path to a client certificate, optionally containing the private key <code>--client-key</code> <code>client-key</code> The path to the client certificate's private key <code>repos</code> A table of named repositories to their respective options"},{"location":"plugins/publisher/package-index/#configuration","title":"Configuration","text":"<p>The publisher plugin name is <code>index</code>.</p>  config.toml <pre><code>[publish.index]\n</code></pre>"},{"location":"plugins/publisher/package-index/#repositories","title":"Repositories","text":"<p>All top-level options can be overridden per repository using the <code>repos</code> table with a required <code>url</code> attribute for each repository. The following shows the default configuration:</p>  config.toml <pre><code>[publish.index.repos.main]\nurl = \"https://upload.pypi.org/legacy/\"\n\n[publish.index.repos.test]\nurl = \"https://test.pypi.org/legacy/\"\n</code></pre> <p>The <code>repo</code> and <code>repos</code> options have no effect.</p>"},{"location":"plugins/publisher/package-index/#confirmation-prompt","title":"Confirmation prompt","text":"<p>You can require a confirmation prompt or use of the <code>-y</code>/<code>--yes</code> flag by setting publishers' <code>disable</code> option to <code>true</code> in either Hatch's config file or project-specific configuration (which takes precedence):</p>  config.toml pyproject.toml hatch.toml <pre><code>[publish.index]\ndisable = true\n</code></pre> <pre><code>[tool.hatch.publish.index]\ndisable = true\n</code></pre> <pre><code>[publish.index]\ndisable = true\n</code></pre>"},{"location":"plugins/publisher/reference/","title":"Publisher plugins","text":""},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface","title":"<code>PublisherInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>    from hatch.publish.plugin.interface import PublisherInterface\n\n\n    class SpecialPublisher(PublisherInterface):\n        PLUGIN_NAME = 'special'\n        ...\n</code></pre> <pre><code>    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialPublisher\n\n\n    @hookimpl\n    def hatch_register_publisher():\n        return SpecialPublisher\n</code></pre> Source code in <code>src/hatch/publish/plugin/interface.py</code> <pre><code>class PublisherInterface(ABC):\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n        from hatch.publish.plugin.interface import PublisherInterface\n\n\n        class SpecialPublisher(PublisherInterface):\n            PLUGIN_NAME = 'special'\n            ...\n    ```\n\n    ```python tab=\"hooks.py\"\n        from hatchling.plugin import hookimpl\n\n        from .plugin import SpecialPublisher\n\n\n        @hookimpl\n        def hatch_register_publisher():\n            return SpecialPublisher\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, app, root, cache_dir, project_config, plugin_config):\n        self.__app = app\n        self.__root = root\n        self.__cache_dir = cache_dir\n        self.__project_config = project_config\n        self.__plugin_config = plugin_config\n\n        self.__disable = None\n\n    @property\n    def app(self):\n        \"\"\"\n        An instance of [Application](../utilities.md#hatchling.bridge.app.Application).\n        \"\"\"\n        return self.__app\n\n    @property\n    def root(self):\n        \"\"\"\n        The root of the project tree as a path-like object.\n        \"\"\"\n        return self.__root\n\n    @property\n    def cache_dir(self):\n        \"\"\"\n        The directory reserved exclusively for this plugin as a path-like object.\n        \"\"\"\n        return self.__cache_dir\n\n    @property\n    def project_config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.publish.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__project_config\n\n    @property\n    def plugin_config(self) -&gt; dict:\n        \"\"\"\n        This is defined in Hatch's [config file](../../config/hatch.md).\n\n        ```toml tab=\"config.toml\"\n        [publish.&lt;PLUGIN_NAME&gt;]\n        ```\n        \"\"\"\n        return self.__plugin_config\n\n    @property\n    def disable(self):\n        \"\"\"\n        Whether this plugin is disabled, thus requiring confirmation when publishing. Local\n        [project configuration](reference.md#hatch.publish.plugin.interface.PublisherInterface.project_config)\n        takes precedence over global\n        [plugin configuration](reference.md#hatch.publish.plugin.interface.PublisherInterface.plugin_config).\n        \"\"\"\n        if self.__disable is None:\n            if 'disable' in self.project_config:\n                disable = self.project_config['disable']\n                if not isinstance(disable, bool):\n                    message = f'Field `tool.hatch.publish.{self.PLUGIN_NAME}.disable` must be a boolean'\n                    raise TypeError(message)\n            else:\n                disable = self.plugin_config.get('disable', False)\n                if not isinstance(disable, bool):\n                    message = f'Global plugin configuration `publish.{self.PLUGIN_NAME}.disable` must be a boolean'\n                    raise TypeError(message)\n\n            self.__disable = disable\n\n        return self.__disable\n\n    @abstractmethod\n    def publish(self, artifacts: list[str], options: dict):\n        \"\"\"\n        :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n        This is called directly by the [`publish`](../../cli/reference.md#hatch-publish) command\n        with the arguments and options it receives.\n        \"\"\"\n</code></pre>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.app","title":"<code>app</code>  <code>property</code>","text":"<p>An instance of Application.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.root","title":"<code>root</code>  <code>property</code>","text":"<p>The root of the project tree as a path-like object.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.cache_dir","title":"<code>cache_dir</code>  <code>property</code>","text":"<p>The directory reserved exclusively for this plugin as a path-like object.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.project_config","title":"<code>project_config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.publish.&lt;PLUGIN_NAME&gt;]\n</code></pre> <pre><code>[publish.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.plugin_config","title":"<code>plugin_config: dict</code>  <code>property</code>","text":"<p>This is defined in Hatch's config file.</p>  config.toml <pre><code>[publish.&lt;PLUGIN_NAME&gt;]\n</code></pre>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.disable","title":"<code>disable</code>  <code>property</code>","text":"<p>Whether this plugin is disabled, thus requiring confirmation when publishing. Local project configuration takes precedence over global plugin configuration.</p>"},{"location":"plugins/publisher/reference/#hatch.publish.plugin.interface.PublisherInterface.publish","title":"<code>publish(artifacts: list[str], options: dict)</code>  <code>abstractmethod</code>","text":"<p> REQUIRED </p> <p>This is called directly by the <code>publish</code> command with the arguments and options it receives.</p> Source code in <code>src/hatch/publish/plugin/interface.py</code> <pre><code>@abstractmethod\ndef publish(self, artifacts: list[str], options: dict):\n    \"\"\"\n    :material-align-horizontal-left: **REQUIRED** :material-align-horizontal-right:\n\n    This is called directly by the [`publish`](../../cli/reference.md#hatch-publish) command\n    with the arguments and options it receives.\n    \"\"\"\n</code></pre>"},{"location":"plugins/version-scheme/reference/","title":"Version scheme plugins","text":""},{"location":"plugins/version-scheme/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-semver - uses semantic versioning</li> </ul>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface","title":"<code>VersionSchemeInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.version.scheme.plugin.interface import VersionSchemeInterface\n\n\nclass SpecialVersionScheme(VersionSchemeInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialVersionScheme\n\n\n@hookimpl\ndef hatch_register_version_scheme():\n    return SpecialVersionScheme\n</code></pre> Source code in <code>backend/src/hatchling/version/scheme/plugin/interface.py</code> <pre><code>class VersionSchemeInterface(ABC):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.version.scheme.plugin.interface import VersionSchemeInterface\n\n\n    class SpecialVersionScheme(VersionSchemeInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialVersionScheme\n\n\n    @hookimpl\n    def hatch_register_version_scheme():\n        return SpecialVersionScheme\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root: str, config: dict) -&gt; None:\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree as a string.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.version]\n        ```\n        \"\"\"\n        return self.__config\n\n    @abstractmethod\n    def update(self, desired_version: str, original_version: str, version_data: dict) -&gt; str:\n        \"\"\"\n        This should return a normalized form of the desired version and verify that it\n        is higher than the original version.\n        \"\"\"\n</code></pre>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree as a string.</p>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\n</code></pre> <pre><code>[version]\n</code></pre>"},{"location":"plugins/version-scheme/reference/#hatchling.version.scheme.plugin.interface.VersionSchemeInterface.update","title":"<code>update(desired_version: str, original_version: str, version_data: dict) -&gt; str</code>  <code>abstractmethod</code>","text":"<p>This should return a normalized form of the desired version and verify that it is higher than the original version.</p> Source code in <code>backend/src/hatchling/version/scheme/plugin/interface.py</code> <pre><code>@abstractmethod\ndef update(self, desired_version: str, original_version: str, version_data: dict) -&gt; str:\n    \"\"\"\n    This should return a normalized form of the desired version and verify that it\n    is higher than the original version.\n    \"\"\"\n</code></pre>"},{"location":"plugins/version-scheme/standard/","title":"Standard version scheme","text":"<p>See the documentation for versioning.</p>"},{"location":"plugins/version-scheme/standard/#configuration","title":"Configuration","text":"<p>The version scheme plugin name is <code>standard</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nscheme = \"standard\"\n</code></pre> <pre><code>[version]\nscheme = \"standard\"\n</code></pre>"},{"location":"plugins/version-scheme/standard/#options","title":"Options","text":"Option Description <code>validate-bump</code> When setting a specific version, this determines whether to check that the new version is higher than the original. The default is <code>true</code>."},{"location":"plugins/version-source/code/","title":"Code version source","text":""},{"location":"plugins/version-source/code/#updates","title":"Updates","text":"<p>Setting the version is not supported.</p>"},{"location":"plugins/version-source/code/#configuration","title":"Configuration","text":"<p>The version source plugin name is <code>code</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"code\"\n</code></pre> <pre><code>[version]\nsource = \"code\"\n</code></pre>"},{"location":"plugins/version-source/code/#options","title":"Options","text":"Option Description <code>path</code> (required) A relative path to a Python file or extension module that will be loaded <code>expression</code> A Python expression that when evaluated in the context of the loaded file returns the version. The default expression is simply <code>__version__</code>. <code>search-paths</code> A list of relative paths to directories that will be prepended to Python's search path"},{"location":"plugins/version-source/code/#missing-imports","title":"Missing imports","text":"<p>If the chosen path imports another module in your project, then you'll need to use absolute imports coupled with the <code>search-paths</code> option. For example, say you need to load the following file:</p>  src/pkg/__init__.py <pre><code>    from ._version import get_version\n\n    __version__ = get_version()\n</code></pre> <p>You should change it to:</p>  src/pkg/__init__.py <pre><code>    from pkg._version import get_version\n\n    __version__ = get_version()\n</code></pre> <p>and the configuration would become:</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"code\"\npath = \"src/pkg/__init__.py\"\nsearch-paths = [\"src\"]\n</code></pre> <pre><code>[version]\nsource = \"code\"\npath = \"src/pkg/__init__.py\"\nsearch-paths = [\"src\"]\n</code></pre>"},{"location":"plugins/version-source/env/","title":"Environment version source","text":"<p>Retrieves the version from an environment variable. This can be useful in build pipelines where the version is set by an external trigger.</p>"},{"location":"plugins/version-source/env/#updates","title":"Updates","text":"<p>Setting the version is not supported.</p>"},{"location":"plugins/version-source/env/#configuration","title":"Configuration","text":"<p>The version source plugin name is <code>env</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"env\"\n</code></pre> <pre><code>[version]\nsource = \"env\"\n</code></pre>"},{"location":"plugins/version-source/env/#options","title":"Options","text":"Option Description <code>variable</code> (required) The name of the environment variable"},{"location":"plugins/version-source/reference/","title":"Version source plugins","text":""},{"location":"plugins/version-source/reference/#known-third-party","title":"Known third-party","text":"<ul> <li>hatch-vcs - uses your preferred version control system (like Git)</li> <li>hatch-nodejs-version - uses the <code>version</code> field of NodeJS <code>package.json</code> files</li> <li>hatch-regex-commit - automatically creates a Git commit and tag after version bumping</li> <li>versioningit - determines version from Git or Mercurial tags, with customizable version formatting</li> </ul>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface","title":"<code>VersionSourceInterface</code>","text":"<p>Example usage:</p>  plugin.py hooks.py <pre><code>from hatchling.version.source.plugin.interface import VersionSourceInterface\n\n\nclass SpecialVersionSource(VersionSourceInterface):\n    PLUGIN_NAME = 'special'\n    ...\n</code></pre> <pre><code>from hatchling.plugin import hookimpl\n\nfrom .plugin import SpecialVersionSource\n\n\n@hookimpl\ndef hatch_register_version_source():\n    return SpecialVersionSource\n</code></pre> Source code in <code>backend/src/hatchling/version/source/plugin/interface.py</code> <pre><code>class VersionSourceInterface(ABC):  # no cov\n    \"\"\"\n    Example usage:\n\n    ```python tab=\"plugin.py\"\n    from hatchling.version.source.plugin.interface import VersionSourceInterface\n\n\n    class SpecialVersionSource(VersionSourceInterface):\n        PLUGIN_NAME = 'special'\n        ...\n    ```\n\n    ```python tab=\"hooks.py\"\n    from hatchling.plugin import hookimpl\n\n    from .plugin import SpecialVersionSource\n\n\n    @hookimpl\n    def hatch_register_version_source():\n        return SpecialVersionSource\n    ```\n    \"\"\"\n\n    PLUGIN_NAME = ''\n    \"\"\"The name used for selection.\"\"\"\n\n    def __init__(self, root: str, config: dict) -&gt; None:\n        self.__root = root\n        self.__config = config\n\n    @property\n    def root(self) -&gt; str:\n        \"\"\"\n        The root of the project tree as a string.\n        \"\"\"\n        return self.__root\n\n    @property\n    def config(self) -&gt; dict:\n        \"\"\"\n        ```toml config-example\n        [tool.hatch.version]\n        ```\n        \"\"\"\n        return self.__config\n\n    @abstractmethod\n    def get_version_data(self) -&gt; dict:\n        \"\"\"\n        This should return a mapping with a `version` key representing the current version of the project and will be\n        displayed when invoking the [`version`](../../cli/reference.md#hatch-version) command without any arguments.\n\n        The mapping can contain anything else and will be passed to\n        [set_version](reference.md#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version)\n        when updating the version.\n        \"\"\"\n\n    def set_version(self, version: str, version_data: dict) -&gt; None:\n        \"\"\"\n        This should update the version to the first argument with the data provided during retrieval.\n        \"\"\"\n        raise NotImplementedError\n</code></pre>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.PLUGIN_NAME","title":"<code>PLUGIN_NAME = ''</code>  <code>class-attribute</code> <code>instance-attribute</code>","text":"<p>The name used for selection.</p>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.root","title":"<code>root: str</code>  <code>property</code>","text":"<p>The root of the project tree as a string.</p>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.config","title":"<code>config: dict</code>  <code>property</code>","text":"pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\n</code></pre> <pre><code>[version]\n</code></pre>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.get_version_data","title":"<code>get_version_data() -&gt; dict</code>  <code>abstractmethod</code>","text":"<p>This should return a mapping with a <code>version</code> key representing the current version of the project and will be displayed when invoking the <code>version</code> command without any arguments.</p> <p>The mapping can contain anything else and will be passed to set_version when updating the version.</p> Source code in <code>backend/src/hatchling/version/source/plugin/interface.py</code> <pre><code>@abstractmethod\ndef get_version_data(self) -&gt; dict:\n    \"\"\"\n    This should return a mapping with a `version` key representing the current version of the project and will be\n    displayed when invoking the [`version`](../../cli/reference.md#hatch-version) command without any arguments.\n\n    The mapping can contain anything else and will be passed to\n    [set_version](reference.md#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version)\n    when updating the version.\n    \"\"\"\n</code></pre>"},{"location":"plugins/version-source/reference/#hatchling.version.source.plugin.interface.VersionSourceInterface.set_version","title":"<code>set_version(version: str, version_data: dict) -&gt; None</code>","text":"<p>This should update the version to the first argument with the data provided during retrieval.</p> Source code in <code>backend/src/hatchling/version/source/plugin/interface.py</code> <pre><code>def set_version(self, version: str, version_data: dict) -&gt; None:\n    \"\"\"\n    This should update the version to the first argument with the data provided during retrieval.\n    \"\"\"\n    raise NotImplementedError\n</code></pre>"},{"location":"plugins/version-source/regex/","title":"Regex version source","text":"<p>See the documentation for versioning.</p>"},{"location":"plugins/version-source/regex/#updates","title":"Updates","text":"<p>Setting the version is supported.</p>"},{"location":"plugins/version-source/regex/#configuration","title":"Configuration","text":"<p>The version source plugin name is <code>regex</code>.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.version]\nsource = \"regex\"\n</code></pre> <pre><code>[version]\nsource = \"regex\"\n</code></pre>"},{"location":"plugins/version-source/regex/#options","title":"Options","text":"Option Description <code>path</code> (required) A relative path to a file containing the project's version <code>pattern</code> A regular expression that has a named group called <code>version</code> that represents the version. The default pattern looks for a variable named <code>__version__</code> or <code>VERSION</code> that is set to a string containing the version, optionally prefixed with the lowercase letter <code>v</code>."},{"location":"tutorials/environment/basic-usage/","title":"Managing environments","text":"<p>Hatch environments are isolated workspaces that can be used for project tasks including running tests, building documentation and running code formatters and linters.</p>"},{"location":"tutorials/environment/basic-usage/#the-default-environment","title":"The default environment","text":"<p>When you start using Hatch, you can create the <code>default</code> environment. To do this use the <code>env create</code> command:</p> <pre><code>hatch env create\n</code></pre> <p>This will not only create will the <code>default</code> environment for you to work in but will also install your project in dev mode in this <code>default</code> environment.</p> <p>Tip</p> <p>You never need to manually create environments as spawning a shell or running commands within one will automatically trigger creation.</p>"},{"location":"tutorials/environment/basic-usage/#using-the-default-environment","title":"Using the default environment","text":"<p>Hatch will always use the <code>default</code> environment if an environment is not chosen explicitly when running a command.</p> <p>For instance, the following shows how to get version information for the Python in use.</p> <pre><code>$ hatch run python -V\nPython 3.12.1\n</code></pre>"},{"location":"tutorials/environment/basic-usage/#configure-the-default-environment","title":"Configure the default environment","text":"<p>You can customize the tools that are installed into the <code>default</code> environment by adding a table called <code>tool.hatch.envs.default</code> to your <code>pyproject.toml</code> file. Below is an example of adding the dependencies <code>pydantic</code> and <code>numpy</code> to the <code>default</code> environment.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"pydantic\",\n  \"numpy\",\n]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"pydantic\",\n  \"numpy\",\n]\n</code></pre> <p>You can declare versions for your dependencies as well within this configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.default]\ndependencies = [\n  \"pydantic&gt;=2.0\",\n  \"numpy\",\n]\n</code></pre> <pre><code>[envs.default]\ndependencies = [\n  \"pydantic&gt;=2.0\",\n  \"numpy\",\n]\n</code></pre>"},{"location":"tutorials/environment/basic-usage/#create-custom-environment","title":"Create custom environment","text":"<p>You can create custom environments in Hatch by adding a section to your <code>pyproject.toml</code> file <code>[tool.hatch.envs.&lt;ENV_NAME&gt;]</code>. Below you define an environment called <code>test</code> and you add the <code>pytest</code> and <code>pytest-cov</code> dependencies to that environment's configuration.</p>  pyproject.toml hatch.toml <pre><code>[tool.hatch.envs.test]\ndependencies = [\n  \"pytest\",\n  \"pytest-cov\"\n]\n</code></pre> <pre><code>[envs.test]\ndependencies = [\n  \"pytest\",\n  \"pytest-cov\"\n]\n</code></pre> <p>The first time that you call the test environment, Hatch will:</p> <ol> <li>Create the environment</li> <li>Install your project into that environment in dev mode (by default) along with its dependencies.</li> <li>Install the environment's dependencies</li> </ol>"},{"location":"tutorials/environment/basic-usage/#run-commands-within-a-specific-environment","title":"Run commands within a specific environment","text":"<p>Hatch offers a unique environment feature that allows you run a specific command within a specific environment rather than needing to activate the environment as you would using a tool such as Conda or venv.</p> <p>For instance, if you define an environment called <code>test</code> that contains the dependencies from the previous section, you can run the <code>pytest</code> command from the <code>test</code> environment using the syntax:</p> <pre><code>hatch run &lt;ENV_NAME&gt;:command\n</code></pre> <p>To access the <code>test</code> environment and run <code>pytest</code>, you can run:</p> <pre><code>$ hatch run test:pytest\n============================== test session starts ===============================\nplatform darwin -- Python 3.12.1, pytest-7.4.4, pluggy-1.3.0\nrootdir: /your/path/to/yourproject\ncollected 0 items\n</code></pre> <p>Note</p> <p><code>test:pytest</code> represents the name of the environment to call (<code>test</code>) and the command to run (<code>pytest</code>).</p>"},{"location":"tutorials/environment/basic-usage/#view-current-environments","title":"View current environments","text":"<p>Above you defined and created a new test environment in your <code>pyproject.toml</code> file. You can now use the <code>env show</code> command to see both the currently created environments and the dependencies in each environment.</p> <pre><code>$ hatch env show\n             Standalone\n\u250f\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2533\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2513\n\u2503 Name    \u2503 Type    \u2503 Dependencies \u2503\n\u2521\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2547\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2501\u2529\n\u2502 default \u2502 virtual \u2502              \u2502\n\u251c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n\u2502 test    \u2502 virtual \u2502 pytest       \u2502\n\u2502         \u2502         \u2502 pytest-cov   \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n</code></pre> <p>Note</p> <p>The output may have more columns depending on your environment configuration.</p>"},{"location":"tutorials/environment/basic-usage/#locating-environments","title":"Locating environments","text":"<p>To see where your current environment is located you can use the <code>env find</code> command.</p> <pre><code>$ hatch env find test\n/your/path/Application Support/hatch/env/virtual/yourproject/twO2iQR3/test\n</code></pre> <p>Note</p> <p>That path is what you would see on macOS but differs for each platform, and is configurable.</p>"},{"location":"tutorials/environment/basic-usage/#launching-a-shell-within-a-specific-environment","title":"Launching a shell within a specific environment","text":"<p>If you wish to launch a shell for a specific environment that you have created, like the previous <code>test</code> environment, you can use:</p> <pre><code>hatch -e test shell\n</code></pre> <p>Once the environment is active, you can run commands like you would in any Python environment.</p> <p>Notice below that when running <code>pip list</code> in the test environment, you can see:</p> <ol> <li>That you package is installed in editable mode.</li> <li>That the environment contains both <code>pytest</code> and <code>pytest-cov</code> as specified above in the <code>pyproject.toml</code> file.</li> </ol> <pre><code>$ pip list\nPackage     Version Editable project location\n----------- ------- ----------------------------------------------------\ncoverage    7.4.1\niniconfig   2.0.0\npackaging   23.2\npip         23.3.1\npluggy      1.4.0\npytest      8.0.0\npytest-cov  4.1.0\nyourproject 0.1.0  /your/path/to/yourproject\n</code></pre>"},{"location":"tutorials/environment/basic-usage/#conda-environments","title":"Conda environments","text":"<p>If you prefer to use Conda environments with Hatch, you can check out the hatch-conda plugin.</p>"},{"location":"tutorials/testing/overview/","title":"Testing projects","text":"<p>The <code>test</code> command (by default) uses pytest with select plugins and coverage.py. View the testing configuration for more information.</p> <p>The majority of projects can be fully tested this way without the need for custom environments.</p>"},{"location":"tutorials/testing/overview/#passing-arguments","title":"Passing arguments","text":"<p>When you run the <code>test</code> command without any arguments, <code>tests</code> is passed as the default argument to <code>pytest</code> (this assumes that you have a <code>tests</code> directory). For example, the following command invocation:</p> <pre><code>hatch test\n</code></pre> <p>would be translated roughly to:</p> <pre><code>pytest tests\n</code></pre> <p>You can pass arguments to <code>pytest</code> by appending them to the <code>test</code> command. For example, the following command invocation:</p> <pre><code>hatch test -vv tests/test_foo.py::test_bar\n</code></pre> <p>would be translated roughly to:</p> <pre><code>pytest -vv tests/test_foo.py::test_bar\n</code></pre> <p>You can force the treatment of arguments as positional by using the <code>--</code> separator, especially useful when built-in flags of the <code>test</code> command conflict with those of <code>pytest</code>, such as the <code>--help</code> flag. For example, the following command invocation:</p> <pre><code>hatch test -r -- -r fE -- tests\n</code></pre> <p>would be translated roughly to:</p> <pre><code>pytest -r fE -- tests\n</code></pre> <p>Note</p> <p>It's important to ensure that <code>pytest</code> receives an argument instructing what to run/where to locate tests. It's default behavior is <code>.</code> meaning that it will exhaustively search for tests in the current directory. This can not just be slow but also lead to unexpected behavior.</p>"},{"location":"tutorials/testing/overview/#environment-selection","title":"Environment selection","text":""},{"location":"tutorials/testing/overview/#single-environment","title":"Single environment","text":"<p>If no environment options are selected, the <code>test</code> command will only run tests in the first defined environment that either already exists or is compatible. Additionally, the checking order will prioritize environments that define a version of Python that matches the interpreter that Hatch is running on.</p> <p>For example, if you overrode the default matrix as follows:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\n\n[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.11\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\n\n[[envs.hatch-test.matrix]]\npython = [\"3.11\"]\nfeature = [\"foo\", \"bar\"]\n</code></pre> <p>the expanded environments would normally be:</p> <pre><code>hatch-test.py3.12\nhatch-test.py3.11\nhatch-test.py3.11-foo\nhatch-test.py3.11-bar\n</code></pre> <p>If you install Hatch on Python 3.11, the checking order would be:</p> <pre><code>hatch-test.py3.11\nhatch-test.py3.11-foo\nhatch-test.py3.11-bar\nhatch-test.py3.12\n</code></pre> <p>Note</p> <p>If you installed Hatch with an official installer or are using one of the standalone binaries, the version of Python that Hatch runs on is out of your control. If you are relying on the single environment resolution behavior, consider explicitly selecting environments based on the Python version instead.</p>"},{"location":"tutorials/testing/overview/#all-environments","title":"All environments","text":"<p>You can run tests in all compatible environments by using the <code>--all</code> flag. For example, say you defined the matrix and overrides as follows:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\"]\n\n[tool.hatch.envs.hatch-test.overrides]\nmatrix.feature.platforms = [\n  { value = \"linux\", if = [\"foo\", \"bar\"] },\n  { value = \"windows\", if = [\"foo\"] },\n  { value = \"macos\", if = [\"bar\"] },\n]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\"]\n\n[envs.hatch-test.overrides]\nmatrix.feature.platforms = [\n  { value = \"linux\", if = [\"foo\", \"bar\"] },\n  { value = \"windows\", if = [\"foo\"] },\n  { value = \"macos\", if = [\"bar\"] },\n]\n</code></pre> <p>The following table shows the environments in which tests would be run:</p> Environment Linux Windows macOS <code>hatch-test.py3.12-foo</code> <code>hatch-test.py3.12-bar</code> <code>hatch-test.py3.11-foo</code> <code>hatch-test.py3.11-bar</code>"},{"location":"tutorials/testing/overview/#specific-environments","title":"Specific environments","text":"<p>You can select subsets of environments by using the <code>--include</code>/<code>-i</code> and <code>--exclude</code>/<code>-x</code> options. These options may be used to include or exclude certain matrix variables, optionally followed by specific comma-separated values, and may be selected multiple times.</p> <p>For example, say you defined the matrix as follows:</p>  pyproject.toml hatch.toml <pre><code>[[tool.hatch.envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\", \"baz\"]\n</code></pre> <pre><code>[[envs.hatch-test.matrix]]\npython = [\"3.12\", \"3.11\"]\nfeature = [\"foo\", \"bar\", \"baz\"]\n</code></pre> <p>If you wanted to run tests in all environments that have Python 3.12 and either the <code>foo</code> or <code>bar</code> feature, you could use the following command invocation:</p> <pre><code>hatch test -i python=3.12 -i feature=foo,bar\n</code></pre> <p>Alternatively, we could exclude the <code>baz</code> feature to achieve the same result:</p> <pre><code>hatch test -i python=3.12 -x feature=baz\n</code></pre> <p>Tip</p> <p>Since selecting the version of Python is a common use case, you can use the <code>--python</code>/<code>-py</code> option as a shorthand. For example, the previous commands could have been written as:</p> <pre><code>hatch test -py 3.12 -i feature=foo,bar\nhatch test -py 3.12 -x feature=baz\n</code></pre>"},{"location":"tutorials/testing/overview/#measuring-code-coverage","title":"Measuring code coverage","text":"<p>You can enable code coverage by using the <code>--cover</code> flag. For example, the following command invocation:</p> <pre><code>hatch test --cover\n</code></pre> <p>would be translated roughly to:</p> <pre><code>coverage run -m pytest tests\n</code></pre> <p>After tests run in all of the selected environments, the coverage data is combined and a report is shown. The <code>--cover-quiet</code> flag can be used to suppress the report and implicitly enables the <code>--cover</code> flag:</p> <pre><code>hatch test --cover-quiet\n</code></pre> <p>Note</p> <p>Coverage data files are generated at the root of the project. Be sure to exclude them from version control with the following glob-style pattern:</p> <pre><code>.coverage*\n</code></pre>"},{"location":"tutorials/testing/overview/#retry-failed-tests","title":"Retry failed tests","text":"<p>You can retry failed tests with the <code>--retries</code> option:</p> <pre><code>hatch test --retries 2\n</code></pre> <p>If a test fails every time and the number of retries is set to <code>2</code>, the test will be run a total of three times.</p> <p>You can also set the number of seconds to wait between retries with the <code>--retry-delay</code> option:</p> <pre><code>hatch test --retries 2 --retry-delay 1\n</code></pre>"},{"location":"tutorials/testing/overview/#parallelize-test-execution","title":"Parallelize test execution","text":"<p>You can parallelize test execution with the <code>--parallel</code>/<code>-p</code> flag:</p> <pre><code>hatch test --parallel\n</code></pre> <p>This distributes tests within an environment across multiple workers. The number of workers corresponds to the number of logical rather than physical CPUs that are available.</p>"},{"location":"tutorials/testing/overview/#randomize-test-order","title":"Randomize test order","text":"<p>You can randomize the order of tests with the <code>--randomize</code>/<code>-r</code> flag:</p> <pre><code>hatch test --randomize\n</code></pre>"},{"location":"blog/archive/2023/","title":"2023","text":""},{"location":"blog/archive/2022/","title":"2022","text":""},{"location":"blog/category/release/","title":"Release","text":""}]}
\ No newline at end of file