nojhan/weboob-devel
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

display supported websites (closes #427)

Browse source
This commit is contained in:
Romain Bignon 2010-12-09 12:03:46 +01:00
commit 7b5e5f3289
1 changed files with 24 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

29
tools/make_man.py
View file

@ -25,14 +25,17 @@ import time
from weboob.tools.application.base import BaseApplication from weboob.tools.application.base import BaseApplication
BASE_PATH = os.path.join(os.path.dirname(__file__), os.pardir) BASE_PATH = os.path.join(os.path.dirname(__file__), os.pardir)
DEST_DIR = 'man'
class ManpageHelpFormatter(optparse.HelpFormatter): class ManpageHelpFormatter(optparse.HelpFormatter):
def __init__ (self, def __init__ (self,
app,
indent_increment=0, indent_increment=0,
max_help_position=0, max_help_position=0,
width=80, width=80,
short_first=1): short_first=1):
optparse.HelpFormatter.__init__(self, indent_increment, max_help_position, width, short_first) optparse.HelpFormatter.__init__(self, indent_increment, max_help_position, width, short_first)
self.app = app
def format_heading(self, heading): def format_heading(self, heading):
return ".SH %s\n" % heading.upper() return ".SH %s\n" % heading.upper()
@ -52,11 +55,22 @@ class ManpageHelpFormatter(optparse.HelpFormatter):
return '.SH SYNOPSIS\n%s' % txt return '.SH SYNOPSIS\n%s' % txt
def format_description(self, description): def format_description(self, description):
return '.SH DESCRIPTION\n.LP\n\n%s\n' % description desc = u'.SH DESCRIPTION\n.LP\n\n%s\n' % description
if hasattr(self.app, 'CAPS'):
desc += u'\n.SS Supported websites:\n'
self.app.weboob.modules_loader.load_all()
backends = []
for name, backend in self.app.weboob.modules_loader.loaded.iteritems():
if backend.has_caps(self.app.CAPS):
backends.append(u'* %s (%s)' % (name, backend.description))
desc += u'\n.br\n'.join(sorted(backends))
return desc
def format_commands(self, commands): def format_commands(self, commands):
s = u'' s = u''
for section, cmds in commands.iteritems(): for section, cmds in commands.iteritems():
if len(cmds) == 0:
continue
s += '.SH %s COMMANDS\n' % section.upper() s += '.SH %s COMMANDS\n' % section.upper()
for cmd in cmds: for cmd in cmds:
s += '.TP\n' s += '.TP\n'
@ -122,10 +136,11 @@ def format_title(title):
# really a problem. # really a problem.
applications = [] applications = []
def analyze_application(app, script_name): def analyze_application(app, script_name):
formatter = ManpageHelpFormatter()
application = app() application = app()
applications.append(application) applications.append(application)
formatter = ManpageHelpFormatter(application)
# patch the application # patch the application
application._parser.prog = "%s" % script_name application._parser.prog = "%s" % script_name
application._parser.formatter = formatter application._parser.formatter = formatter
@ -147,11 +162,15 @@ For full COPYRIGHT see COPYING file with weboob package.
if len(app.CONFIG) > 0: if len(app.CONFIG) > 0:
footer += '\n\n "~/.weboob/%s"' % app.APPNAME footer += '\n\n "~/.weboob/%s"' % app.APPNAME
# Skip internal applications.
if not '-' in application.APPNAME:
footer += "\n\n.SH SEE ALSO\nHome page: http://weboob.org/%s" % application.APPNAME.capitalize()
mantext = "%s\n%s\n%s\n%s" % (header, name, helptext, footer) mantext = "%s\n%s\n%s\n%s" % (header, name, helptext, footer)
with open(os.path.join(BASE_PATH, "man2", "%s.1" % script_name), 'w+') as manfile: with open(os.path.join(BASE_PATH, DEST_DIR, "%s.1" % script_name), 'w+') as manfile:
for line in mantext.split('\n'): for line in mantext.split('\n'):
manfile.write('%s\n' % line.lstrip()) manfile.write('%s\n' % line.lstrip().encode('utf-8'))
print "wrote man2/%s.1" % script_name print "wrote %s/%s.1" % (DEST_DIR, script_name)
if __name__ == '__main__': if __name__ == '__main__':
sys.exit(main()) sys.exit(main())