From 6740e286c1b524853efaaf43ae7d6bd9d0ae082d Mon Sep 17 00:00:00 2001 From: Dang Khoi Vo <60619082+dangkv@users.noreply.github.com> Date: Tue, 21 May 2024 22:46:33 -0400 Subject: [PATCH 1/3] feat: add photos and readme guidelines (#15) * feat: add photos and readme guidelines * test: md preview * test: md preview 2 * test: md preview 3 * test: md preview 4 * test: md preview 5 * test: md preview 6 * test: md preview 8 * test: md preview 9 --- README.md | 39 ++++++++++++++++++++++++++++------ media/iracing-garage-logo.png | Bin 0 -> 5851 bytes media/iracing-garage.png | Bin 0 -> 4196 bytes media/logo.png | Bin 0 -> 7383 bytes 4 files changed, 33 insertions(+), 6 deletions(-) create mode 100644 media/iracing-garage-logo.png create mode 100644 media/iracing-garage.png create mode 100644 media/logo.png diff --git a/README.md b/README.md index 7ce1eaf..4da1558 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,34 @@ -## Contribution -### Start here - how to setup -1. setup your credentials .env file -2. install package requirements (3.10.0) +

-## Standards -1. black python +> [!NOTE] +> This package is not officially launched on pypi yet + +iracing-garage +============ + +`iracing-garage` simplifies extracting data from iRacing API. The package includes all iRacing API endpoints. + +## Installation + +```bash +pip install iracing-garage +``` + +--- + +## Wiki + +Do you need some help? Check out the articles on the [wiki](wwww.google.com). + +--- + +## Contributing + +Please take a look at our [contributing](wwww.google.com) guidelines if you're interested in helping! + +--- + +## License +You can check out the full license [here](LICENSE) + +This project is licensed under the terms of the **MIT** license. diff --git a/media/iracing-garage-logo.png b/media/iracing-garage-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..32ba503c3e37e8bb5f8005862ca7ebd92bc77b9e GIT binary patch literal 5851 zcmbtYbzD@-+dsR@0+LHC-3`)6N|!V&4bq*uNGKK|jRK2w*QG&H8c8WpN~8n=bZ1EXXcqX^POj&Idd^}u?V!PJaBaa0Cja902crNY=9I50YDgZ zdC`ENS5IRMru~DhFqrF4888Nuf&VS<8jf{U9%JxI)G+r;JAXg10U! zP`@zcrNt;9 zAdLL2!wl7>78~bc1|Wcd05A*!!{nV5{9E8ZAP6G+v3=|;>fpg?oAk&ZLp?8!tl$00 zE??RF@a^l51;lZf$KG$1{o8hqgt1J=M}A~O5ewdTrT+8+`N5zp`P9l&uXik4|8a5| z+lOpjYo+^lZ(LP_5J}1U9+pkD>dcPoP;PnMJ+9wi5Vv|OxMCI7=KU<0A9+=bueZv+ zwA-9wz}CxxQ%8wbTkK$OUH(c1ZLDe%WuRC(bPB}0bK4$0|7|)$b)-2WrH=5en!jm zX+H1W?v^k->qfY)(3@Al;naP2&I%&nh zzhOC>B`b{!;;K&J<0@cO8W%@5Njv+2m2Tc`jqB7AbpLWXK1GNQ!CLHCox*&wrHaNX>;n4KrK66e&{6f%pyjAWh!ByGto}^bw$%m zdJgJ576D%{;L1suY0V0qmipBe^Bt!7Hcm1sGaxs+v;^h-k-~iIK-gR&jMLPETirg+ zuVHvVvmo_mMg46BYeyfW@uAdV;aUavW3~}j6;6RP3MUZFEBoCUM<`s7i|5yni*j|P ztn9C^@(@T_= zWFx*kXRinQQ7-wgI8a*RVBdk$MLG~;R?LB#zLAX^zp3kJaD6#SnlLWwz6%{9EjMEh zk!3L4tE1j6V3RhsY*Vs`id|wLc7!MufCheQ`4jqBB*c>U;i|lJn3cGt$DegHv-CM? zes?|m)Ihzu){de%CeJjc)J!nthM=9{CP7@CAEB3RKi`kLzO3{zg)f9DSL(Bs*GulP z!CQxSb!cam(kEcSCfO4s#6Bkt5SL>X%@-dW=+OHK7OUQ}t*A$txpLhwgl7`h>mhhW zlI$glerQ)cIYf+4?@?{~!1TLg@axy6$EUg>zg*|cLv+~|?}cl~aAks#?IrUR=ATI_ zM#b*cN71Vn8QozcCUvP+{KS-xl=E983(ySF{xwnqNnX~)Fd~3ig~1>Q2pf$5HzQyG zLPAQ$EQAFkXOUN6LPA*ug+=rb`UbXMSDb(^IXU+GQUAPdXW~~iy@jK0q43U=txQfb zyM-A?+6h^o6d4X@*nP%Z`%lzeJ?#ZY6?Y94be*3@G3DisDp!H*p=(*o-=4p!5p_>! zppLbl9m?pbUf(nJBH=~SK4s{%-tCg?=_#uHox9xgnM64jnz$ber>Z zdk}fVM|Z9mu^~2Qo?c|0#lEVp1Z_w5sFn%5l2*0J%;(@U=bg|he{mpOH11TGZdz;n zAZWs3`Y_QbuR}et=DY7*f2RT~LD>lz(>>mr;qI)>!S;hJ`zF7Mr*J79wcwfY1S?y~ z)s<`v6Ox#f4uWw894HR-cci-vasUYw;~XqP3gp7_2wN`{Hk?T$h*eM#nLD~j!FD5f z`?sHf0Bkw%Sqr;UW6{V+HO)5D+H_RYZeHF{sz1I-zxP;t&UmVNHARm9woFv7E6)3N zyC?2w&dGA)U~UyPy!o8W!20IN!U-7mHqP5}Xn45YU7OvscSes}kBklb<7(&P-G-iO zKE-1*`pCWf3!Q2Z_MOS%oM&B(LA1F_$95`7-^2a%xyYTm;sQ(SUO02k2xqXnf7Oyf zoBQ~SM{#BxGYjT5OcEq>>AxnDvzmS=HX*8j!@|_qxRTH*r^)@$>#;W6CJ;;O$%LV> z$uGJ>x2cweq+C1npi+nP%?Sl%UyJ9iH@CkZM4WN2n%p;%Z&}8-FIpM?AHQl~v;aWZ8 zbknQ$ENi-31_YjYv{9;#&BD(v0P`e!+oO=i2xBGgq&rcaW2XWc%CGYVJ8MWqmt@>@ zXjnB+qUBBIj?~d1(QEo~RDNtJZ{OD(lITR3I&3Ij=XkFk^Lc!KtAr;a8BArR*~pic z;lC0#<0+Yt->+Xla26{_-+0ExW<9Yl*`AJ5ocys%fd1N$S z!$ax#xP)jY>Xx77itbyt#wk$kKK2}Vt!J%+XIHNs3dGclG^=qkH9A;A< zklTgbk4KRHk(sy^5q>02E%)zdd*FSZ&??2y9N~=G|wA~ z6tBK-OYLD|*5Su@G1DMRc`>ndJF`Ol_P1WIYrHRVP!Vi@)$yDGG?2p@DGJ%FnBAxf z=JLTi=M#ncOWFRtoAmw`#-)0ATx`DKJQf1$lPP)5ZS=745>jSRcAmr43*3sB^*r(l}NQ22#y&y?4cpZqsO+tZq;;6Y*hFJvNRZft>s7JhW>hi6Q!XbeR(QAFV?5e zj`&E5$5bILQYPS=hK zH+Q}^{aj9vxCl=$uhZuys@~izBfNUeH_{9s0Q03*4f%>WyALgky(7ARWZLpz@m*d= zByQnj!ZJj)7?rjEnJh=)OT`A=#cOv+?olv5+#|~u{c7HWiyToxjadxtA>m&?CdQDczr@)rMSNy zH?hf*=L(XsaeQ{eu4_!&Iu)jI?Q+nido4Wqxf_?dQ^@X|3fh#9>nfXJ&nsY)Fi3M}UbD2?t%I*m|N zak3A8(oBS%eQ}!q6e!i{zo#|Acuv|z*b(0H;ck0-;(@&+!snLJEw~jcj^2KZdoZ&N zRD8~gng2)a+kSIqOZgdpM~xH1^QK7qbB3MJToXca#)Wyq7|I}po$LEUfB%62m)mn# zygJ)|PjL!Ze~i#K{sy$Pqrz8~gMxv;-%SKC#tvMy<;ywV{ku`QxM~bw8dER$T?^!a zMlwbkKIsWUpy52_svQyW02Y`oI8eLzkNyA9+slZ}LxSX%Rxt5wbJk{Ovvr)smReJnAwtKTr;0;rEnhkY^zrAq@ zrEJbNL+z%}7^4%M=23XL2Qnm2?2nQ=>!Gb{1(lB+-+I^K!5<~W4(4)dnzfv$7}Z2= z>|mM7x30RdyWN!bNq$%)nsl-j!x5eTji`bR@h0a?W6_U-CKCGang7SAT>RjOhNI+X za84ODq1Vec+Ts~h%MTVepOC!{ciF66nBl3R_mp~5Ye#_aXv3Run`_^|H&DB=Nb^b< zUH$~gm&eW~c z8azo|M(v02vv=&N&1I1g$-z}wdg7vn@IW{;dPOmO{X0u24<4B^kZ zDR0Z<6@(fUL{@h$Zs-29eTAL+AZySnZj3Y>sgSFdc~T6xAQM(k;hFIG z0UgHPBu$r0LZsPI z3-WV&F>I~;rZJ{cQd?BtX?E!3vFjIA?)0r&JH1oLHFEmQqUG_6g~@21Np$#3A!ln3 zw|PR!vuOrKoxh;w8Yq#bqhfjC! zSgZ(U8ONR<4c!*8Y0-s$Ji6f=uyjX>kO=QEjh@j%Z_Rqb|Cn{}$TAWY@|gk4VQu+ zhMSJikA<9Qsaj?wn=Cx)dUnbjiw+XcHCyASX$k<@lShbXE_l!|+4b7s8s9jz!@4JH z`ADdsDusHrj|6tZahZ-da0{duUcjHQkdcK#F=3Z&W79ho^yc6roVz1mj3^KTTa7Em zgIWAk)~MR2Uhm6-c(|WBfAPDiXaGx+y&WL)K{lGz;Bm_>icv55pKtgTK8D=z9RD6S zd1!C}`12xJXcyL&`EoX1u4M17eBiF3=;^lO#3k+`r|($af^+)NoSYj)N|AfrM#l@( zo>ju<@VH97ri(ruM4!upHHm7H?){>D$3#__vS_55P@Wb1O|6%WCD@8v>_z;ia$&Ju~Q#^unChV1!zjr zr?gF6m6TO<+RSow?tcvih-@g@*;}h^z-` zhM4z8Dl`@-EO5mqb*ZEbwe@Uqf9{)7_H4%T#pB}m@G15sd^*k?SKD0up@TKQ$Ru{C zKw!$8#46OC~``wg!?|xAh7jl>cfu9)@{R9d|fBm#hGoYnD|Be@ZU;T z^tAgCv(amjL>h}#eOoRKx%rG^sb9jDe{B`u>5n8E;ekvLRM>tT=_zJlBEDy}CMwwv z$!mr_vt0>H8Njt^apMqGmfnygor@)S#?^?Vrr`mU@9@~@P7{9*5?MJ65|;V3>oCvZ z8;J%N+NCM)i`sT)Qqez$s92VkE@pba%)_FQLU31iSI9KFkM;7pN4PWpAfSl|}4+H{uPIwDe6L2Feb6x`8=`@__a8yInm!eik+=t-)JiP$S0xqWi E2jQ2l5&!@I literal 0 HcmV?d00001 diff --git a/media/iracing-garage.png b/media/iracing-garage.png new file mode 100644 index 0000000000000000000000000000000000000000..b4750e07213bc293a29a1006488a4e932b067fb0 GIT binary patch literal 4196 zcmcgvc|25o7r(PH3}%KI5yjZo%pkI5$(q6pQI@1g1|dR{Eo3QMS+bPz*h-2lgR+be znVurXBUDJTJ!Od}Cf=*QC3qY|D7#6bC0f+(+2n2w_wh{PA2o5+B z0^@{&QejZIO}|9o3<3d1Y`q3}z#~u$3t`Tw~%rm=+gX_;@cK_Eh>1=1mxK zJbo@BFG7pCGN3ocp{8QLruCN?S{#1u_@Q(<^|a|&P2&5{;W{I)0^2W%y-2D5w!8KC z(y8mxhwe>yXutId7a1F>+T?Sl_AN*KKi(O{7j%R)2J{i=Dz4wYfFqzV4hSc}FMt!= zA+8yPR|lPf1jP^pl&ui6c}n4}N|V_fPD#%6dsP9OYdOess8X=h(@ zlIe&iJC-yKCMmHMLC_?z0EihFbH70YAXq4dpCC?BHIyJn8M%Fj3>51_*b3cd#hyj{ z*ty;5X|Z8u#WTHqdGDXCtA05|Cx<>{n+@A4hN^7=CUR?M^{da0sz~lQx8Eu5{i&wp zM@lZ52Ui~aky;}gG&$eHvUgG35pghEz2(^!fQkg|kOSil0)s(0en%Mu3c#@Z0t6Dq z5H7B&MvlTsP@=yZ1Kl=eU12g=xs-Piq3PyNplIb`|aMbpyW#@&vOix>9}#9!`;+(Y4wJQ z%i$>%Cw7+)E?I2t+0h&eUnX7@1w#oi2mO^Vq}P?2vf>g2lN@&4>aR0+f2wUJXmd4_ zdipEZ-RZ~Aqnp>MtxVhCN5Z*xx|_#OWs&cyor_4`Mnnq(`UMJya>7uEA3?O8Rsbvl z{F(_Q4hcy^azMH&#SJ5_W)v6|UCkK(jF&n|YybI)bLc}ik|vTb3i)Au(E@D{`tF&{ z5IdXEt}G8%V`+yMXMvxmFYzuSz-;39#j=;PO{9u=0+20 zk}RYdGpZhK0b})r)eYAog2m#6;BHG#V_ugIvi7SzOv1hG9+Kz70lqv zJbxtO2qFHh(O9al-R1cU>y(?OvZ4)X7IUHD-l2)SIrYyg^D6wb1FZ#8hm-Hl($QUX z>ZRJw-rGkjD*QzHsJIWeg95tIVtKF7^pK?^W*wFm=cq{!n_8p+ekEP~u#PSjx|Qtx zO5dpmeorUEW+GQArW!{)mX15w8XfNqhAz2BQ1$^CH)_)BH8Vuz}uB_oScTXJ$@ z)x0^Vx!j94jUz*#4G}=!D7&5@bSJOCsdB7F%y92$T~Vw~$)jG;*VkrLwteti+MA#m zUz1Mt)xMARWkgiVwzk}RGvwemXwB>E9ror+%!tMiS?6lY)Zls_X4PXv)<>v5V0~#i z>|dVqOysyq2LU5xu-itCcY!rNtc>GJ3GQv5Dl*7RwM zlWKBqH>#nbXF&MK@S3gv zXhQ!4-KP@w#pGzpZro(TlT*@G(9GaVPYd)!P{~5&l8OOiyKZM{UFrB(Bczi$tin_f zgnk=f?Vb=I#Hwc{1ZZ+sm1yw^kVbU}Viz~Q2a!Bj6QB?{1d8|>Ltu6T2qZ(YTR^mU zI)+HA9yjoh>ihhwF6a|Bf!6*#vu+Sy5z|ZgCCpro7I8h~LMyrneU&5MpL&C@ zK5SHp6+^wo!&3=|42U+RFb>^o6vnhV_XaCnH~{5~$q(DSln!N)Zi-BEhpSS+PmI=5%fJJEku z#G>B4vcnnH_uQ+M>Jt4FuvQpp)1E+78ghHM2)U-Vcp zlJ#Pt`c6jxV|iS!+ll%m9$*5&$?|d@)WOW*OpclM!J9m*qVi3;*CLqvB^L*nf3jce zO&XY{3rpwrQSFo&Y9=<3<#po$kSZc^x@qE;9U;?v8I9|mbv_-nVn2*nV;pPa$;RJR zcgkBokeUFP$p)TQuk!3WUFZdOkbC+*srD6~b&0u8tK<=qq1Wz%xonkuCajOGs2Z+nFC(eJ&O`r=4u*>Rh08kYcZKjAC zo(foY=nNbBv;}~^{oaUyg$@8P85UCi!(k{D^FzM@UFw9n=loogxtMjeu(AxlEEh*m zzpwcmWP)qk0Ddm1wEw9k7E-stA|j3jJ5Z2*S5>f$$C3;&1aUWVK-7?~NOhc*+Y?rzNtQp%nuuYai=8PC^HR;a!ev;#@W-5t zanS4;(}#Hix`hqGGOjtQ?fU8z+!he-)9KvC-B5A!@2o*fYS9CmD#N0xfD3xEXH4jD z&CZczIjpydvwZ)iAZVn_cO$oB^j8xN8c86L-5BDA0kmpNRC?d|zbijx1K(7yxXh1# z6?inQ8t-4I9orl6*sxQrypuaio^rP?(s+qVPV(5>psIx>37r>koY1&A;hQg5qigUv z6;0Q%lwe`+hm%};Mw{>3j|^qHSce5?vns#!-VEO`coKnUXKIJ9T^l&?pjP`+=tPSQ z+U$(g`r}1cfvMnxva3VzVHel0uKdl^r}xD}h6-jOqtbwhf`2N z?pYkC4bGWlGm4S$H;y*DxgNI@&;7Xfj;q=2;wDCims1BuOYNQ=VgmVSU{o2eZX(`K zhm~4a`+;~!VZde#2KGbn?H{Ub`jxaW;sMeA=|ltC?|g;X49707c79s-BQ8fPa9I|P z^;tWJ?C;JtFEI>42!4pq8F_c~Fm|+Gx2vtcx8R23t;uX53H!W0ZDZMdc&Zj&^e;;* z%K083w*BG(IfZ^=n!YXZGd_6C!JXm^b#I;)N`DXjGXE?ogL?;sdkp_YZR5^Qh0ks zh3;)3ja#!IaASm~OZ!>aK?p5PYR%%RyZp-_5@*)s`N>re_iT2Tly~@QQVGl4<#anF)lWnBkFSmd|PdcM+kU?!n%Uw76 zyHA-++ObMg_WI}PL0J3#Z@7|J;{X#*+L(k z3W^E$sQM`4lr%ry;!^@ZxNJ7~2BMJFg!>4))R0sV+hK6#?t|%FH4=Z6#TpFuU4Gk+ zEe^ZAa&BdwZ?4j|j{9qea4o=DEOU9}%4p)%UFuqF;)e$N72eK^vAd5pM86~We7M5- z&PS#wm+Ww&P^m&FEBF8)Pbs90_xOE1=Z%5CcA?eioCvc6`emk3DAmE{L}tqM9uC&6uBalPf9(9zqXIx88UR6#@Coqqfs+1`K}ZWg z;osx@e0-q7zbxL~0sy%1FN;ISH7Nf_M*akDKLZK?3K;ySA`1jrq3BR31OmlGLqkQ! z#>B?P!o9V#7DtLe!lCHe-{6T9tAA&`k>kUS&jGnv8D8y9%pTM6+ga>2lM^WgJLPpe_2GuG$|o0a{Vtxw=`o$mE7wcH$JSU z->pYiJ8zH8eJ|KcD!Bati$CaTM^OH+2LK@VvD`*r7OvXVf#q)qcNtXPD%sPvOjGmX zY-DnmtFrxe7$7DK06S-2{AH_8vS0cH& z$ai`CvFOLECI1PzH7Ou(=JR#V(4_->9EDJD_D!4Cz{ivb0I*RG4oE@t-l$}^k*>BZ z=S}3jr^unBJYTW0w;io>{^rMndJb<0QpAyHWE{Om?DqBJhM9%3&uKY2N`~d+*~%ct zy9vdO%d40TH8ZtYOP%t{5a8eBGVp^7XnxKKess5m|KWj$^l(mm00aSnp~%Sm zI|fidU+@+L)as2c9insY=Ontf zfJIQ9Zj__7awLse3)z}fhDOfYox_~BHj8gO-i*)vXyfr{y=PmpZS-q1XKdj(i)JM; zI3*a%rd`fl$7aj75aG)`w%y;D-I76+ld~Pgy&d*?o4i`i&g+vwunhSvFfh8-;0e)g zE~lepxZvSZWgJlimYWj_S7MIjE6HDsK5}djTO6Rih7`8 z9AQ#P_Lo%qx%5e1CkK zeUqtSRC&%{!Vsk#ns+w+3)zOocB|2qTV-K=zSo8#4NtvWl$Jof-e%dGL6o%tOQO;vL zcBN%;(j#prfArG?%t7wqB1PF}L-0ieohQ@2N+TX8={FYojZR;ka`P$*mQ&^cp|!ja z`Y)D#7#9T$Jsd$abqR7I?#ul?H7)j=$p|~Hkp~wZKfsTguY`h~Q02j5G|S*b^&5(G zK_LPFgghS5P@xdy8S|%rkpmC{LSlR(27WmmT__1XpMX3glc21Pg0&aoQE1YgFCuYS z2J{;%AsZ%Af3Gl@`7O@ui;#{t2~4kMSDm$C(auK?d|fm8dHR+Mw3dh_XWlo$KH1y? z8mZ^IWWAgm*+F_senDx}bQSwAQgjz4=5GA$UfNTmwHi$C=WR-TD2d->CHsjUZtTWc zZ;g_C)T{KlAgWVDjAk|LO~S_DB|fZ5gjGk2wMkT0tM>xKfpOntD4?w7RcOtZC%1qT z2mdvOrr}o^q0|d^`Zdy@lyqiQm*2C_hapMA!wn!YA|j6U7XAQ!olR=R1Nvokh96wv z7hK_wSQ2SV6LDSdM%dT~Xxa^ePbMcKzm2%0WYt`|H2sN`3~$Uph0akKo!R`iepg&$ z%N~tqPu`7<&mRcOnAObQc;t>Xzk8kAqvQJZiRHd0ahtQ}Z^`s$GtX=9B_Xsh+xA66 ztP-0s*-G&A*p&v-C$_K&N$2ezWzI-icMezV^12M`TP*0)*ttj;;7EpwFp(I6hBRbHIYrf6oGllNL)bqP94VPodB_cbLxy_zu%1dgN^T4-nE(Q@pWtmW%1vRp0Jcf{U(gx zDee0FH9M^6rm{`C_-7JsaRHW>JHDQ4_LZ_2M!zmeslDE(BlbREqqP{gJ6BF6y}9@l{rcM@pY&>OWC`9PS|P8-Opzu~r1+_~bV_Rf8#H2E>3HRaQ@O7|kru^N@9)1|vMfu(} z89~9;IoHVgVXvkD9?}WsBlQ#SXV@NG-c+i_=q5rDQn1j-jgS&K+ltfmEdmW%ox$}% zpCEb6In^_+$lcB!S8HQ8|5zlXKh)x#`m4zhwv+_3z!=iy&sLp2VV7Z`^mtZusaV8* z_;C8oRKLM>?3i|m3A;M>@sg4=URHTo8t)M2l}Y>}vs*n? zrWRbs+g`@AP6=}})IZ667~cOL*j);tn-$mU&piEBhdogdVV&bj2N-j3=uqffSP)A@ zcDpP!s0cpN5f(4zT7=I|9IL%dMOt$fisJz=%_on05c8z>*a!7SDKc<6a}2nw)fYy+_?O z{+roD&!>x<&(c2>Ux z&a$Rh^!oD?I^L`>tExKH@Y71STVRZ5S`tmc$vR22T=?7Thx2vZR{G>PRFPG0=PO4t zf9gFH4D0kDH03ctn`xuGpKZyi7PC>^jrMxZpT%A88;0MW#qD4rX;F?db z?F$-o^gH?qecE~N%hfcU&LPrDCaJZ3hG$T+ompV;dd|S!8VyT7CUd1^ilLQ^x?5rt zW}qmU+V9c+gE%VXft|XbxGVVhv(&bQyC{9Pqwg+uKf!pZp%cx4S_V|9xH^q`XJ&iM zj%L(k%3iFkI7Kl!Slex0eQ2XPc1p+TCL9?C9Qa7LN74ld>OXuH1Q7gT3D%G3LzBAk z`HB!z$Fl1uUjNWl8HQURvgP%K^##oyO*mV?NUH~K-o$!{LE#FIkPq3hk{oyNOy+M1 z{P@*GF4g-OK@1<{n!VkwrXT;}YPK~vWM})Nx%vw4OTG=t{f?^*=N6&$-)QXEe(4H{ zmx1fksEC9YjBeNJEaEJ=$r}%;5&}z82Wx(Vnd=!xP9Hgh)1pj^N z%F=d4o|gr)VAK}V&cNl3+KbWO4|h5qouA-N-Ta0XJSGfx=s1;oxLU`H{}4IPM+VTqI@2OyD;Vt-_(_E?ejx=OGz3{}PuX zf`nK_Eapdu^d+l{6jtzQ)?vBfoA!qbYZ4PakPP)_4u*OT%|0DInpXO>uctjCswlY0 zedxq84)hEnjyL4{s!d(FL^a{RH0V@PEyG+W4vEknjkKv%D&9CPn15ab?MKS*e<|pE zrs6)xBHzOeo0$~1(yAVnI>U?spRO}wXBfp@u61K2p)gg4H=H}*^ z#FzK=RGp$mSjq-^O@_|I%R0?9a{W#@=Cwtj5Z8TI>5toc(U zUyT|bxW4syn|7Xu@2qY+s7q}=^l_-af9*V1n5ymlu?*7T?=lj=9}C5C;((95 z#L{-nH4Np-B#vzz0s7{b2Nb2e9x`Q^lhJY?8OjZ5xhcu7_rRqd7vZ|gqw`RG8me6N zpZ#9772kfEz%9%qg43#=y*rO$@nbdj573P?TFkLEH^wd3Td^0urg{?KNN%S_C!K#D zkBI$54b$mPHBo^n+c*cz%s-%3zyEgk=o;WCqU+1)dxbM-V4ppO?`(;R-?gEH2((Hw z(1csd%`h0Hx>WD{j;pWVN);ZQ2;r0m%IL6tqd)=Dx4=ZNQYrj6L50=7z4h66TsZF3 zipv|wVt@*Z*AWeM$3}%q{fqg*)$U&M_F^j$|AqIF$p((-t&;=XCBz0FwOGnE zf%;>nG{2`^)w(f_yy7wif~AP#U!vufjSSK8+8i5 zMpxq?`5fAT!it}`mT>e_QWZ-Jf);8pf6>Yl#>+(q5?Ufmi>9mCw5vS(zz|xIBM$sV zM!G@cG>){d?qXD(^9-_xk?f|67h{Aha%!$7o;X2Im7QH5wl_}~Ib3VR4mOZ@I{cnN z7pjrx9-N3w%OtDeKj8hwZPBs1kb&5jQ-5TVh8=(Zdx~q_!g)Myn$tT| zXpsXSpH-Te{%KwxrYB!E(NiT516=znSzv<5u|pj#0)M!~mSQ$u%YnwPw_S?$k~VQ{ zN4-Op?ch9+gEFhX6JEWBIfr6SV~>vddY&LXnj=7Vk*|Z%ON)zRNz5-s?wxhR`|xTt zgh4fTe8=Q7-8m}++O)Vrfk`;S9{8zNV)ahN%`Ta3a*NYQR&^65RUJhK7v(ffZ^LLj z+M4tTzm_knDwA5PqHv+plWaCV!Qcaa)4)bjPNLmFRGQ(8Wk!*y`VyCT)P+6I+Ag(n zTPDX%avy5{aV?KYN;08pj!qx9jzTZ<`2%oP&QG=G+JPfv;Q!_SU?kl~`8Sh!=l?qR z^m54C@)Vz}brGU_{n+c|U$+0p|K%ElyQw>hP$P6Z9eJ|Hv4$9p;xgrhoKM0xY}l{F zlPBzZ65^r{u4g*;B1@u2z^fDixZ=!IhMdDvr2G$2_A`He@mn2 z!%}*lMSsp>LfcoWu<#;E22$F*u$|=_I%;F0C-s!uG`Bv(Js==RGz4W(Uy)4gdzBwXOaWjZZ-Wt5)hFORcBR;|uuPnq|@fZW%;^U{tfW0d;_w;Db|gq1f-`zcnUF4pHpK>ORjf2E%Rv@-vytGg`XI zOuEE~G>%Jd0+aesJRB`%1dFo;lMCjRpII{}XM@~?ZBHS~TVz3Sqn>1q70+U6IiXC7 zXkoF_2&92uEWgDpG*0Fyd_ALHN6W_3a&xFu(pqL3zR`Y z99Ec=I0AJVCa1R3nOlm9ZRk&Ho>X>GvTwPZVUKanIi8Ibu+wfcm?&c3Waej!dU^N9 zqYdAXyhxKHkV4Z!m8Ggf6!GhE+L(;C%9cj$7Z> z#SQQn1(K9AHTMup>wB;(x}w!*d$|E>&^Hc!R+#>{_h`~M{xOafeR5hupWcEoy6ILP z`&OxAv+BEn_fz_jarydQVp6>)5A+~FninR-I*Xk$C00jSzqx35{Y8(9k*>7mnlsLb zNa6rcNQOIlVsdn`nCbQn$7B8M;Cu4)~_CvEtE?BuJg-nI8 zIyiCIh8b2a;c&T)r{?%m^8)t>qBOrOecHQhEX#lU8n2_LxaZOsCha=-^twFO`vD{- zCnzF$V3UC~aVKSP))=nWlDYP}-U(m9*ojcRT32=|des_p6;1V{3u37~6F+^%PdL=r zs%c$P_hBi~LG0U18eQfz96A|c%25HgWrHoYMHn%-igNhfh6PJF7f9lb^~O~T1i!L;t?1of*V6r3^n};t z=4(R30EHr6Oa*((%ZEgL9hERSe?2cPH4%Uw3{)(}P^^udH#}D0(-lMIZobenAHIBG zR$2a=WDE8C3t60b%XeA>Y{RizYHY)54)ru619*C Date: Thu, 20 Jun 2024 01:00:44 -0400 Subject: [PATCH 2/3] feat: add initial mkdocs (#18) --- .github/workflows/cd-mkdocs | 22 +++++++++ docs/index.md | 24 ++++++++++ methods.md => docs/methods.md | 1 - mkdocs.yml | 46 +++++++++++++++++++ requirements.txt | 1 + .../tools/import json_as_md.py | 2 +- 6 files changed, 94 insertions(+), 2 deletions(-) create mode 100644 .github/workflows/cd-mkdocs create mode 100644 docs/index.md rename methods.md => docs/methods.md (99%) create mode 100644 mkdocs.yml rename import json_as_md.py => src/tools/import json_as_md.py (98%) diff --git a/.github/workflows/cd-mkdocs b/.github/workflows/cd-mkdocs new file mode 100644 index 0000000..01cf033 --- /dev/null +++ b/.github/workflows/cd-mkdocs @@ -0,0 +1,22 @@ +name: cd-mkdocs +on: + push: + branches: + - master +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - uses: actions/cache@v2 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install mkdocs-material + - run: pip install pillow cairosvg + - run: mkdocs gh-deploy --force diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..bf9df2b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,24 @@ +# Welcome to MkDocs + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + ... # Other markdown pages, images and other files. + +# Code Block +```py title="main.py" linenums="1" hl_lines="1 3" +print("vroomvroom") +print("vrrrr") +print("3") +``` diff --git a/methods.md b/docs/methods.md similarity index 99% rename from methods.md rename to docs/methods.md index 73a1668..9eedab0 100644 --- a/methods.md +++ b/docs/methods.md @@ -703,4 +703,3 @@ No Description link: ```https://members-ng.iracing.com/data/track/get``` --- - diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..e2e6aea --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,46 @@ +site_name: iRacing Garage + +theme: + name: material + features: + - navigation.tabs + - navigation.sections + - toc.integrate + - navigation.top + - search.suggest + - search.highlight + - content.tabs.link + - content.code.copy + language: en + palette: + - scheme: default + toggle: + icon: material/toggle-switch-off-outline + name: Switch to dark mode + - scheme: slate + toggle: + icon: material/toggle-switch + name: Switch to light mode +extra: + social: + - icon: fontawesome/brands/github-alt + link: https://github.com/dangkv/iracing_garage + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/in/dangkhoivo/ + +markdown_extensions: + - pymdownx.highlight: + anchor_linenums: true + - pymdownx.inlinehilite + - pymdownx.snippets + - admonition + - pymdownx.arithmatex: + generic: true + - footnotes + - pymdownx.details + - pymdownx.superfences + - pymdownx.mark + - attr_list + +copyright: | + © 2024 Dang Khoi Vo diff --git a/requirements.txt b/requirements.txt index d5fa0ad..4545d70 100644 --- a/requirements.txt +++ b/requirements.txt @@ -7,6 +7,7 @@ distlib==0.3.8 filelock==3.14.0 identify==2.5.36 idna==3.7 +mkdocs-material==9.5.27 mypy-extensions==1.0.0 nodeenv==1.8.0 packaging==24.0 diff --git a/import json_as_md.py b/src/tools/import json_as_md.py similarity index 98% rename from import json_as_md.py rename to src/tools/import json_as_md.py index 9e5ca95..752490b 100644 --- a/import json_as_md.py +++ b/src/tools/import json_as_md.py @@ -50,7 +50,7 @@ def extract_and_write_endpoints(json_file_path, markdown_file_path): # File paths -json_file_path = "/home/ham/Downloads/api.json" +json_file_path = "src/tools/api.json" markdown_file_path = "methods.md" # Call the function From 3ba8ba1ed388af0a54a2df1bb22cca3873e61fbe Mon Sep 17 00:00:00 2001 From: Dang Khoi Vo <60619082+dangkv@users.noreply.github.com> Date: Thu, 20 Jun 2024 01:13:56 -0400 Subject: [PATCH 3/3] Fix/file typo 06 2024 (#19) * fix:typo * fix:typo --- .github/workflows/cd-mkdocs.yml | 22 +++++++++++++++++++++ .github/workflows/{lint.yml => ci-lint.yml} | 0 2 files changed, 22 insertions(+) create mode 100644 .github/workflows/cd-mkdocs.yml rename .github/workflows/{lint.yml => ci-lint.yml} (100%) diff --git a/.github/workflows/cd-mkdocs.yml b/.github/workflows/cd-mkdocs.yml new file mode 100644 index 0000000..ecc3e32 --- /dev/null +++ b/.github/workflows/cd-mkdocs.yml @@ -0,0 +1,22 @@ +name: Deploying Documentation +on: + push: + branches: + - master +permissions: + contents: write +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v4 + with: + python-version: 3.x + - uses: actions/cache@v2 + with: + key: ${{ github.ref }} + path: .cache + - run: pip install mkdocs-material + - run: pip install pillow cairosvg + - run: mkdocs gh-deploy --force diff --git a/.github/workflows/lint.yml b/.github/workflows/ci-lint.yml similarity index 100% rename from .github/workflows/lint.yml rename to .github/workflows/ci-lint.yml