From 0b535ebfe82db37fd442ce2935a980d731f53acc Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 01:19:45 +0530 Subject: [PATCH 01/15] icons: added and other enhancements --- docs/source/_static/INFO.md | 2 ++ docs/source/_static/hckr-logo-black.png | Bin 0 -> 3844 bytes docs/source/_static/hckr-logo-white.png | Bin 0 -> 3899 bytes docs/source/conf.py | 16 +++++++++++++++- 4 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 docs/source/_static/INFO.md create mode 100644 docs/source/_static/hckr-logo-black.png create mode 100644 docs/source/_static/hckr-logo-white.png diff --git a/docs/source/_static/INFO.md b/docs/source/_static/INFO.md new file mode 100644 index 0000000..05c2c07 --- /dev/null +++ b/docs/source/_static/INFO.md @@ -0,0 +1,2 @@ +# Logo +* logos are created using template https://app.logomakr.com/2gTgc1 diff --git a/docs/source/_static/hckr-logo-black.png b/docs/source/_static/hckr-logo-black.png new file mode 100644 index 0000000000000000000000000000000000000000..a5eda5ebfd71939ad14e47147314ca5480b56efa GIT binary patch literal 3844 zcmeHKS5(v4w+c@ceI44O_dTsR8LnoBqT`y_59GPk44J}VVGU-FGFP$(TAyV2e*Vc zyB#|^GR6W34(>jj*bV4 z>=FqTta{{Oibd%=g{nR?6T%r?A8eYgu#a>t;(fDB5vz@CR=dxTs?|8@t48NHCNkEb z;*Zcm;2f37t7g2~cJ!TwL~l{0twv|7x1PstDm5xL|ps114iC zueT#=mhT!wHHaTH;NvJuwX_lD45Za zyzSp9DL}6o1?c@Sri&(FtWI^!nMtmLC7Z+~STF^a3K**%)-^C(`^RN(6vPkRyPPykzs)z-ah+Ym6y2MnWOzFOVwBs2Fo`BS7r1(AgLKpk^0mn zSnXKA2HI9Ky+t{K%f`+&&vPJ&l!P@ma z3L@dS;nKF(S58x&Rn$J#d%`vdq8Dq}RdPO8hFY>byfdv(XEf!un5v3tE==P5)bnK9 zVwmZ^+-WI>ezo4ah;!XU0x5Y~nc0wg(vS0WqRe}HF7?wP>H)9{_CD`zNHySkNMm^@ zo zP%S6IlVL{oD`_ivK#Yfv;%RE7-A^<3;X_0;Chk z$B&JI_?kit*H4JP_sG^~8>oA4pG%$cjKvdF%NPspJsIwtt5b&I;h|bHZCz`)OCOaz z#HbSyC?zT$9>NcuPjihp z|Iz2h{HpD=wDDONlT;y%RpU?h`DKcd_$dV}`6`SyI7ordWW3YQf8iT-(nj*)tL<#H3(y#R%JO4RLlz zmrwYuMK&zHvD#tfmr;BVy{PIzmdXyFDtWRM<9;<@V@(LWQI;H9)aR<=x{k?h zGS9wgK+T<`9-TPCa(tqpee~n0cv%}g1A|lW$LCCIJkmRS`#hE?Q}e>vDE}WbujPAR zQ3+ePA8(@`1XL~HlY!ro=QDtzbkhu7Gm`JADv_dNbUycHuMV|&wyXDbyG8xZmX0i2 zg;kA=MRhun=4!e5cuiKtc_-8`Wjy~NRngw2ryk$j>Eu#>(!8|2(qN{EZTB>_Lu&@X z_F6pKoJ1ectQ|78nDwaQ;Suy2QK#>A@@y=Od(0wG`AvXQJR&e-5l*SoG_j);a~@SJ zB@NE9p3b*ZXz3Q)oe=+E+_%iYjHYjq#oKPNKvntFdOJpP8P7lr*~yJV9sxaOc20b# zDh~m|C|dJByJPuHRGxena_c!Y7-c|hh8tn<*$OPIOuIBY9Og_<%2LAyc)x6B=#eDj zW|!+MJ@v{z4a1C@b&Yrcr?7}OUq(UHzUm+rs%?esX>v=_&bVOt>Xb#p`gIf?h5a1= za!g8;Q$gv-E%<_1uok28*8a3YhWTBZOLu0!FUI7)8%Rhe$Z!_QBPJsZXk-SP7z9ZL zT8#eAQVL#YbKp77L2Q2%%T^+|!uYyNrU~6xE1tGFk-oS(+$hSb7&qK%b7bKW@6}6; zhBJYun-zkD17vYPTMbN&5jz~)ZM$uM&^oSCq6m1Itf#s<9(cQ~4F zeZFubGmw>VYT<;XP|D&BEdNCU(PB-=Y&hwM3|l9oM^VcBS~V~#9j<2;^Yw~ippM?y z=QG`HJJcMzQI+xK^Ur~dTfSMU_1-8KW?qG%&7X0*K9frenS!A%-qq~Mv6RBi&J!K{)*Cx(m|}ZrKtA}uV41U4D-jvgTvrPZG#JuF2>_a=31r~-j#ZJ z-U;F#Qe7Kuk35&^rm4mo3N0Hvc9&+Ib7E*WauH*EJ4b#uk&bBhJcK#3Vp?6S zEz(-I%NKlbv?m3=D7Dj0xH9URP2McVL27+itEBx8(~sO^VGu2aYRn#`c(B2>fQYG4 z4xM~-^0F+;O*c2kc}w|)CcSaLKVa^jy^UNTT#uW=@D;tTS!>zlH9IqU>4TIR3f@4* zxbXbo#BGZcs=+@gw4$04d;54}i|31@7GA5I_vM9x}4bP7QHq2Z& z7cA22IpA5?C6CuR<R%Om zo`>7R(w+1xt#_ZiMH#9y<$Y%ruKReOW8pvdy}%Qf%UvB;X%Thqj(Vw21m7UxXv<*L zR~52e)cQ6*PN65o<#)Xz6x&@KS_P?Edk<;=UB z0l$w96Wuc%XJP@7a&IC0= z{%goB`s!2GJ^1xBgNUKB@0>!Hf91)mP9IEO-U<)79?4&G8|~N2y=I%RXqsONy^D$l zQhtew$2bT>+u`1m=+1Ny)u8LdIbkOO-E=6A|4j%BrYu5A`k`I|Zb?W#E+H&0szgUd zm|iM{3t{e<$&(@|LpqtF~=>XLUIascw4d)^+fk-Ibl)NSE>1bKe=wJ)CiJ z>;C3;4f9Ua-pvl4uoy=v?37;9qt5z>ko^eeOurqUS=ijA?CYbWEhM!o!F|#*el`LZj9}QxK10sRZXb&)jctpE3 z4lOC@zBr=N0f^o4XdqjtA^d+2%D_m967F>We9D>z#jqi$MB*g5jjc3DgoH?=NlOSN zV_`Mv3j`f{E5c~nc4d$AalvgJ8r^9kEHRudpRlKICCRvAVhRI8f#S}&$vRtBdi(Zg zm5Y!z4cSZt|5yUTqo!`)vGGHY@F!tAMyEZsz}EEuG&)*c2ov0Gbr;g891ZwikQM>c zgrQux$v?{dk3rPti7SU7ucgo=#~tA~v>bTlt&`fVV{0~)l BI$Zz& literal 0 HcmV?d00001 diff --git a/docs/source/_static/hckr-logo-white.png b/docs/source/_static/hckr-logo-white.png new file mode 100644 index 0000000000000000000000000000000000000000..687f152bac9ca6ef87353cd7c801ebd4c6ea1bc8 GIT binary patch literal 3899 zcmeH~`8U+>`^U#LvL!poHke7MN!cPa7)_Rpl-*4Io}`d`?}9{?&o!$*LBW)&i%-8amGrD?-z$a zAd>c{F|LBRC0HGzy9K){QWh%+LQ$?*8%V=@)j0@c@0vZv`g{ywv3x0^+(aJzLXLF9 z)cPB;-?<<}&Jq#Jzo5F227x)_ zE?6W;-h;#725@tGNXlMOI7Q^TlY(Y4I1PcB!=;g1#H9B2rDRFBYv>!Wj(CnmhN2UK zB^Osl#c?M-8o^@^2DN0Mm7!93xZ*yVZJgbojmbA^pq^Qhbh1Fv{!$}5ciPQFFFp0S z3Y1KK^&7|^)7gTZ6Gby5p#lxQlAOda4X=vOMZy%JQ^zg-{O+4c%z4`YChhF3URMc6 z$iTj83Vd`*9oaKH930>vo}!<^ncV&>kE>q$d*f()ni>rLK~V@3exGyjFpMeaK;9%e z73~9)=G3nldIS+HA)V2S#@#WQ3McmqI72 znxzlgz_VUxYm~YWadsE z(6#;GE;e0KP>0$AXl?E)sgbq}qm%)^_7;%$z1lE!s`4hfJN1|wkPyy39x8G6sAwQO zzX{{(Mxrh%d(&-6ju3zyO3@pWODXz6qVOt?rL#=VKme7Hj^MJ9o)hb1X@4wor@n7< z_TT^Od_-+?^5Y zrh1_#ehs8`t0$Cd?Y_!QkX8c%A{}Vkah;);Upif~3n}->12c2M6EGVjaqqdR1;IJ9 z!xkQ7lN8z{D5|}cm{-Az=qwAwk_1j9p=N~Ysl7fq|8tMv!t)NqDI`=#aqFfOliO9O zgNeCR;w*#b9Ebm zHsQZUA9rS2>0FN+=a1F34qvvKRgL_Y6N>3Vff3%x0XzXC>w}YtP-d|zG~r?i3PYBTT%W)BD&`*e z(Wp%`Cbuyf(}i-nKujFl;ZlF1=1eozkaoom+*2AKaT_8EYzLLMB0zO1?MKasd4*jc zN(Nt2tpIY@n2 zg8Ct6Ibm*rA+69ujQmow!upLqWVuZdE@TE zP1hX{?du~<39o09-()zVapTr(InLih>0PrSK|ob;KjaxL>-+I$lg`x}7XmU}PPV_K1)85weW33-^llgN8j}vsKzRsxfm63rj|`KKP(qp{0_An4L;FQB z5wE&D2IpQ9JmN#!wYSGU(q>|})`nP&U-TL21*O+U46H|ig>fgn6sm6~QFCjhC6_o4 z&|P>SY*j7EmP8C!$KNy_bZd)l^b>yBA%lO2%bymqq$r|jBd2&O4u{`z>C@qRy*FVh0@dhev;Lp8zul(XJdpTsG?glhZ z%K}f@;9J%QKIyT;#jng`6@_I_&ysR#d#U1_Rt{sKN8}*#=ew#n{J8v=0h8>>8??S! zRaT>B&2!yPk4+Jj=7UGGEckaiuz?-OJ3l@EI(nEtGR^+8ZgETHZvKTfEMjQWpcae4 ze{hx*{J2<^g{?%}NL1ecXr7QqnBQGa|F&=2ZXaeGM}E=i+iv%UuYFcaby(8EJJK#CfG(_&RG+{oe<+9IeJ|1OghW_WKL z{}a~8!I~$RMX-tP(th2I;aj#UW@#39HeGk&jUpev{LQhA!JI4wg#-Cxw?dpq83!F3 zt@>U(+v?z3i=^Bglgqo%@T}E2GtmZ!>PC5e^)3W|O12$(g(v25H2YS^*u=(8*-VuA z+{S0QcRKVc{;XQP&~n9<_(T4QxYCVJz1Nh*zR2hQnA#pwAl?Q$CfWBZ$WP;5d-nIR z(zTTBiU)!{JSn`wb0eg(YNn^b~Pd__=U;#KXQ9?kG5+ZfsqE3WT@rF-*NyFSgffR9Wt#g!1pPxHVX zDfEc%Yc4+Dy~CRQJ6F76aGdvH&nWIVi9AlC*Gzsiiq-MSd>_#v=N&pI5M4RynPhNQ zkKZ`;fcPyx3haPMtN!c_5@S|6@t_)ESLRo~-h3hyj#en&uu$Q!PAQ(&?YQ#PEX5wB zc_(~qazCd!ga@Tbb&UC5ozgeUf;Gh~F(jyLGell&RY(yC$7LKAzr4 zrD6N(?@L>LE3?G>Dk=>Hn0NQ6|Zj9u>_SU|3~ zUDl|03#%$P4S;+HLvJmpN8* zh=Xx7u=JE(SLikHDD2wy0DMyq7@5s&-RW5B-KFFnRT5<8O;=M3FeZ++t`95l&EFW` zu}WGszzQ zvoiOM(EGYlE2RO0ySHFXmoIL2X;b)k#qfMY*k^?Yx`_^Zjg9>dR5NeVlqh;Gj(fG( zu8w!6la`oDxc;Jl&vsW%8}yTBkRtQHAi8Y>WuRGOZ;m5jxyH{;_sHhMKsVvAW&^>% zT)VDEA4aw1l(xNdtG#&m$j*cPuKts*tM^LPEvsp!@otEvGbHL#mZC&7E`nhSd_s^H zqgUxyTkqZLcAt1NXEJBQ+tYtn$Dex4wD18BoT1lA0O$0Ajq8mcy_+%A34k>KhA&6V z&O2Bc8HU876a?R zTlRNRcBYzVTtxTDqDi(J*Qm*YFY2Jy8P)$!{NI_!rBggMdvd2|u;;O+zKt!z3;JIu z5x@ffs6tFU>mQ%((4E=;0@9zAfDJ{tw~J}uqvOZ3-{ zD-L$7u7NdW~>-5GnN4>~~riCy29rSGOdn1dh0i-e%*VsMJzb5(Vyv9ze{ zsKW8T^$3zTYW7Hj*U=9_vzn>3-KASL&&wc8pH|3Epcy%xd+o66^D4zqn+ev1cYLN&Bbc**bpQI{lmH5k z2?58h7JyxLlMw0TWL+VQ=^NZtQBWF9QhSd{`QH*7Qbb@NbpxwgFQ8$Fy`3|r!RA8h Fe*j}oG$H^1 literal 0 HcmV?d00001 diff --git a/docs/source/conf.py b/docs/source/conf.py index 334c315..d57eb2b 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -36,11 +36,25 @@ # TODO: enhance it https://shibuya.lepture.com/install/ html_theme_options = { - # "announcement": "The content of the announcement", "color_mode": "light", # light or dark "github_url": "https://github.com/pateash/hckr", "discussion_url": "https://github.com/pateash/hckr/discussions", "globaltoc_expand_depth": 1, + "nav_links": [ + { + "title": "pypi", + "url": "https://pypi.org/project/hckr/", + "external": "true" + }, + ], + "light_logo": "_static/hckr-logo-black.png", + "dark_logo": "_static/hckr-logo-white.png", + # "accent_color": "red", + "announcement":"""
+
+ Please support the project by starring it on Github +
+
""", } html_context = { From 006f76b9e5d19a870cd9d54d6546f73172d7e983 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 01:20:46 +0530 Subject: [PATCH 02/15] icons: added and other enhancements --- docs/source/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index d57eb2b..9cbb464 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -50,7 +50,7 @@ "light_logo": "_static/hckr-logo-black.png", "dark_logo": "_static/hckr-logo-white.png", # "accent_color": "red", - "announcement":"""
+ "announcement": """
Please support the project by starring it on Github
From b018c1720591642e2705d5042ea666bf197b9cc8 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 01:59:41 +0530 Subject: [PATCH 03/15] icons: added and docs pyenv created --- Makefile | 2 +- docs/source/_static/favicon.ico | Bin 0 -> 15406 bytes docs/source/conf.py | 4 +++- pyproject.toml | 24 +++++++++++++++--------- 4 files changed, 19 insertions(+), 11 deletions(-) create mode 100644 docs/source/_static/favicon.ico diff --git a/Makefile b/Makefile index d48540f..1b91559 100644 --- a/Makefile +++ b/Makefile @@ -68,5 +68,5 @@ docs-build: cd docs/ && make clean && make html && cd .. docs: - hatch run dev:docs + hatch run docs:docs diff --git a/docs/source/_static/favicon.ico b/docs/source/_static/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..766b99585f69c2b791c0248dbd54c53208bb08e5 GIT binary patch literal 15406 zcmeI33vd+m9mfw*pjZkNL6MGxmRdTtqViC%52V)d(L#al?IlR9nngp%ANV4*TVsUV6%DT-)JyneoWyXod~cgZFJl4)+{ zlYRUjzwiF{|Nd zqV_aDeZsV2MWW^nN=BXUb)@u(vbjSu#$(+jwyLyzM4GY{n_?BC^F2VWe#-Gd-otH* zn}}M^P$qREXlj$ZcE|rxh+DaFDG7q_&t0d`oObr3*3}1eRVAUb?M(^ z#=k(ESuh`d0n0%;ZilFH!!%tucjDs%+(Ys}J zy!v!vrn2(b;kT(Pox#-YeW|GZ;jttcwfCotiXrJzXCn49$AhX;>uZUqbFpW;HWjmP zNynUdM-$r9&Dc9En?d`O{jHJ)DY$o$fm~ozz_oCWDj{UdDOKZ2oPy(;RDp0vsgY4`58;}Oo!CH{s zGn7{``}Dojv$m}RuU%O&+_$YG=~e!!b9%Sec=x1XC8#b81(pA$Uf68TRWGlC#ZaRA z#q8IVS)-`)dlH5{NpXWe(l@;S;Qin^aT@Fg?+4F|*;l+wB!7QK-s@p#Ft6Nm!XJT) zbMFVQ^V*MEZaWIbJ6h+gP-1+pM)*i$P8$1pM)st12xWd8l+i2 z&0o@{a~^ZLg{hdcs56j`IycZJ$4L7tldkW>xz_C;gXTn?09#rgQM*o0xo!~WYoY1- zp#$Gzt?^t{>D*J?`Eb;JIiO$Ve~`X&e@8-^K-%1LE}*{-%@3+>CCvE9jzo=NjbeOW z&iGKPXUMPLe!C`We|Zi z=#alI{m1vUbd`Ts`M0G6y6R6`O0Vr{yUM@qW!RP+{@=>~F~jH{+~>l>Aan(Vkk;ux19+w&pyHe&w%yMC#7AK-un-A1~MzUzm_>ziOw2 z*j!oJBbcT&+Fd;%*Du=7s=?nv`RO||cil`IeM#SJwN^u0(uFO5*-{@$|8fnw-MwYb zYdOC+w=FcM%ir5;E?%+l*63G$?jBb(ejo2Z`$l>XhvoNG7`jHoa&Y~B-n~g&-w6Fc z{y7um6Z3t8y*bx+gYv`m_0q^Erf=qc4!?x2>VELoTK&qS+L$$*KInPB9?>p#ZM!-? z5Igcm9Rz(Q>;5>u2{yv%pzjd(!@od2&40rjSOD^|od()>odyR$KBsq~iSNHH`qlol zPfB0&k^c-erStS{VKM#VJuQFYI1=OseFo&KTLQlR{+!ECCqLpScpKVPzrLSv_qM!t z%rhKN|B0Pq`j-)|vcEj=ZsgaV2&yYPK-ZH&Wj_^$L%Zsy4fm)v>~hBALvGpA-&2?7 zN)xsU>8~Q}dDsrFf75>kFP-YoCm`Ql64X8hK)dTt@J%qfcV+8Mobk+lw5IGw{ac{_ zCG`9QTz^m={f7wq2-JS$e^onZSN-1pt~-yAe(KPcr18H!F6{Z`f356$&$N_tX@3~x z?{>d?@WMXJwd&mspt8Rc{sW7kCrJN0un-!}S;My94O3-{jg7YwJ z`1<7&|0bLPst-?r`pEY|{oxQ83irbwpc2%6hr+#}w(uSB_3z@`1U;+k;}4@>^MZt7 z%|W~SO(tV-9dlqy<5^BU@b#FEy%yFzW*W6cMs}Y{tidrE>QXV{m&rISAp8f zC9n_P1J$bsz#SvP=wCmT@3KrQ?Uj8!GnyWcAzI5{5G_-yDp*ef{Tiu73P0 z(5Ss~t@m&idy0$%N8Y~v zhVeHWQv5IJ8tE?{I~y9N{`mPd_x&6?rh)p4F@Bns9Em?4UWU_J5?^szqCc$v0{dq| zc^DniLi{mM3XRru3M=&6=zhOs7xZ6fp0EF5DU|+r-`6;b#y8a_^ZQ@)|1?RAp3Xec3R-)A*#l&dxxgvGjQNk6rdVUkUsd DSKMl= literal 0 HcmV?d00001 diff --git a/docs/source/conf.py b/docs/source/conf.py index 9cbb464..38db520 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -17,7 +17,7 @@ 'sphinx_click', 'notfound.extension', 'sphinx_docsearch', - 'sphinx_copybutton' + 'sphinx_copybutton', ] docsearch_app_id = "UM5HRVXATR" @@ -33,6 +33,8 @@ # html_theme = 'alabaster' html_theme = 'shibuya' html_static_path = ['_static'] +# favicons +html_favicon = '_static/favicon.ico' # TODO: enhance it https://shibuya.lepture.com/install/ html_theme_options = { diff --git a/pyproject.toml b/pyproject.toml index c428a06..aaa9a03 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -31,19 +31,12 @@ dependencies = [ "cron-descriptor", "rich", "cryptography", - # docs - "sphinx", - "sphinx-docsearch", - "sphinx-click", - "shibuya", - "sphinx-notfound-page", - "sphinx-copybutton", "Faker", "pandas", #To manage data and save in CSV, Excel, and Parquet formats. "openpyxl", # For handling Excel files with Pandas. "xlrd", "pyarrow", # For saving data in Parquet format. - "fastavro" # For handling Avro file format. + "fastavro", # For handling Avro file format. ] [project.urls] @@ -100,7 +93,6 @@ dependencies = [ "coverage[toml]>=6.2", "pytest", "pypi-cleanup", - "sphinx-autobuild", ] [tool.hatch.envs.dev.scripts] lint = "black --check src/ tests/" @@ -108,5 +100,19 @@ fix = "black -v src/ tests/" check = "mypy --install-types --non-interactive {args:src/hckr tests}" cov-xml = "coverage xml" pypi-clean = "pypi-cleanup -u pateash -p hckr --do-it" + + +[tool.hatch.envs.docs] +dependencies = [ + # docs + "sphinx-autobuild", + "sphinx", + "sphinx-docsearch", + "sphinx-click", + "shibuya", + "sphinx-notfound-page", + "sphinx-copybutton", +] +[tool.hatch.envs.docs.scripts] # --pre-build makes sure we get latest changes even if we modify something in docs = "sphinx-autobuild -a --port=0 --open-browser docs/source docs/build --watch src/hckr --pre-build 'rm -rf docs/build'" From 3950c7e628c9ff74e4980c2d786eb8584711668b Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:08:59 +0530 Subject: [PATCH 04/15] icons: labels updated --- .github/labeler.yml | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/.github/labeler.yml b/.github/labeler.yml index be74483..47d93fb 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -1,9 +1,9 @@ # Add 'label1' to any changes within 'example' folder or any subfolders -docs: +documentation: - changed-files: - any-glob-to-any-file: docs/** -deps: +project-config: - changed-files: - any-glob-to-any-file: pyproject.toml @@ -15,10 +15,37 @@ github-actions: - changed-files: - any-glob-to-any-file: .github/** -core: +enhancement: - changed-files: - any-glob-to-any-file: src/** # Add 'feature' label to any PR where the head branch name starts with `feature` or has a `feature` section in the name feature: - head-branch: ['^feature', 'feature'] + +fix: + - head-branch: ['^fix', 'fix'] + +release: +- changed-files: + - any-glob-to-any-file: src/hckr/__about__.py + +crypto: +- changed-files: + - any-glob-to-any-file: src/hckr/cli/crypto/** + +cron: +- changed-files: + - any-glob-to-any-file: src/hckr/cli/cron.py + +data: +- changed-files: + - any-glob-to-any-file: src/hckr/cli/data.py + +hash: +- changed-files: + - any-glob-to-any-file: src/hckr/cli/hash.py + +utils: +- changed-files: + - any-glob-to-any-file: src/hckr/cli/utils/** From 37fc7c93b6e248cb3463f17c8c703f4ad91199ff Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:14:56 +0530 Subject: [PATCH 05/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0eb8d56..2b76daf 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -18,4 +18,4 @@ sphinx: python: install: - method: pip - path: . + path: .[docs] From 279a48564a2ebdd6bb840d35f6935b737a02a4d7 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:19:54 +0530 Subject: [PATCH 06/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 2b76daf..6a0b8aa 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,6 +10,9 @@ build: os: ubuntu-22.04 tools: python: "3.12" + commands: + - pip install hatch + - hatch shell docs # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -18,4 +21,4 @@ sphinx: python: install: - method: pip - path: .[docs] + path: . From aeed389da595b79337347b910adbd6fd93b3e658 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:21:59 +0530 Subject: [PATCH 07/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 5 ----- 1 file changed, 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 6a0b8aa..c1ab407 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,8 +17,3 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/source/conf.py - -python: - install: - - method: pip - path: . From 1be8783e38d8f83457c1f93cc145e0a044c42732 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:24:48 +0530 Subject: [PATCH 08/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c1ab407..f82ad4a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,8 +11,11 @@ build: tools: python: "3.12" commands: +# providing commands manually as we need to use hatch 'docs' env - pip install hatch - hatch shell docs + - cd docs + - make html # Build documentation in the "docs/" directory with Sphinx sphinx: From 0657a0a8c7c875213966b261567a2de45f62bb3b Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:26:53 +0530 Subject: [PATCH 09/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f82ad4a..c1c68ba 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,9 +14,7 @@ build: # providing commands manually as we need to use hatch 'docs' env - pip install hatch - hatch shell docs - - cd docs - - make html - + - python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/source/conf.py From ca8f544d80efd92fa1a5a6482ff8593e8230d9a0 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 02:29:53 +0530 Subject: [PATCH 10/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c1c68ba..d8b043a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,7 +14,12 @@ build: # providing commands manually as we need to use hatch 'docs' env - pip install hatch - hatch shell docs +# the following commands are same as default commands + - python -m pip install --upgrade --no-cache-dir pip setuptools + - python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext + - python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir . - python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html + # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/source/conf.py From 7f763b3ea0df7146b5e3d75f17794391a5517af7 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 11:36:00 +0530 Subject: [PATCH 11/15] icons: asking readthedocs to install docs dependencies --- .gitignore | 1 + .readthedocs.yaml | 4 +--- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 993bf76..400fd79 100644 --- a/.gitignore +++ b/.gitignore @@ -117,3 +117,4 @@ output.txt # faker outputs output/ !output/.gitkeep +_build/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d8b043a..38922b9 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -18,8 +18,6 @@ build: - python -m pip install --upgrade --no-cache-dir pip setuptools - python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext - python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir . - - python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html - -# Build documentation in the "docs/" directory with Sphinx + - python -m sphinx -T -b html -d docs/source -D language=en . $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/source/conf.py From dc966f4b6b7d5ef35e88c0b58538d32c6cfc9ec6 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 11:40:23 +0530 Subject: [PATCH 12/15] icons: asking readthedocs to install docs dependencies --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 38922b9..c4c8870 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -18,6 +18,6 @@ build: - python -m pip install --upgrade --no-cache-dir pip setuptools - python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext - python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir . - - python -m sphinx -T -b html -d docs/source -D language=en . $READTHEDOCS_OUTPUT/html + - python -m sphinx-build -b html docs/source $READTHEDOCS_OUTPUT/html sphinx: configuration: docs/source/conf.py From b59429ecb1cbafffc86b88d8ceda89273ece5744 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 11:51:56 +0530 Subject: [PATCH 13/15] icons: requirement.txt added --- .readthedocs.yaml | 16 ++++++------ Makefile | 4 ++- docs/requirements.txt | 8 ++++++ hatch-env-docs-requirements-sync.py | 39 +++++++++++++++++++++++++++++ pyproject.toml | 2 +- 5 files changed, 58 insertions(+), 11 deletions(-) create mode 100644 docs/requirements.txt create mode 100644 hatch-env-docs-requirements-sync.py diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c4c8870..0eb8d56 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -10,14 +10,12 @@ build: os: ubuntu-22.04 tools: python: "3.12" - commands: -# providing commands manually as we need to use hatch 'docs' env - - pip install hatch - - hatch shell docs -# the following commands are same as default commands - - python -m pip install --upgrade --no-cache-dir pip setuptools - - python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext - - python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir . - - python -m sphinx-build -b html docs/source $READTHEDOCS_OUTPUT/html + +# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/source/conf.py + +python: + install: + - method: pip + path: . diff --git a/Makefile b/Makefile index 1b91559..d28caac 100644 --- a/Makefile +++ b/Makefile @@ -10,8 +10,10 @@ env-clean : env-show : hatch env show +hatch-docs-deps-sync: + python hatch-env-docs-requirements-sync.py # this will sync the dependencies automatically -sync : +sync : hatch-docs-deps-sync hatch run cowsay -t "Syncing Dependencies" && echo "Synced.\n=============" # install cli in local for testing, change code an it will be automatically reflected in UI diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..7094748 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,8 @@ +sphinx-autobuild +sphinx +sphinx-docsearch +sphinx-click +shibuya +sphinx-notfound-page +sphinx-copybutton +tomli diff --git a/hatch-env-docs-requirements-sync.py b/hatch-env-docs-requirements-sync.py new file mode 100644 index 0000000..6a6c5de --- /dev/null +++ b/hatch-env-docs-requirements-sync.py @@ -0,0 +1,39 @@ +import tomli + +# this is needed as we want to use hatch.docs env for all doc dependencies +# but readthedocs can't use hatch env and we have to either provide setup.py or requirement.txt +# using this script we are syncing requirements.txt from docs dependencies automatically +# this is build as part of the `make sync` command + +def generate_requirements(hatch_env='docs'): + # Path to your pyproject.toml + toml_file_path = 'pyproject.toml' + + try: + # Open and read the pyproject.toml file + with open(toml_file_path, 'rb') as toml_file: + toml_data = tomli.load(toml_file) + + # Extract dependencies for the specific Hatch environment + dependencies = toml_data.get('tool', {}).get('hatch', {}).get('envs', {}).get(hatch_env, {}).get('dependencies', + []) + + # Write dependencies to requirements.txt + if dependencies: + with open('docs/requirements.txt', 'w') as req_file: + for dependency in dependencies: + req_file.write(f"{dependency}\n") + print("requirements.txt generated successfully.") + else: + print("No dependencies found for the specified environment.") + + except FileNotFoundError as e: + print("The pyproject.toml file was not found.") + raise e + except Exception as e: + print(f"An error occurred: {e}") + raise e + + +if __name__ == "__main__": + generate_requirements() diff --git a/pyproject.toml b/pyproject.toml index aaa9a03..8942062 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -104,7 +104,6 @@ pypi-clean = "pypi-cleanup -u pateash -p hckr --do-it" [tool.hatch.envs.docs] dependencies = [ - # docs "sphinx-autobuild", "sphinx", "sphinx-docsearch", @@ -112,6 +111,7 @@ dependencies = [ "shibuya", "sphinx-notfound-page", "sphinx-copybutton", + "tomli" ] [tool.hatch.envs.docs.scripts] # --pre-build makes sure we get latest changes even if we modify something in From 2207de4be5fed676f4c317c8291132dfafd1d6a0 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 11:52:49 +0530 Subject: [PATCH 14/15] icons: requirement.txt added --- Makefile | 2 +- .../hatch-env-docs-requirements-sync.py | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename hatch-env-docs-requirements-sync.py => docs/hatch-env-docs-requirements-sync.py (100%) diff --git a/Makefile b/Makefile index d28caac..960ed43 100644 --- a/Makefile +++ b/Makefile @@ -11,7 +11,7 @@ env-show : hatch env show hatch-docs-deps-sync: - python hatch-env-docs-requirements-sync.py + python docs/hatch-env-docs-requirements-sync.py # this will sync the dependencies automatically sync : hatch-docs-deps-sync hatch run cowsay -t "Syncing Dependencies" && echo "Synced.\n=============" diff --git a/hatch-env-docs-requirements-sync.py b/docs/hatch-env-docs-requirements-sync.py similarity index 100% rename from hatch-env-docs-requirements-sync.py rename to docs/hatch-env-docs-requirements-sync.py From 38e844ca79f461c2042df843edb7d574bbe2c1e0 Mon Sep 17 00:00:00 2001 From: Ashish Patel Date: Sun, 23 Jun 2024 11:53:08 +0530 Subject: [PATCH 15/15] icons: requirement.txt added --- .readthedocs.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 0eb8d56..b5a24c6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,3 +19,4 @@ python: install: - method: pip path: . + - requirements: docs/requirements.txt