nojhan/weboob-devel
Watch
1
0
Fork
You've already forked weboob-devel
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add missing "whatis entry" to man pages

Browse source 
This is recommended by Debian.
closes #618
This commit is contained in:
Laurent Bachelier 2013-02-13 00:38:33 +01:00
commit ae06ae3384
32 changed files with 284 additions and 213 deletions
Download patch file Download diff file Expand all files Collapse all files

1
weboob/applications/boobank/boobank.py
View file

@ -159,6 +159,7 @@ class Boobank(ReplApplication):
DESCRIPTION = "Console application allowing to list your bank accounts and get their balance, " \
"display accounts history and coming bank operations, and transfer money from an account to " \
"another (if available)."
SHORT_DESCRIPTION = "manage bank accounts"
EXTRA_FORMATTERS = {'account_list': AccountListFormatter,
'recipient_list': RecipientListFormatter,
'transfer': TransferFormatter,

1
weboob/applications/boobathon/boobathon.py
View file

@ -277,6 +277,7 @@ class Boobathon(ReplApplication):
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2011 Romain Bignon'
DESCRIPTION = 'Console application to participate to a Boobathon.'
SHORT_DESCRIPTION = "participate in a Boobathon"
CAPS = ICapContent
SYNOPSIS = 'Usage: %prog [-dqv] [-b backends] [-cnfs] boobathon\n'
SYNOPSIS += ' %prog [--help] [--version]'

1
weboob/applications/boobill/boobill.py
View file

@ -43,6 +43,7 @@ class Boobill(ReplApplication):
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2012 Florent Fourcot'
DESCRIPTION = 'Console application allowing to get and download bills.'
SHORT_DESCRIPTION = "get and download bills"
CAPS = ICapBill
COLLECTION_OBJECTS = (Subscription, )
EXTRA_FORMATTERS = {'subscriptions': SubscriptionsFormatter,

1
weboob/applications/boobmsg/boobmsg.py
View file

@ -271,6 +271,7 @@ class Boobmsg(ReplApplication):
COPYRIGHT = 'Copyright(C) 2010-2011 Christophe Benz'
DESCRIPTION = "Console application allowing to send messages on various websites and " \
"to display message threads and contents."
SHORT_DESCRIPTION = "send and receive message threads"
CAPS = ICapMessages
EXTRA_FORMATTERS = {'msglist': MessagesListFormatter,
'msg': MessageFormatter,

4
weboob/applications/boobooks/boobooks.py
View file

@ -28,7 +28,7 @@ __all__ = ['Boobooks']
class RentedListFormatter(PrettyFormatter):
MANDATORY_FIELDS = ('id', 'date', 'author', 'name', 'late')
RED = ''
RED = ''
def get_title(self, obj):
s = u'%s — %s (%s)' % (obj.author, obj.name, obj.date)
@ -36,6 +36,7 @@ class RentedListFormatter(PrettyFormatter):
s += u' %sLATE!%s' % (self.RED, self.NC)
return s
class Boobooks(ReplApplication):
APPNAME = 'boobooks'
VERSION = '0.f'
@ -43,6 +44,7 @@ class Boobooks(ReplApplication):
CAPS = ICapBook
DESCRIPTION = "Console application allowing to list your books rented or booked at the library, " \
"book and search new ones, get your booking history (if available)."
SHORT_DESCRIPTION = "manage rented books"
EXTRA_FORMATTERS = {'rented_list': RentedListFormatter,
}
DEFAULT_FORMATTER = 'table'

9
weboob/applications/boobtracker/boobtracker.py
View file

@ -59,6 +59,7 @@ class IssueFormatter(IFormatter):
result += html2text(u.message)
return result
class IssuesListFormatter(PrettyFormatter):
MANDATORY_FIELDS = ('id', 'project', 'status', 'title', 'category')
@ -73,8 +74,8 @@ class BoobTracker(ReplApplication):
APPNAME = 'boobtracker'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2011 Romain Bignon'
DESCRIPTION = "Console application allowing to send messages on various websites and " \
"to display message threads and contents."
DESCRIPTION = "Console application allowing to create, edit, view bug tracking issues."
SHORT_DESCRIPTION = "manage bug tracking issues"
CAPS = ICapBugTracker
EXTRA_FORMATTERS = {'issue_info': IssueFormatter,
'issues_list': IssuesListFormatter,
@ -151,7 +152,7 @@ class BoobTracker(ReplApplication):
issue = self.get_object(line, 'get_issue')
if not issue:
print >>sys.stderr, 'Issue not found: %s' % line
print >>sys.stderr, 'Issue not found: %s' % line
return 3
self.format(issue)
self.flush()
@ -335,7 +336,7 @@ class BoobTracker(ReplApplication):
_id, key, value = self.parse_command_args(line, 3, 1)
issue = self.get_object(_id, 'get_issue')
if not issue:
print >>sys.stderr, 'Issue not found: %s' % _id
print >>sys.stderr, 'Issue not found: %s' % _id
return 3
self.prompt_issue(issue, key, value)

5
weboob/applications/comparoob/comparoob.py
View file

@ -79,7 +79,8 @@ class Comparoob(ReplApplication):
APPNAME = 'comparoob'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2012 Romain Bignon'
DESCRIPTION = 'Console application to compare products.'
DESCRIPTION = "Console application to compare products."
SHORT_DESCRIPTION = "compare products"
DEFAULT_FORMATTER = 'table'
EXTRA_FORMATTERS = {'prices': PricesFormatter,
'price': PriceFormatter,
@ -141,7 +142,7 @@ class Comparoob(ReplApplication):
price = self.get_object(_id, 'get_price')
if not price:
print >>sys.stderr, 'Price not found: %s' % _id
print >>sys.stderr, 'Price not found: %s' % _id
return 3
self.start_format()

6
weboob/applications/flatboob/flatboob.py
View file

@ -58,6 +58,7 @@ class HousingFormatter(IFormatter):
result += ' %s: %s\n' % (key, value)
return result
class HousingListFormatter(PrettyFormatter):
MANDATORY_FIELDS = ('id', 'title', 'cost', 'text')
@ -76,7 +77,8 @@ class Flatboob(ReplApplication):
APPNAME = 'flatboob'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2012 Romain Bignon'
DESCRIPTION = 'Console application to search a house.'
DESCRIPTION = "Console application to search for housing."
SHORT_DESCRIPTION = "search for housing"
CAPS = ICapHousing
EXTRA_FORMATTERS = {'housing_list': HousingListFormatter,
'housing': HousingFormatter,
@ -160,7 +162,7 @@ class Flatboob(ReplApplication):
housing = self.get_object(_id, 'get_housing')
if not housing:
print >>sys.stderr, 'Housing not found: %s' % _id
print >>sys.stderr, 'Housing not found: %s' % _id
return 3
self.start_format()

1
weboob/applications/galleroob/galleroob.py
View file

@ -51,6 +51,7 @@ class Galleroob(ReplApplication):
VERSION = '0.f'
COPYRIGHT = u'Copyright(C) 2011 Noé Rubinstein'
DESCRIPTION = 'galleroob browses and downloads web image galleries'
SHORT_DESCRIPTION = 'browse and download web image galleries'
CAPS = ICapGallery
EXTRA_FORMATTERS = {'gallery_list': GalleryListFormatter}
COMMANDS_FORMATTERS = {'search': 'gallery_list', 'ls': 'gallery_list'}

3
weboob/applications/geolooc/geolooc.py
View file

@ -31,7 +31,8 @@ class Geolooc(ReplApplication):
APPNAME = 'geolooc'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2011 Romain Bignon'
DESCRIPTION = 'Console application allowing to geolocalize IP addresses.'
DESCRIPTION = "Console application allowing to geolocalize IP addresses."
SHORT_DESCRIPTION = "geolocalize IP addresses"
CAPS = ICapGeolocIp
def main(self, argv):

6
weboob/applications/havedate/havedate.py
View file

@ -45,12 +45,14 @@ class EventListFormatter(PrettyFormatter):
if hasattr(event, 'message'):
return event.message
class HaveDate(Boobmsg):
APPNAME = 'havedate'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2012 Romain Bignon'
DESCRIPTION = 'Console application allowing to interact with various dating websites ' \
'and to optimize seduction algorithmically.'
DESCRIPTION = "Console application allowing to interact with various dating websites " \
"and to optimize seduction algorithmically."
SHORT_DESCRIPTION = "interact with dating websites"
STORAGE_FILENAME = 'dating.storage'
STORAGE = {'optims': {}}
CAPS = ICapDating

2
weboob/applications/masstransit/masstransit.py
View file

@ -281,6 +281,8 @@ class Masstransit(BaseApplication):
APPNAME = 'masstransit'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2011 Julien Hébert'
DESCRIPTION = "Maemo application allowing to search for train stations and get departure times."
SHORT_DESCRIPTION = "search for train stations and departures"
def main(self, argv):
self.load_backends(ICapTravel)

5
weboob/applications/monboob/monboob.py
View file

@ -41,6 +41,7 @@ from weboob.tools.misc import html2text, get_backtrace, utc2local, to_unicode
__all__ = ['Monboob']
class FakeSMTPD(SMTPServer):
def __init__(self, app, bindaddr, port):
SMTPServer.__init__(self, (bindaddr, port), None)
@ -50,6 +51,7 @@ class FakeSMTPD(SMTPServer):
msg = message_from_string(data)
self.app.process_incoming_mail(msg)
class MonboobScheduler(Scheduler):
def __init__(self, app):
Scheduler.__init__(self)
@ -89,6 +91,7 @@ class Monboob(ReplApplication):
COPYRIGHT = 'Copyright(C) 2010-2011 Romain Bignon'
DESCRIPTION = 'Daemon allowing to regularly check for new messages on various websites, ' \
'and send an email for each message, and post a reply to a message on a website.'
SHORT_DESCRIPTION = "daemon to send and check messages"
CONFIG = {'interval': 300,
'domain': 'weboob.example.org',
'recipient': 'weboob@example.org',
@ -119,7 +122,7 @@ class Monboob(ReplApplication):
try:
self.config.set('html', int(self.config.get('html')))
if self.config.get('html') not in (0,1):
if self.config.get('html') not in (0, 1):
raise ValueError()
except ValueError:
print >>sys.stderr, 'Configuration error: html must be 0 or 1.'

5
weboob/applications/pastoob/pastoob.py
View file

@ -37,8 +37,9 @@ __all__ = ['Pastoob']
class Pastoob(ReplApplication):
APPNAME = 'pastoob'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2011 Laurent Bachelier'
DESCRIPTION = 'Console application allowing to post and get pastes from pastebins.'
COPYRIGHT = 'Copyright(C) 2011-2013 Laurent Bachelier'
DESCRIPTION = "Console application allowing to post and get pastes from pastebins."
SHORT_DESCRIPTION = "post and get pastes from pastebins"
CAPS = ICapPaste
def main(self, argv):

4
weboob/applications/qboobmsg/qboobmsg.py
View file

@ -23,11 +23,13 @@ from weboob.tools.application.qt import QtApplication
from .main_window import MainWindow
class QBoobMsg(QtApplication):
APPNAME = 'qboobmsg'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2011 Romain Bignon'
DESCRIPTION = 'Qt application allowing to read messages on various websites and reply to them.'
DESCRIPTION = "Qt application allowing to read messages on various websites and reply to them."
SHORT_DESCRIPTION = "send and receive message threads"
CAPS = ICapMessages
def main(self, argv):

4
weboob/applications/qflatboob/qflatboob.py
View file

@ -24,11 +24,13 @@ from weboob.tools.config.yamlconfig import YamlConfig
from .main_window import MainWindow
class QFlatBoob(QtApplication):
APPNAME = 'qflatboob'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2012 Romain Bignon'
DESCRIPTION = 'Qt application to find housings.'
DESCRIPTION = "Qt application to search for housing."
SHORT_DESCRIPTION = "search for housing"
CAPS = ICapHousing
CONFIG = {'queries': {}}
STORAGE = {'bookmarks': [], 'read': [], 'notes': {}}

3
weboob/applications/qhavedate/qhavedate.py
View file

@ -27,7 +27,8 @@ class QHaveDate(QtApplication):
APPNAME = 'qhavedate'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2012 Romain Bignon'
DESCRIPTION = 'Qt application allowing to interact with various dating websites.'
DESCRIPTION = "Qt application allowing to interact with various dating websites."
SHORT_DESCRIPTION = "interact with dating websites"
CAPS = ICapDating
STORAGE_FILENAME = 'dating.storage'

4
weboob/applications/qvideoob/qvideoob.py
View file

@ -23,11 +23,13 @@ from weboob.tools.application.qt import QtApplication
from .main_window import MainWindow
class QVideoob(QtApplication):
APPNAME = 'qvideoob'
VERSION = '0.f'
COPYRIGHT = 'Copyright(C) 2010-2011 Romain Bignon'
DESCRIPTION = 'Qt application allowing to search videos on various websites and play them.'
DESCRIPTION = "Qt application allowing to search videos on various websites and play them."
SHORT_DESCRIPTION = "search and play videos"
CAPS = ICapVideo
CONFIG = {'settings': {'nsfw': 1,
'sfw': 1,

2
weboob/applications/qvideoob/video.py
View file

@ -18,7 +18,7 @@
# along with weboob. If not, see <http://www.gnu.org/licenses/>.
from PyQt4.QtCore import QUrl
from PyQt4.QtCore import QUrl
from PyQt4.QtGui import QDialog
from PyQt4.phonon import Phonon

3
weboob/applications/qwebcontentedit/qwebcontentedit.py
View file

@ -27,7 +27,8 @@ class QWebContentEdit(QtApplication):
APPNAME = 'qwebcontentedit'
VERSION = '0.f'
COPYRIGHT = u'Copyright(C) 2011 Clément Schreiner'
DESCRIPTION = 'Qt application allowing to manage contents of various websites.'
DESCRIPTION = "Qt application allowing to manage content of various websites."
SHORT_DESCRIPTION = "manage websites content"
CAPS = ICapContent
def main(self, argv):

Some files were not shown because too many files have changed in this diff Show more