Merge pull request #1913 from simoncozens/fonttools-cli-help

[doc] Add help options to fonttools CLI

Lib/fontTools/__main__.py

@@ -5,8 +5,6 @@ def main(args=None):
 	if args is None:
 		args = sys.argv[1:]
 
-	# TODO Add help output, --help, etc.
-
 	# TODO Handle library-wide options. Eg.:
 	# --unicodedata
 	# --verbose / other logging stuff
@@ -20,6 +18,10 @@ def main(args=None):
 	# can be added.  Should we just try importing the fonttools
 	# module first and try without if it fails?
 
+	if len(sys.argv) < 2:
+		sys.argv.append("help")
+	if sys.argv[1] == "-h" or sys.argv[1] == "--help":
+		sys.argv[1] = "help"
 	mod = 'fontTools.'+sys.argv[1]
 	sys.argv[1] = sys.argv[0] + ' ' + sys.argv[1]
 	del sys.argv[0]

Lib/fontTools/cu2qu/__main__.py

@@ -1,3 +1,4 @@
+"""Convert a UFO font with cubic curves to quadratic curves"""
 import sys
 from .cli import main
 

Lib/fontTools/feaLib/__main__.py

@@ -1,3 +1,4 @@
+"""Add features from a feature file (.fea) into a OTF font"""
 from fontTools.misc.py23 import *
 from fontTools.ttLib import TTFont
 from fontTools.feaLib.builder import addOpenTypeFeatures, Builder

Lib/fontTools/help.py

@@ -0,0 +1,32 @@
+"""Show this help"""
+import pkgutil
+import sys
+from setuptools import find_packages
+from pkgutil import iter_modules
+import fontTools
+import importlib
+
+
+def describe(pkg):
+    try:
+        description = __import__(
+            "fontTools." + pkg + ".__main__", globals(), locals(), ["__doc__"]
+        ).__doc__
+        print("fonttools %-10s %s" % (pkg, description), file=sys.stderr)
+    except Exception as e:
+        return None
+
+
+def show_help_list():
+    path = fontTools.__path__[0]
+    for pkg in find_packages(path):
+        qualifiedPkg = "fontTools." + pkg
+        describe(pkg)
+        pkgpath = path + "/" + qualifiedPkg.replace(".", "/")
+        for info in iter_modules([pkgpath]):
+            describe(pkg + "." + info.name)
+
+
+if __name__ == "__main__":
+    print("fonttools v%s\n" % fontTools.__version__, file=sys.stderr)
+    show_help_list()

Lib/fontTools/mtiLib/__main__.py

@@ -1,6 +1,8 @@
+"""Convert Monotype FontDame layout files to TTX"""
 from fontTools.misc.py23 import *
 import sys
 from fontTools.mtiLib import main
 
+
 if __name__ == '__main__':
 	sys.exit(main())

Lib/fontTools/subset/__main__.py

@@ -1,6 +1,8 @@
+"""OpenType font subsetter and optimizer"""
 from fontTools.misc.py23 import *
 import sys
 from fontTools.subset import main
 
+
 if __name__ == '__main__':
     sys.exit(main())

Lib/fontTools/varLib/__main__.py

@@ -1,5 +1,7 @@
+"""Build a variable font from a designspace file and masters"""
 import sys
 from fontTools.varLib import main
 
+
 if __name__ == '__main__':
 	sys.exit(main())