From 1a0d5872b0e6ffbaf0c25c431461ddcfcb1e6ed4 Mon Sep 17 00:00:00 2001 From: shloktech Date: Thu, 2 Jan 2025 00:25:11 +0530 Subject: [PATCH] Refactoring library name --- .idea/git_toolbox_blame.xml | 6 ++ .../inspectionProfiles/profiles_settings.xml | 6 ++ .idea/md2docx-python.iml | 8 ++ .idea/modules.xml | 8 ++ .idea/vcs.xml | 6 ++ dist/md2docx_python-0.3.1-py3-none-any.whl | Bin 0 -> 5573 bytes dist/md2docx_python-0.3.1.tar.gz | Bin 0 -> 4376 bytes md2docx_python.egg-info/PKG-INFO | 52 +++++++-- md2docx_python_python.egg-info/PKG-INFO | 99 ------------------ md2docx_python_python.egg-info/SOURCES.txt | 9 -- .../dependency_links.txt | 1 - md2docx_python_python.egg-info/requires.txt | 3 - md2docx_python_python.egg-info/top_level.txt | 1 - setup.py | 2 +- 14 files changed, 79 insertions(+), 122 deletions(-) create mode 100644 .idea/git_toolbox_blame.xml create mode 100644 .idea/inspectionProfiles/profiles_settings.xml create mode 100644 .idea/md2docx-python.iml create mode 100644 .idea/modules.xml create mode 100644 .idea/vcs.xml create mode 100644 dist/md2docx_python-0.3.1-py3-none-any.whl create mode 100644 dist/md2docx_python-0.3.1.tar.gz delete mode 100644 md2docx_python_python.egg-info/PKG-INFO delete mode 100644 md2docx_python_python.egg-info/SOURCES.txt delete mode 100644 md2docx_python_python.egg-info/dependency_links.txt delete mode 100644 md2docx_python_python.egg-info/requires.txt delete mode 100644 md2docx_python_python.egg-info/top_level.txt diff --git a/.idea/git_toolbox_blame.xml b/.idea/git_toolbox_blame.xml new file mode 100644 index 0000000..7dc1249 --- /dev/null +++ b/.idea/git_toolbox_blame.xml @@ -0,0 +1,6 @@ + + + + + \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/md2docx-python.iml b/.idea/md2docx-python.iml new file mode 100644 index 0000000..d0876a7 --- /dev/null +++ b/.idea/md2docx-python.iml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..626d9e7 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..35eb1dd --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/dist/md2docx_python-0.3.1-py3-none-any.whl b/dist/md2docx_python-0.3.1-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..d80d1e3f7e5bc8369b1af036ea79c9d887193e6c GIT binary patch literal 5573 zcmai&cQjmW*TzTh(R&b`(W7^wGujw!q9l3?QKCc-V;H?f7@Y@+7DAK|MDIO+DNU3j>n^007_uQX`q6*B1cvpNH!~cO8#x z?%KFn`&vHs^Kx)=6|l5)banKywBhXK(0ZDvne6r=R@45{m2{Bx$KhxOlQW3^Qg zg$NR2wi;UG+f(6V_w>`aVBuEJ+4z5@+Fpwqck66lkGiYUpAgZm^p`3~P|@X$OVcS= zR$7JpuVukW%+PF=2$elF06+yB0ATy)Wq*H$>(rYevTn12By(8n^0yO0$xyiJV|iS; z%#QF|8WCa&YGG8mRQd=Ct}&g75 zA1_e;Q0S}w{LGOgyUS^hU8yY_i4B2!;Hik1qV;K>eN8ekungvq9FY@=-@8P92eQY~ zWA*9jJE&!@TAbZkDNT}|=yFc?qQP3Q%w~iqb=6p5letIx_B;o9KJKQ<f(f8ir*1rJee05FP^ zR^wdGJFwSjk*ZleBYb2lR&!2!XjO3A9Zz6p$=#pEM=@f@R{67DTWO2l@u^$A{ghQF z_+=e*uVGj;%|#p56NzGzXGZx3K8v3!5O+h@I_U8~c@AYBNqCbn5j=6^GCO!6yH_qd z_t4w7dwhlXSH%n^GebMF|4I+Ku5npR0D$9k@w{i6J;&XJha}xk*D5>Ze zsF;H--H?JL!D>s=nFkY^CCFE@JA+uoRoFDN#iopS5^eNtq~27=v%7JHJ5t=>m3QYC z?+QrhJZ3XSkrIf4i7X3F|82+jZZ%`BbI3l@vh`wCoGO%o`=47i$L>Udn*d*Vi3Pl&FBdw zK1KUv7m|#$>%A(F8=x|}?bI+qUnCJp2V}QY?h-b6O}7w@DR!@N1&X1=WwgoH!~WWX zKwdeWy*1bfF(s-_sg_^j(N@LPCt_)z9}vNb`JAl9Rv$OE42sS@UyoTCRgMChFDA=I znXNw}Q`5@RvNG4iA_NxIs82~6=#?9?JI7()UExz{fN-@FSZv~?bkgln2PiaK`RPF2 zJ3i7VB&w*})*3GP{q>OjFvfa6szCf(%3&$hnx-cQ0`soXYkRo@wy_5?8Sm)A2N4Fb z6ttIMJ{t`Uu&EPl7&8ob5jPi^!P%Np;>fARPB5S@trD4ON@8-rL$pILmxZOa-du4e z&1#dms%}K?t8*q6YkWcQdj*fNU{ZPD0|2_$3eEZN6|AiSQB+ohD3+TzyU{mLUhpei zg(3qSTueNEXx>Jf?UurG5s8bfoqM29K`N@`XEID^uMuanQ@PuamYKHA`_?gx?YZd6 zYG9`S*F`g+fWgM<3R9odqrP;BOvV_s9NRp*e05@jWEq`TvBMxq##(0!-FSydZF7n- zSGy(f41A(YYcclJ$^|$CY5;%ak!FbR_?Sa)4rw5(2Eh)EHqQs5|EhA13Y-c^Drp|7 zU5G43268m3KYPMy<8uIRUn@PUQU4;ng3Y+mL1+K`l2&+|&8n2Z@ac@I`;br3(gy-# z<5cD?f(@^+ti1_DALWjZ|GhK~i{i#6>hz=|@&!InwnxfL|LusTr$_$7CVA`x%fk9; zdzz+{-l934J55S-!`gWqsZDC;cXxTjXBS$gJ1EZi`v=2}HQu(E*R)KYI@&Kq z7)9RqO_Nuj4UpG|O`L(kFZLHLcQ>@Er5OXqqJRvynw#nw;wwBi^h>QczRF!)98RVU zFOLpyPC@Ula^!gn?|)&6FWN1t>@GOzV>dEpOh^ZiFuu(A>#9%Qp18K+M4%&CM0$B#9iMJUUvP+WNd$-8X zygkZp-Qp4zu{6BG0+GZ;=04RQrpQr;=Y^bCHx6vz0&& zzbMWqp|7>;5F-9mb@qRh_ZCG+|~&!h0&^$XwXM5dTYh^x`8J4#VGU|`(| z>+7uNNXEVI?)s5Jkr!p)+F*^dru03lF1Ka>6&a535xsrJ8(MB&${dMwt#6VlMaN4L?O@5LbGMQW~cs*fEDG8&f3Vc3U2$&v4(ilE-<<<%IcF@8fdJkk@hI zQ4zIEDobEJ%;D?4^VdlfE;j zZ)%DhGJnv$&y+%f;FhArqNhJL2d6~wzky`b-nc#Yk&)U$ytdt#yrp207Q+o?s$yEA zi^FEb!_d?1lzd9T#Xjz8@bs*n;Y;%2j6ly?cJA)!vJSmLCDU1N0Eg?tmZTJuc6%ZQ z){b)alJY}&ulvq28S1IlJ=NUkMtCoKVwF|3bH6?i(ixs zl^=Gd>pB%vxG3xE6(SMRvj931 zP1Ff|@?J+=;=I#$!fuz?<&Lf;rX?MPT=}>GAdp(lRd^@E0;4S5pE>XYEo2ljkaI%9 z>X@~`MlPiw76Pll`oNnri^)Bq5O;A4!+plu*t^TNsOyw>B`p6g&-$Gn5tlM8y8i53 z)hl%Na96a<&yWBx*Gn>Db~Kx5_hMf0d_k%neLq+gg0c3K9n!Crbrmkb-C|R?iGmxZ z;?;{;&_H)PEFDM}A?iOoNtR4F7_<|PA6T~KySJITOAYM94%j5z<)oLLO2Skap&W{d z?59aIN#M15yh5UZ;o|7rywN*64j%K4=*eNyseGw9qU4(ofZjgC4_aRlW|&t#MMbgL z`lRhLk@L#fH-~MPL%w?ZDEYwKr6i#f4O0`*iVP2P$DACJw?k?)ynC*g27R8E;F_zN zeMp|p(3}on{qU)ruS&9Ep#Z)U-4fFu9@p&4*D~Z8h|rU7;P5~{daUf8*SS%Y1r&{!rl(`;<>_8d{ovEdKUR-I=$jkDoW zVkjzfmg>vGNHFhN1aQx^1*?vDQ+rA5Gw6ensi7v6d4I3!8P02sFiHwO8_n;131Ycz zK&p_#uw}*#+ujCftvHsuvR?y+-sqYoBwLrI5PF8r_epEy?PheQsanJ25S^?`h@7=3Fp^^`tW62s8)x$1aM)g|G4AV41(OMaL` zSMG;Veg<)>PG3l@Ryu2>2FCw@p&~(LrVm=HvP9V_sdtmOLeWUx%sfZE&}^N8WQiml z+lv&L?bX(#UA)QE)Wx7u5#ncm}rh}w+Oo>ufojtxV_iWozZh9FR zPlGk1NObCCGx!RoK5Z*o8SgG_PuSw-%wXY@9R5{Jy?u-#X@G5|Nem{_x8cGfmxp0#<603`(k3(w!*>| zd$ktE=o9WM63UNR?ODj%O?G1t-gX+PSZt-Z>c{(zkbu3qc=RrH`4%8gjIEa4$!*w{8PP@kRg$9U?s zI_qmL>xeRUE(hxR~JHp37V^$uzzn{)r)Q| z%c8dsV_#)NzeA6$etCo~*0t?SMyHnV)49FtEk$wa_W2LiWcfRcACe27Rc&%`bR#B6 zoMak6OPshB;j7ThN2gE8m3bOlU+Ls`0}YbdliD=Fek#4NU1sS*FxoE8Gf_7i1edtM zKI~K8t?}}4&lUShXM;C{S-y5qSQ ztewrHdR`R_!v?s8fABlz^@m7?yz*1L<7l#tH>I=R+{N0(7%;cR?5DW=0QMDK7b(^B z8n|vnULq#G#{A8z`eG@6r;&4aq>ELM+%i6>oKmPzp~OpWO`2Cd(FrHRHpDXAB8-Xl zh%H{!v{5vvyWWj(V9EdE)!!U~pN&_oV_Kux_3!G>__J02qwz9US5W~G46ADojuL6{ z0fz>L-+%=tgi#*4gIau=yuAX|V0F!2Uj8TnoR|6|f+NC0lfn}#_3H?TP>w4WQq}Q1dUkC4X{O%h3k)4;@ zV@nrXZ(A3BFJG^IZ6VEG-HJ$o65igP;pLm?S7IHeQP&ek}|ghomfqBqyj4gPa8`$&=CAN?kyvp zQ}3O?zVY*E|E*efJmMIx}9FRR7o!(uuYpR<+Oxb`89zZCAf(q;?)e4hVaqTZAiGEKW9Teheq05}nTxsoGYaoD0 zW|UI1I?gHRC@;wyf7jTksLI2mCMai4i%Rc7+LOywm6+DboC7gJLv5l-cyKBXPb5Wv z(XtCir@06gi#gPDXG4r~b(u8WaNE1j^);=jsq8U1#=Wi3@fw~{7>DPQvC4u1Rt3I3 zVy3z`$BO!(2qA5sgl2D*>9! zlefYbU%C~8Knve#3C^xKS?t;ujqp3W?!C~^DFFY!MRvWR{~2#Xf1Z9Xo4;FLH#s*A zv;R^6fVZJPEwme)8}`}XS^wmM{bE)9GwXN!wI}v>;y<}0zlhi6eIvU+K92wOOl~r7 z_N~8|e_{PA^Z&Zoo6wu8@(XH4@~_bUXv|IGO(pn6{QmF6-*n+7`KA#3AGs#f@LGC) f-;+OH>VIWHPYdhX>HKNe;sWBXcY>Mx=iUDRA0eRU literal 0 HcmV?d00001 diff --git a/dist/md2docx_python-0.3.1.tar.gz b/dist/md2docx_python-0.3.1.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..1847d7379433eda4b37d978e5fca59603240bd90 GIT binary patch literal 4376 zcmb`J)mzhz!-qFuw6wG|f)Yx%qz}>}AfU7$ApHQ+j8eKpKxrwZn<+VAG)Qm6XmLn0 z7&W%<@A(Jbv-jk_J_q-8eNJ!QWJ=1x#6VXPz}ekDz{bm2+S%t-u)S|cfSZrE#6w9L zNh!$y$A3WwYVQ8a-#=W{-UleUe#biJK2BB^AF^1AkWrGa%I%kXE8iw3C#)&tyzx1n zM{@~@$1Sgb2DHt&UAZT{N#+d2vlKZa6z1Gibbn2+Ow{fx*|y^^f^x?Eq}z3N~U zK8W#dI65zGToy^6lFr7G2Ba2xcxt+r=%pS`L+IfR zgU!w>+YXw-FtpqkJ1WCKuCfoqY$ zgcI;KaCsRVf75wfEeQ}dn(%SB+8gM_xm`ILbMJ@@f(j^@pNJN(%E&-rG7oa=!XtaFSjIUtOo}UJO74!eo$u6PNq$*zOkrE7rsM7-wGIMrYvDfoGQakMw?fW$o3>^Purdtl#EFmS?-?g>^!R+^E?dp z3og&m49}+a32{z9P9&ZikgI2zy-ibFfM~GUoCrZzZ}aE=yf?cwG1hCpsa+7%fHMvi zc-FXshp~m#n60H?Whx#LP@=8>J0 zal%K=$VWL-5w$|086NwLaX6%p`QDtnjN|Js{KK@SIW!N_#62<<*pAjL+SO%>s79)J zK7&Zt6?ICFg(K=Snv&p)Hoj9_$>LA_+BtXiK>5@|^GLCKf(}jEtO>1kpAvFZv2lZ> zPIpIC&7<}Enc?l4BK(SQLP=kgfYt$A8`i0fUdX>BmvUfteF=*ch;p?cJX*fjg{iWV zx?nk@GX3xk$Au-qqE!Tt9qiZ_cd5-$9SFK+*~XsgFXwqKWOMrU+~ihxcgK~C>Me`3vd7KAATuAns{Hnuk_Tm9=-nty-%~NQgnVLMR0pTvOW6Y% z`zy%;W%J2a8Ym1dACQbs-AyeCe)!#*TcF7!KJb!Fj~iJap(|Wu7V%L#b8K2R^{WD$ z{Q};<9v~8Sd&Qnbr=f0ckz!*+U^9Z-)!AyR>`lzb+4Hy=M;{HgXxWXqH+L#-&OJ_A zAVYt^^?}3391-YVW;S6p9l_UM_es{R{e&D08!Z%KnEd*G%Cg|=-sDbfzP@iS$|RM? z1mPpG&triY^LS*v7#Pn@lqXwD&2lw&F^@IwF;zB1??#GtX=Z$3hM44*SVsASe~IB1 zxUHAy!|t*2F~>m=sZKwH__5}sZBzjBx%qVcj-{`#7V$_iFVrTnN?!(g>!F$ixzD$g z+oXOXCi#vN70&s*?Hu^dCViXSFOQC9s?+}kbIr)lu)@7DT0Bjv1e6Rqs9 zrr>E=N}KHhoV)$f7r#TtZc3}R6dB)itw`aF6|&1|268yUI_}UisWb}kxLwr-YJ~l} zpaK>bTCj*q=@9i~NJomNFt0l>*1~N`R7n2~l)zI8iWeU4d`S;Q$79S(C8t+q6txz(!sjcJdv=>m0J_(BVei=` zP@r&#m0lNIiH^4Q?jRzUSW=q9M%m{=+_ZqG^J;)U zLD>}u^%;P*Ii)S=IfD>1ECS|b?*|EPO=LZA2R+^KP*M9jG86XrT$orC=#LHsxgqn` zqw86zYwsO+qf)}pY=K2FN0TbU{S=2q&=Z|im@fmB#hUu@ zZ$5JT4fuSiE*hylo|g9OISUEUv>FGg|&N^=F^%ej0V;cSHe!(-XWTLMaCaf%9qd(t_L4!{_(j3HyCKHR`8gNc=$M0FTY&v|hSG84fY=*fMQd7Ld1PHi##Y z9WwOOAGELZv8eo&6@d7(cjhZL&>F7|_1M(vy`c2tNgt-`FZvFcIOn$Vu|aOWnU87N zM|sg%GYmj_40vjh6u~x?la%Y(WG~6DbtFN1Zt!_|Jv$D1T-IhTLfy5z7V@JB;q-%^ zM$u+BN-=#<7VYBAZ+HKa%vPqjLDX1=C?D0z-)Ah&E10u3_T+t3bS_DsmA#H#OHOF~ zO}OCjEseLxl;0>F@a?oel1`$&%LpU>oFDZhE=3{1&CFYjX>kLZ5)v9hrn>!TOA>UM z^hk`;Nnt+6)@!Vcpai(wSMt(jHgXE_oR%|FhwCtDqK-Fg0=1+LUK3n#Yhz&rkCFY$ ztDEaqsFT3c_mA%|rG+?^l?NEn`41P_BSUMce0TuH*re4q2Zdf{O@b|@>lh_Qr%PS4 ziwQd<58uhqd(!zP;W)sC>A4HLT^VUFM{M{=CY)uy#3h<1G6kKx`F!ffEM0}}VRh5b z9|L>wi?nI@&rfabpqJ zQVzNK&cpP?-#K=9P9$9Agb<@@SrxDkWQL>s4?1&5H)BctHO78HLVPeg#u#JC-IJ&= zOS0gNcFx``M7t@)hGM{a>Zo)Y?bFh?6 zbDmyPyg`*Tq^h^gE+j&B)b6ER`U1yxEq zF}_-AoEiq~l=4dhBR$haJ^qQ8-A~po-q5Qnt)E+K(>jXKCBZ{%ZR3o!ySu0TX6L+F(WmIY7CkTb zdZvc1SCVo11x)F@+e>aony1p9#PkVZaTJJ#qM1>DfScMY_4#;RdVb(y4B)0i7fk>+ z?%4l|cKI6WfCI{QfXK%{XLnZgY)jsMvHO8oZ0sU5`*+T|u2-ArnnhISIUke(G1Yl<{Vy_p#b_NtDf)CGt zAwu3wIvxo?3(gIpHILWSHx+2__L4t&^r{DOQ?6+Js+wVvxyTaTxtZJ7)coq8w+&GL zMBq(DH?;vsqR%3*WE&M00uEXLqL;ZWwtLsOI?jm~WvxrM(z;n!Zc1p1|ICj~$WesK zS@z!;2@eG}w4tyAn>;~$hA;3kqpA~G{bJVK9i-cqgJO*HU*Cv$jZ2(5ajUtz{w)og zS=Du|cxxFb^9!Bh%)GlH)adKV%in;$b{nNe+UB^kf4n<_3B=MDUh8jiHGKwk17hXy?xEU4!lf%==1JHA=Vg_by*WjH7ekqPn#2d zU>|Oe>DskDvZF8yFl-ioeSf1_m~;3sapnt+X%mqbw?u3tZ#j0Rz=fAF?agdH}1J9zs^P0kYe&P2>d7FwRjp&&e z3%yZXAj%!Drk-CYPldBOkhX)6_1tv7Upk&nINo^S@rT4p5~}6o#N%aF>5;FUxz9Eu zPgnJF#J_1LeWP>cn55yjGUFjDe9O0tzXkHldXVv6&AfvSQEn8ZA2~tN;Kct2VR{*J@Hal=r8ri>w|$Bf01q@UP<69ii-}0g{BRugzP1E3Gy~hmd*Cg=PK|hU@m|dX z;EgB#G5=vP`q<5axw1~a@jnad0eImT51`x5IPgKQO8qi0UE*^9Y|XAw_p|}fXaWpZ zOjO3NSpk39%^L}%57p}kD0}L#fc+rI_povYO=v>tUu_2z z=~ZK@pr=x%Z~H>65|N`xZGb!xnBIa0{a(8K@3)ZUJPHdy@M}l6VEa%XXMi|aCfl)N zayG~%es#x=@H@j)*!`3O`tgbsbW+K@y1C}@c~5S3vjJkXliH7=hQ8fl3r>b1Rm?ho zM}>!Gf%wu^^}uUa@v>jY@c3H7a*e%R4|F>&G7M@t0QJ}7teG_=2xRdX5OQ~KW_y%7 z#QJ31Eg>Zl-_}0wNoC1X=@4ZNV)XDl12C*#fxef~(ma#RJk0DqLeBk26pj&UUKqW>tyHRyK4Nrau-LTa=i@=bzs zU}Re0PORAfeeqU`)FZcNvfsYO{%;#Fj4H7k;5M1?VnOp#rQq;hEfey~p8pq!&^7=f My_$9k8U}&>2e4G@6951J literal 0 HcmV?d00001 diff --git a/md2docx_python.egg-info/PKG-INFO b/md2docx_python.egg-info/PKG-INFO index 9c6aeb3..93a0611 100644 --- a/md2docx_python.egg-info/PKG-INFO +++ b/md2docx_python.egg-info/PKG-INFO @@ -1,6 +1,6 @@ Metadata-Version: 2.1 Name: md2docx-python -Version: 0.3.0 +Version: 0.3.1 Summary: Markdown to Word Converter. Simple and straight forward Python utility that converts a Markdown file (`.md`) to a Microsoft @@ -39,20 +39,56 @@ Description: # Markdown to Word Converter - `python-docx` for creating and editing Word documents. - `beautifulsoup4` for parsing HTML. - You can install the required libraries using pip: + Sure, let's enhance your instructions for clarity and completeness: + + --- + + ### How to Convert Markdown to Word Using `md2docx-python` + + #### Step 1: Install the Required Library + First, you need to install the `md2docx-python` library using pip. Open your terminal and run the following command: ```bash - pip install -r requirements.txt + pip install md2docx-python ``` - To run the sample files follow the below steps: + #### Step 2: Import the Library in Your Code + To use the library, import it into your Python code with the following line: - ```bash - python md2docx_python.py - Enter the path to the Markdown file (e.g., README.md): ..\sample_files\amazon_case_study.md - Enter the path for the output Word file (e.g., README.docx): ..\sample_files\amazon_case_study.docx + ```python + from md2docx_python.src.md2docx_python import markdown_to_word + ``` + + #### Step 3: Convert Markdown to Word + Call the `markdown_to_word()` function to convert your Markdown file to a Word document. Here's the syntax: + + ```python + markdown_to_word(markdown_file, word_file) + ``` + + - `markdown_file`: The path to the Markdown file you want to convert. + - `word_file`: The desired path and name for the output Word document. + + #### Step 4: Sample Code + Here's a complete example to illustrate how it works: + + ```python + from md2docx_python.src.md2docx_python import markdown_to_word + + # Define the paths to your files + markdown_file = "sample_files/amazon_case_study.md" + word_file = "sample_files/amazon_case_study.docx" + + # Convert the Markdown file to a Word document + markdown_to_word(markdown_file, word_file) ``` + This code will create a file named `amazon_case_study.docx`, which is the conversion of `amazon_case_study.md` to the Word format. + + --- + + This should make it easier to understand and follow the steps. Let me know if you need any more help or further enhancements! + ## Why this repo and not others ? Here are some reasons why this repo might be considered better or more suitable for certain use cases compared to other scripts available on the internet: diff --git a/md2docx_python_python.egg-info/PKG-INFO b/md2docx_python_python.egg-info/PKG-INFO deleted file mode 100644 index bd3fb3e..0000000 --- a/md2docx_python_python.egg-info/PKG-INFO +++ /dev/null @@ -1,99 +0,0 @@ -Metadata-Version: 2.1 -Name: md2docx-python -Version: 0.2.0 -Summary: Markdown to Word Converter. - Simple and straight forward Python utility - that converts a Markdown file (`.md`) to a Microsoft - Word document (`.docx`). It supports basic Markdown - elements, including headings, bold and italic text, - and both unordered and ordered lists. -Home-page: https://github.com/shloktech/md2docx-python -Author: Shlok Tadilkar -Author-email: shloktadilkar@gmail.com -License: MIT -Description: # Markdown to Word Converter - - ## Overview - - Simple and straight forward Python utility that converts a Markdown file (`.md`) to a Microsoft Word document (`.docx`). It supports basic Markdown elements, including headings, bold and italic text, and both unordered and ordered lists. - - #### Input .md file: - ![image](https://github.com/user-attachments/assets/c2325e52-05a7-4e11-8f28-4eeb3d8c06f5) - - #### Output .docx file: - ![image](https://github.com/user-attachments/assets/3e48a9dd-8fe3-43cc-8246-164c58e95179) - - - ## Features - - - Converts Markdown headers (`#`, `##`, `###`) to Word document headings. - - Supports bold and italic text formatting. - - Converts unordered (`*`, `-`) and ordered (`1.`, `2.`) lists. - - Handles paragraphs with mixed content. - - ## Prerequisites - - You need to have Python installed on your system along with the following libraries: - - - `markdown` for converting Markdown to HTML. - - `python-docx` for creating and editing Word documents. - - `beautifulsoup4` for parsing HTML. - - You can install the required libraries using pip: - - ```bash - pip install -r requirements.txt - ``` - - To run the sample files follow the below steps: - - ```bash - python md2docx_python.py - Enter the path to the Markdown file (e.g., README.md): ..\sample_files\amazon_case_study.md - Enter the path for the output Word file (e.g., README.docx): ..\sample_files\amazon_case_study.docx - ``` - - ## Why this repo and not others ? - - Here are some reasons why this repo might be considered better or more suitable for certain use cases compared to other scripts available on the internet: - - ### 1. **Comprehensive Markdown Support** - - **Header Levels**: The script supports multiple header levels (`h1`, `h2`, `h3`), which is important for properly structuring the document. - - **Bold and Italic Text**: It handles bold (`**`) and italic (`*`) text, providing more accurate formatting in the Word document. - - ### 2. **Proper List Formatting** - - **Unordered and Ordered Lists**: The script correctly formats both unordered (`*`, `-`) and ordered lists (`1.`, `2.`) in the Word document. This ensures that lists appear as expected without additional line breaks or formatting issues. - - ### 3. **Use of Well-Supported Libraries** - - **Markdown to HTML Conversion**: Utilizes the `markdown` library, which is a widely used and reliable tool for converting Markdown to HTML. - - **HTML Parsing and Word Document Creation**: Employs `BeautifulSoup` for parsing HTML and `python-docx` for creating Word documents, both of which are robust and well-maintained libraries. - - ### 4. **Simplicity and Readability** - - **Clear Code Structure**: The script is designed to be straightforward and easy to understand, making it accessible for users who may want to customize or extend it. - - **Basic Markdown Elements**: Focuses on the most commonly used Markdown elements, ensuring compatibility with a wide range of Markdown files without unnecessary complexity. - - ### 5. **Customizability** - - **Easy to Modify**: Users can easily adjust the script to handle additional Markdown features or customize the output format based on their specific needs. - - **Example Usage**: Provides a clear example of how to use the script, making it easy for users to adapt it for their own files. - - ### 6. **Minimal Dependencies** - - **Lightweight and Focused**: The script relies on only a few libraries, which reduces potential conflicts and keeps the script lightweight. - - ### 7. **Handles Basic HTML Tags** - - **Text Formatting**: Properly handles bold and italic text by interpreting HTML tags (`strong`, `em`), ensuring that formatting is preserved when converting to Word. - - ### 8. **Privacy** - - If you are working in a corporate firm and you want to convert your markdown files to word and you use a online tool to do it then there are chances that they will store your file which can cause to a vital information leak of your company. With use of this repo you can easily do the conversion in your own system. - - ### Comparison to Other Scripts - - **Feature Set**: Some scripts may lack comprehensive support for Markdown features or may not handle lists and text formatting well. - - **Performance**: Depending on the implementation, performance might vary. This script is designed to be efficient for typical Markdown files. - - **User-Friendliness**: The clear and concise code in this script may make it more user-friendly and easier to modify compared to more complex alternatives. - - Overall, this script provides a balanced combination of functionality, simplicity, and ease of use, which can be advantageous for many users looking to convert Markdown files to Word documents. - - For any queries please start a discussion I will be happy to answer your queries :) - -Platform: UNKNOWN -Requires-Python: >=3.9.0 -Description-Content-Type: text/markdown diff --git a/md2docx_python_python.egg-info/SOURCES.txt b/md2docx_python_python.egg-info/SOURCES.txt deleted file mode 100644 index 75fc60a..0000000 --- a/md2docx_python_python.egg-info/SOURCES.txt +++ /dev/null @@ -1,9 +0,0 @@ -setup.py -md2docx_python/__init__.py -md2docx_python/src/__init__.py -md2docx_python/src/md2docx_python.py -md2docx_python_python.egg-info/PKG-INFO -md2docx_python_python.egg-info/SOURCES.txt -md2docx_python_python.egg-info/dependency_links.txt -md2docx_python_python.egg-info/requires.txt -md2docx_python_python.egg-info/top_level.txt \ No newline at end of file diff --git a/md2docx_python_python.egg-info/dependency_links.txt b/md2docx_python_python.egg-info/dependency_links.txt deleted file mode 100644 index 8b13789..0000000 --- a/md2docx_python_python.egg-info/dependency_links.txt +++ /dev/null @@ -1 +0,0 @@ - diff --git a/md2docx_python_python.egg-info/requires.txt b/md2docx_python_python.egg-info/requires.txt deleted file mode 100644 index 8346960..0000000 --- a/md2docx_python_python.egg-info/requires.txt +++ /dev/null @@ -1,3 +0,0 @@ -markdown -python-docx -beautifulsoup4 diff --git a/md2docx_python_python.egg-info/top_level.txt b/md2docx_python_python.egg-info/top_level.txt deleted file mode 100644 index d204e3c..0000000 --- a/md2docx_python_python.egg-info/top_level.txt +++ /dev/null @@ -1 +0,0 @@ -md2docx_python diff --git a/setup.py b/setup.py index f22372d..fda6934 100644 --- a/setup.py +++ b/setup.py @@ -7,7 +7,7 @@ setup( name='md2docx_python', - version='0.3.0', + version='0.3.1', url='https://github.com/shloktech/md2docx-python', author='Shlok Tadilkar', author_email='shloktadilkar@gmail.com',