From 5b1bed94fbd29ba2a8650e9e7e2d05afd384e4a0 Mon Sep 17 00:00:00 2001 From: Wojciech Mielczarek Date: Fri, 29 Sep 2023 11:48:42 +0200 Subject: [PATCH 1/3] Package preparation --- README.md | 17 ++++++ dist/markdown_help-0.0.2-py3-none-any.whl | Bin 0 -> 3091 bytes dist/markdown_help-0.0.2.tar.gz | Bin 0 -> 1959 bytes pyproject.toml | 22 ++++++++ src/markdown_help/__init__.py | 0 src/markdown_help/markdown_help.py | 60 ++++++++++++++++++++++ 6 files changed, 99 insertions(+) create mode 100644 README.md create mode 100644 dist/markdown_help-0.0.2-py3-none-any.whl create mode 100644 dist/markdown_help-0.0.2.tar.gz create mode 100644 pyproject.toml create mode 100644 src/markdown_help/__init__.py create mode 100644 src/markdown_help/markdown_help.py diff --git a/README.md b/README.md new file mode 100644 index 0000000..bad30b7 --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +Generate automatic command index from a program. + +Usage: + make-readme [options] COMMAND + +It outputs a Markdown section with program name, +help and version information. + +Works for any installed program that has --help +and --version options. Especially useful for Docopt. +It can be used with the following command to generate readme files: + pip install -e . + +Options: + -h LEVEL, --heading LEVEL Start from hLEVEL heading [default: 2]. + --help Display this message. + --version Display version information. \ No newline at end of file diff --git a/dist/markdown_help-0.0.2-py3-none-any.whl b/dist/markdown_help-0.0.2-py3-none-any.whl new file mode 100644 index 0000000000000000000000000000000000000000..cd9dd0f51a838261e512a38eef674d1fda4a5c9a GIT binary patch literal 3091 zcmai$cTkhr8pabKNG~SzUX+>;DWWJ@iXadIAs{S8LMI@EP+~-CKv*Dvf(v3mRwM|B zB?wZaETVV~3S7EN6Qy6IB!GyZ-nct+_mZ7m&o}S+=KJIQ&6#hW_c;$5$;|@+004aK zvOu#p0N1yTy=2%G?i+P3AcBO);sV16dRS}-J|qTGxqNbGGIx7v_r*k5$cuc1!%k8>Z;^S0c@FTK6jb}Bj?shwb_>2 za;?ffN)C-h+BAvNKQemZTAQ-%6O$A1?QQC_-O2A!qjKRueASpM%PRT#z@bh-gC0J? zlqfGi2z{kv_)D5yi~8ZvYI&$u*pd<^+~_s9xUTL}ovuBT6S3D{M88A7op25|J!7%~PsKE* zAaA!6uIjqqCYPU2kiBXxdYkrx?8!QAbH!_KRv)b5ReoBu{D4rs1fQ}++N^Chxm-B8 z^2@!?70}Z!%$jB6FNu9PA;_Zd?f4uC&usI(-KB~%=|FsRZ&EpC)+#z7!mr}!=oqjD zk>thp_`Vj^%_Me`r3w?{1?b7tVhg#z+Gw{JVDJ{}w|E3HUep@Q0!z66=F<$_n|@vs zy@-p__t3bmGtg!0>Z_%bT|PCmRH-R*Q=|7QXchliFgDp0ckz%zKu~)cQ;gWBg->)1 zusgmz8%DAh@Yq;K@E#`a)XVzW;)E*gpFIhKTF2x`^V0SomRsFw0gy9_Rt&lQ;-sYt!VTHt zRNw&s4s(hV3WvdA`mlhI=on}SJ}5#DW#wXi%G|}gz!?=W4i{pJbp3#f!>A&!v}Y}h z(EzY@HVh|eW|=>d@uX}W$;2;z{^aC(_GX7jv1qy#g1x%s)X(T(Sdx}Qy@do!D_E-A zhu=EQa;5bBWyuqI-oSr#MMkQgZ+p9k?sTh{hNx7PmN?OLs^k~KgvUlc3hhn{X|6vp zGQV!&#k&pG$v1XeKG=Rd)!XO-4>a%cT-XRMboZx}<3ZL6^^tY9KgknYwZ2Xm6BJyC z9qWBU1`7U{ol3Tc9xL~2P8QJn&(xT_ZkkSfdcdF*F~{m81^eC8sTZG#_cDkk5w4@opHPeujph1qALCONSI_x&wa3n0t1w=F z8CGTsIu}@6nu9!ajoZ<0aJ0Iq6Wb;t9Vk*r_`s~cpeHF^bJLW`J2&C(7aD7NK{0Lp zy0`GbcfXEm;Zp z^5&7GXDjOTRB&&KZzmXIU|wArs@3;@PCH=FFnLLnlo=$hYOVO`XUH2~P0)kA-+BBj zEO#_9pYI@fE}|~Eq!4=dTI0*DeofcmnS5t}&uMM+(e|D)euCSK_m%=PA`TlsjU3nn z2`VI1@=DgINoR*Rf^n>AiB03wuNL-F10OP&j&kflLhW=JdJi!#Y;jSt)-QN zv(;Hl51u_1?aNvjr5+uN>8lOJemXhuas7Y__uSlj&&K3+=s$xJcJmy@?sIcVtL}Wx z)1r|l9-S8|tR4ErTZ6QyHqj`$zPYs|2kD6*ZDyZ2Z}M2IMCl1=aV3ECfKWs|G6o}m z4uF0%txqse2;=IvG-&T+H~@i(QgX(RnE>H>%_ju?4>sUEgg2G(j&K0Q*G?2>nJA6q?^~P8K1>MoQT*R&68jwlH(#)Mk*TrJrPUUSCo@X0b+uPVuXNPoBO{?SL@DKjwV~ z?KgAP;@?{JfdIe?yVSp{UW}EcBj!|EUrSVq86fTLRIsnO3rq{6teYYr(xRN(BVs() z%gb}A(or_pFEEz6_6iFM7dQ4t4bW&vi-#t0Vx0q-O9MWKGTzA9ri%0g`ct^gyy{qF zy4%$$TeK5@gVpvIVxvRkgE*nas;Q>Nt-jWq=Gp2w4k4auPYjdZEt{=IoqCIEsbXe^ z!BU4~{WT?oew{a7)1Ce?_iSzCh^d+D8)^mUtd+CZT$fzPdKDSrmPv{1Hm#j^DTEFd z1AKH5IpV3(vjzjb0#BnmKXI?gi78?~T&r8j*@XS4L9gKF^qh8Ckp=W*^Fs4r<-6RH zlX|JGC<*IA#EU@5L&R$_FUzYfyetV95UQzb_j3+iPFG`~R58iQ$Zie?R~L8u|EN zF#DkF(8$T+yw(550*A()Q|IGZ|zd3=NUi&9-?z=!v=jCK` iPQst;a(0^k=fnOn7ic7i_gfb)`um1uJPw^}O literal 0 HcmV?d00001 diff --git a/dist/markdown_help-0.0.2.tar.gz b/dist/markdown_help-0.0.2.tar.gz new file mode 100644 index 0000000000000000000000000000000000000000..98def16a1d743b9b71726af3ed44cd3ff89bf06c GIT binary patch literal 1959 zcmV;Y2Uz$YiwFP!5jI`||Ls}-PvbZi=V$*FPnjQDPDyABGpwrX>OvbJ+P0~ZFzg7S zPTIIMOTJy=4BJEe@AvGap+&npAl;$UjXy$aVn4rcwm;7fv7g@u=|eJK(B1x;w~GYWpm(%5I=5|(Kk z`$+&{642jam8UWIkmc!J?#DVISA~B^`vefNe^0fX`aw+LCe2uwCdDlb?a9QLjtH?B zq$SHrR-l4Oy^NrsOD+fxAzN?NLgL3%1;UpYaNFN#UT~o>S*1C5D^1Y!b(-H7fGsGq z!9JY6D5625g{^%CYrg_a&-~Rx zooM2bg)E};I;JOhtn)eNi{J^`kF{@4hlG6n`jtHL2TV~XK$c<_@EqCbFfXqU?&QFxu(ned9`rcH~XqvO(t8nhdMWswGZ`x zF4KUvTP0g*KeY~p>c;0cDd(g9O0!U%Q7PMCT%g>BKxv8#8mXQUC?&&l4~vrrxD zp#FXCXrdc5PonRzo|xDVlXjhCKffzunji@b>ebMm&-u*F)y6=*=IQ{q`)lw#_NG;{ zO6#_g$uMx%-Y$Tbk^fnotq(2u8}N}knw$NHnXjTyfhNJA)jIs~>i^gpnp4;OkJ`S zeojTX_lqLMij4X=MTm_lN>Wu%q0Q^B;?^USLt!MKeni4V)aGrMsMg4?$dQ~H#X&>G z{l1J!Q9rlcQ5c7{1wLHFT@X}?C0`YOst~6^xZ=N5gq4+xC@j`01R+b^uyip`j z<#8P0F`}SRL{LMBev4S2y%RFr^^7N!)hQ}?%fmX2_ag}lvO=0ilT?feQcRh!_!}Oe zc+1N}NfLzh`GR=Z#kzW&nkHEsS-x{5fJ>HaB^-Q z_e{d@^aQ-Vb9*nt#FLJ9X@YB?d)J0zg5|=@u|HcQa|DXv;=7{4wdGyfS012*V@$m- zV4s6A{Q|#O(~%11uQSJVU9cTuO=e@u#5QX>9AAyB=>?qOxT%e6*TNNyNxU|P3tYdIyqG!h0*sM%pP{Xld zO;i{e6XU`ZqiodT5H41E2iKP-Z{qe0{2O}w2!>${?WyPBtBO%NUNiLCa!nNs$8vc> z&K-NA5}r;RVGAWVZfaIqc&cG*PS<$Ep90X^bYO z9tZDJ|GS;;$;%Oc;VD_8v1dZv(?xp8cB?opaNXxRom6qk&OPsd92JxZxB+q}(oEif|l8;w zN5j>+Vuq?=U|}d3P6XbO6`q79_j;K}#Vt`T)0k%Hgd(Pjv8?DH9o=CmD;GNEOIj$BPX90XfA-6ThBsjQ-M;@FzvTbk@u!aD|9AQR zN0}e^%-23wA5si-fo(vTDBR!<%mqvx=&;D`(t?Em5iPO0L-- zzC&2A)=;w*F+}mvM0r8--6=Zo_m{=yXHpZhc8(|fKGdJc$*`#geRv(S?+y7rz3+*? zqRbFyTe+&nK8U(SM$ctZ8>R_E)ta}-Fckien* literal 0 HcmV?d00001 diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..d4061f0 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,22 @@ +[build-system] +requires = ["hatchling"] +build-backend = "hatchling.build" + +[project] +name = "markdown_help" +version = "0.0.2" +authors = [ + { name="Michal Moroz", email="michal@makimo.pl" }, +] +description = "Generate automatic command index from a program." +readme = "README.md" +requires-python = ">=3.7" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] + +[project.urls] +"Homepage" = "https://github.com/makimo/markdown-help" +"Bug Tracker" = "https://github.com/makimo/markdown-help/issues" \ No newline at end of file diff --git a/src/markdown_help/__init__.py b/src/markdown_help/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/markdown_help/markdown_help.py b/src/markdown_help/markdown_help.py new file mode 100644 index 0000000..9a36f56 --- /dev/null +++ b/src/markdown_help/markdown_help.py @@ -0,0 +1,60 @@ +""" +Generate automatic command index from a program. + +Usage: + make-readme [options] COMMAND + +It outputs a Markdown section with program name, +help and version information. + +Works for any installed program that has --help +and --version options. Especially useful for Docopt. +It can be used with the following command to generate readme files: + pip install -e . + +Options: + -h LEVEL, --heading LEVEL Start from hLEVEL heading [default: 2]. + --help Display this message. + --version Display version information. +""" + +VERSION = '1.0' + + +import sys +import re + +import subprocess + +from docopt import docopt + + +TEXT = """{title_heading} {command_name} ({version}) + +``` +{help_text} +``` +""" + + +def doc_for(command_name, fmt_string=TEXT, title_heading="##"): + version = subprocess.check_output([command_name, '--version']).strip().decode('utf-8') + help_text = subprocess.check_output([command_name, '--help']).strip().decode('utf-8') + + return fmt_string.format( + command_name=command_name, + title_heading=title_heading, + version=version, + help_text=help_text + ) + + +def main(): + arguments = docopt(__doc__, version=VERSION) + + command = arguments['COMMAND'] + + print(doc_for( + command, + title_heading='#' * int(arguments['--heading']) + ), end='') \ No newline at end of file From 664e5959169d9b3bbc6cdf8b9958689843660568 Mon Sep 17 00:00:00 2001 From: Wojciech Mielczarek Date: Mon, 2 Oct 2023 15:56:21 +0200 Subject: [PATCH 2/3] Apply PR comments --- .gitignore | 2 ++ README.md | 4 +++- pyproject.toml | 15 +++++++++++---- src/{markdown_help => }/markdown_help.py | 2 +- 4 files changed, 17 insertions(+), 6 deletions(-) create mode 100644 .gitignore rename src/{markdown_help => }/markdown_help.py (98%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fc1a9e8 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +# ignore ALL files from the dist directory +dist/ \ No newline at end of file diff --git a/README.md b/README.md index bad30b7..d013185 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +``` Generate automatic command index from a program. Usage: @@ -14,4 +15,5 @@ It can be used with the following command to generate readme files: Options: -h LEVEL, --heading LEVEL Start from hLEVEL heading [default: 2]. --help Display this message. - --version Display version information. \ No newline at end of file + --version Display version information. +``` \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index d4061f0..f282b55 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,12 +1,13 @@ [build-system] -requires = ["hatchling"] -build-backend = "hatchling.build" +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" [project] name = "markdown_help" -version = "0.0.2" +version = "0.9" authors = [ { name="Michal Moroz", email="michal@makimo.pl" }, + { name="Wojciech Mielczarek", email="wojciech.mielczarek@makimo.pl" }, ] description = "Generate automatic command index from a program." readme = "README.md" @@ -19,4 +20,10 @@ classifiers = [ [project.urls] "Homepage" = "https://github.com/makimo/markdown-help" -"Bug Tracker" = "https://github.com/makimo/markdown-help/issues" \ No newline at end of file +"Bug Tracker" = "https://github.com/makimo/markdown-help/issues" + +[project.dependencies] +docopt == "0.6.2" + +[project.scripts] +markdown-help = "markdown_help:main" \ No newline at end of file diff --git a/src/markdown_help/markdown_help.py b/src/markdown_help.py similarity index 98% rename from src/markdown_help/markdown_help.py rename to src/markdown_help.py index 9a36f56..0c15097 100644 --- a/src/markdown_help/markdown_help.py +++ b/src/markdown_help.py @@ -18,7 +18,7 @@ --version Display version information. """ -VERSION = '1.0' +VERSION = '0.9' import sys From 10feb554d6c82d8e9ba8f31fd0e0541ce8d1678d Mon Sep 17 00:00:00 2001 From: Wojciech Mielczarek Date: Mon, 2 Oct 2023 16:38:05 +0200 Subject: [PATCH 3/3] Change the build-system --- dist/markdown_help-0.0.2-py3-none-any.whl | Bin 3091 -> 0 bytes dist/markdown_help-0.0.2.tar.gz | Bin 1959 -> 0 bytes pyproject.toml | 6 ++-- src/markdown_help.egg-info/PKG-INFO | 34 ++++++++++++++++++ src/markdown_help.egg-info/SOURCES.txt | 11 ++++++ .../dependency_links.txt | 1 + src/markdown_help.egg-info/entry_points.txt | 2 ++ src/markdown_help.egg-info/requires.txt | 1 + src/markdown_help.egg-info/top_level.txt | 1 + 9 files changed, 53 insertions(+), 3 deletions(-) delete mode 100644 dist/markdown_help-0.0.2-py3-none-any.whl delete mode 100644 dist/markdown_help-0.0.2.tar.gz create mode 100644 src/markdown_help.egg-info/PKG-INFO create mode 100644 src/markdown_help.egg-info/SOURCES.txt create mode 100644 src/markdown_help.egg-info/dependency_links.txt create mode 100644 src/markdown_help.egg-info/entry_points.txt create mode 100644 src/markdown_help.egg-info/requires.txt create mode 100644 src/markdown_help.egg-info/top_level.txt diff --git a/dist/markdown_help-0.0.2-py3-none-any.whl b/dist/markdown_help-0.0.2-py3-none-any.whl deleted file mode 100644 index cd9dd0f51a838261e512a38eef674d1fda4a5c9a..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3091 zcmai$cTkhr8pabKNG~SzUX+>;DWWJ@iXadIAs{S8LMI@EP+~-CKv*Dvf(v3mRwM|B zB?wZaETVV~3S7EN6Qy6IB!GyZ-nct+_mZ7m&o}S+=KJIQ&6#hW_c;$5$;|@+004aK zvOu#p0N1yTy=2%G?i+P3AcBO);sV16dRS}-J|qTGxqNbGGIx7v_r*k5$cuc1!%k8>Z;^S0c@FTK6jb}Bj?shwb_>2 za;?ffN)C-h+BAvNKQemZTAQ-%6O$A1?QQC_-O2A!qjKRueASpM%PRT#z@bh-gC0J? zlqfGi2z{kv_)D5yi~8ZvYI&$u*pd<^+~_s9xUTL}ovuBT6S3D{M88A7op25|J!7%~PsKE* zAaA!6uIjqqCYPU2kiBXxdYkrx?8!QAbH!_KRv)b5ReoBu{D4rs1fQ}++N^Chxm-B8 z^2@!?70}Z!%$jB6FNu9PA;_Zd?f4uC&usI(-KB~%=|FsRZ&EpC)+#z7!mr}!=oqjD zk>thp_`Vj^%_Me`r3w?{1?b7tVhg#z+Gw{JVDJ{}w|E3HUep@Q0!z66=F<$_n|@vs zy@-p__t3bmGtg!0>Z_%bT|PCmRH-R*Q=|7QXchliFgDp0ckz%zKu~)cQ;gWBg->)1 zusgmz8%DAh@Yq;K@E#`a)XVzW;)E*gpFIhKTF2x`^V0SomRsFw0gy9_Rt&lQ;-sYt!VTHt zRNw&s4s(hV3WvdA`mlhI=on}SJ}5#DW#wXi%G|}gz!?=W4i{pJbp3#f!>A&!v}Y}h z(EzY@HVh|eW|=>d@uX}W$;2;z{^aC(_GX7jv1qy#g1x%s)X(T(Sdx}Qy@do!D_E-A zhu=EQa;5bBWyuqI-oSr#MMkQgZ+p9k?sTh{hNx7PmN?OLs^k~KgvUlc3hhn{X|6vp zGQV!&#k&pG$v1XeKG=Rd)!XO-4>a%cT-XRMboZx}<3ZL6^^tY9KgknYwZ2Xm6BJyC z9qWBU1`7U{ol3Tc9xL~2P8QJn&(xT_ZkkSfdcdF*F~{m81^eC8sTZG#_cDkk5w4@opHPeujph1qALCONSI_x&wa3n0t1w=F z8CGTsIu}@6nu9!ajoZ<0aJ0Iq6Wb;t9Vk*r_`s~cpeHF^bJLW`J2&C(7aD7NK{0Lp zy0`GbcfXEm;Zp z^5&7GXDjOTRB&&KZzmXIU|wArs@3;@PCH=FFnLLnlo=$hYOVO`XUH2~P0)kA-+BBj zEO#_9pYI@fE}|~Eq!4=dTI0*DeofcmnS5t}&uMM+(e|D)euCSK_m%=PA`TlsjU3nn z2`VI1@=DgINoR*Rf^n>AiB03wuNL-F10OP&j&kflLhW=JdJi!#Y;jSt)-QN zv(;Hl51u_1?aNvjr5+uN>8lOJemXhuas7Y__uSlj&&K3+=s$xJcJmy@?sIcVtL}Wx z)1r|l9-S8|tR4ErTZ6QyHqj`$zPYs|2kD6*ZDyZ2Z}M2IMCl1=aV3ECfKWs|G6o}m z4uF0%txqse2;=IvG-&T+H~@i(QgX(RnE>H>%_ju?4>sUEgg2G(j&K0Q*G?2>nJA6q?^~P8K1>MoQT*R&68jwlH(#)Mk*TrJrPUUSCo@X0b+uPVuXNPoBO{?SL@DKjwV~ z?KgAP;@?{JfdIe?yVSp{UW}EcBj!|EUrSVq86fTLRIsnO3rq{6teYYr(xRN(BVs() z%gb}A(or_pFEEz6_6iFM7dQ4t4bW&vi-#t0Vx0q-O9MWKGTzA9ri%0g`ct^gyy{qF zy4%$$TeK5@gVpvIVxvRkgE*nas;Q>Nt-jWq=Gp2w4k4auPYjdZEt{=IoqCIEsbXe^ z!BU4~{WT?oew{a7)1Ce?_iSzCh^d+D8)^mUtd+CZT$fzPdKDSrmPv{1Hm#j^DTEFd z1AKH5IpV3(vjzjb0#BnmKXI?gi78?~T&r8j*@XS4L9gKF^qh8Ckp=W*^Fs4r<-6RH zlX|JGC<*IA#EU@5L&R$_FUzYfyetV95UQzb_j3+iPFG`~R58iQ$Zie?R~L8u|EN zF#DkF(8$T+yw(550*A()Q|IGZ|zd3=NUi&9-?z=!v=jCK` iPQst;a(0^k=fnOn7ic7i_gfb)`um1uJPw^}O diff --git a/dist/markdown_help-0.0.2.tar.gz b/dist/markdown_help-0.0.2.tar.gz deleted file mode 100644 index 98def16a1d743b9b71726af3ed44cd3ff89bf06c..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1959 zcmV;Y2Uz$YiwFP!5jI`||Ls}-PvbZi=V$*FPnjQDPDyABGpwrX>OvbJ+P0~ZFzg7S zPTIIMOTJy=4BJEe@AvGap+&npAl;$UjXy$aVn4rcwm;7fv7g@u=|eJK(B1x;w~GYWpm(%5I=5|(Kk z`$+&{642jam8UWIkmc!J?#DVISA~B^`vefNe^0fX`aw+LCe2uwCdDlb?a9QLjtH?B zq$SHrR-l4Oy^NrsOD+fxAzN?NLgL3%1;UpYaNFN#UT~o>S*1C5D^1Y!b(-H7fGsGq z!9JY6D5625g{^%CYrg_a&-~Rx zooM2bg)E};I;JOhtn)eNi{J^`kF{@4hlG6n`jtHL2TV~XK$c<_@EqCbFfXqU?&QFxu(ned9`rcH~XqvO(t8nhdMWswGZ`x zF4KUvTP0g*KeY~p>c;0cDd(g9O0!U%Q7PMCT%g>BKxv8#8mXQUC?&&l4~vrrxD zp#FXCXrdc5PonRzo|xDVlXjhCKffzunji@b>ebMm&-u*F)y6=*=IQ{q`)lw#_NG;{ zO6#_g$uMx%-Y$Tbk^fnotq(2u8}N}knw$NHnXjTyfhNJA)jIs~>i^gpnp4;OkJ`S zeojTX_lqLMij4X=MTm_lN>Wu%q0Q^B;?^USLt!MKeni4V)aGrMsMg4?$dQ~H#X&>G z{l1J!Q9rlcQ5c7{1wLHFT@X}?C0`YOst~6^xZ=N5gq4+xC@j`01R+b^uyip`j z<#8P0F`}SRL{LMBev4S2y%RFr^^7N!)hQ}?%fmX2_ag}lvO=0ilT?feQcRh!_!}Oe zc+1N}NfLzh`GR=Z#kzW&nkHEsS-x{5fJ>HaB^-Q z_e{d@^aQ-Vb9*nt#FLJ9X@YB?d)J0zg5|=@u|HcQa|DXv;=7{4wdGyfS012*V@$m- zV4s6A{Q|#O(~%11uQSJVU9cTuO=e@u#5QX>9AAyB=>?qOxT%e6*TNNyNxU|P3tYdIyqG!h0*sM%pP{Xld zO;i{e6XU`ZqiodT5H41E2iKP-Z{qe0{2O}w2!>${?WyPBtBO%NUNiLCa!nNs$8vc> z&K-NA5}r;RVGAWVZfaIqc&cG*PS<$Ep90X^bYO z9tZDJ|GS;;$;%Oc;VD_8v1dZv(?xp8cB?opaNXxRom6qk&OPsd92JxZxB+q}(oEif|l8;w zN5j>+Vuq?=U|}d3P6XbO6`q79_j;K}#Vt`T)0k%Hgd(Pjv8?DH9o=CmD;GNEOIj$BPX90XfA-6ThBsjQ-M;@FzvTbk@u!aD|9AQR zN0}e^%-23wA5si-fo(vTDBR!<%mqvx=&;D`(t?Em5iPO0L-- zzC&2A)=;w*F+}mvM0r8--6=Zo_m{=yXHpZhc8(|fKGdJc$*`#geRv(S?+y7rz3+*? zqRbFyTe+&nK8U(SM$ctZ8>R_E)ta}-Fckien* diff --git a/pyproject.toml b/pyproject.toml index f282b55..5da3f0d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -17,13 +17,13 @@ classifiers = [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ] +dependencies = [ + 'docopt == 0.6.2', +] [project.urls] "Homepage" = "https://github.com/makimo/markdown-help" "Bug Tracker" = "https://github.com/makimo/markdown-help/issues" -[project.dependencies] -docopt == "0.6.2" - [project.scripts] markdown-help = "markdown_help:main" \ No newline at end of file diff --git a/src/markdown_help.egg-info/PKG-INFO b/src/markdown_help.egg-info/PKG-INFO new file mode 100644 index 0000000..ececcac --- /dev/null +++ b/src/markdown_help.egg-info/PKG-INFO @@ -0,0 +1,34 @@ +Metadata-Version: 2.1 +Name: markdown-help +Version: 0.9 +Summary: Generate automatic command index from a program. +Author-email: Michal Moroz , Wojciech Mielczarek +Project-URL: Homepage, https://github.com/makimo/markdown-help +Project-URL: Bug Tracker, https://github.com/makimo/markdown-help/issues +Classifier: Programming Language :: Python :: 3 +Classifier: License :: OSI Approved :: MIT License +Classifier: Operating System :: OS Independent +Requires-Python: >=3.7 +Description-Content-Type: text/markdown +License-File: LICENSE +Requires-Dist: docopt==0.6.2 + +``` +Generate automatic command index from a program. + +Usage: + make-readme [options] COMMAND + +It outputs a Markdown section with program name, +help and version information. + +Works for any installed program that has --help +and --version options. Especially useful for Docopt. +It can be used with the following command to generate readme files: + pip install -e . + +Options: + -h LEVEL, --heading LEVEL Start from hLEVEL heading [default: 2]. + --help Display this message. + --version Display version information. +``` diff --git a/src/markdown_help.egg-info/SOURCES.txt b/src/markdown_help.egg-info/SOURCES.txt new file mode 100644 index 0000000..657d2d5 --- /dev/null +++ b/src/markdown_help.egg-info/SOURCES.txt @@ -0,0 +1,11 @@ +LICENSE +README.md +pyproject.toml +src/markdown_help.py +src/markdown_help/__init__.py +src/markdown_help.egg-info/PKG-INFO +src/markdown_help.egg-info/SOURCES.txt +src/markdown_help.egg-info/dependency_links.txt +src/markdown_help.egg-info/entry_points.txt +src/markdown_help.egg-info/requires.txt +src/markdown_help.egg-info/top_level.txt \ No newline at end of file diff --git a/src/markdown_help.egg-info/dependency_links.txt b/src/markdown_help.egg-info/dependency_links.txt new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/src/markdown_help.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/src/markdown_help.egg-info/entry_points.txt b/src/markdown_help.egg-info/entry_points.txt new file mode 100644 index 0000000..1a8a9d6 --- /dev/null +++ b/src/markdown_help.egg-info/entry_points.txt @@ -0,0 +1,2 @@ +[console_scripts] +markdown-help = markdown_help:main diff --git a/src/markdown_help.egg-info/requires.txt b/src/markdown_help.egg-info/requires.txt new file mode 100644 index 0000000..1d9dff8 --- /dev/null +++ b/src/markdown_help.egg-info/requires.txt @@ -0,0 +1 @@ +docopt==0.6.2 diff --git a/src/markdown_help.egg-info/top_level.txt b/src/markdown_help.egg-info/top_level.txt new file mode 100644 index 0000000..0f1f4a3 --- /dev/null +++ b/src/markdown_help.egg-info/top_level.txt @@ -0,0 +1 @@ +markdown_help