Author: duncan
Date: Sun Oct 14 12:10:01 2007
New Revision: 9980
Log:
Corrections of doc strings for freevo plugins -l
Modified:
branches/rel-1/freevo/src/audio/plugins/album_tree.py
branches/rel-1/freevo/src/audio/plugins/apodcast.py
branches/rel-1/freevo/src/audio/plugins/lastfm.py
branches/rel-1/freevo/src/directory.py
branches/rel-1/freevo/src/plugins/freevo-rendezvous.py
branches/rel-1/freevo/src/plugins/idlebar/progactive.py
branches/rel-1/freevo/src/plugins/idlebar/transcode.py
branches/rel-1/freevo/src/plugins/screensaver/balls.py
branches/rel-1/freevo/src/plugins/screensaver/bouncing_freevo.py
branches/rel-1/freevo/src/plugins/usbstorage.py
branches/rel-1/freevo/src/plugins/vfd.py
branches/rel-1/freevo/src/video/plugins/imdb.py
branches/rel-1/freevo/src/video/plugins/reencode.py
Modified: branches/rel-1/freevo/src/audio/plugins/album_tree.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/album_tree.py (original)
+++ branches/rel-1/freevo/src/audio/plugins/album_tree.py Sun Oct 14
12:10:01 2007
@@ -102,91 +102,91 @@
class PluginInterface(plugin.MainMenuPlugin):
"""
-album_tree v0.51
-http://freevo.sourceforge.net/cgi-bin/doc/PluginAudioAlbumTree
-= Summary =
-Plugin to browse songs in a tree-like way.
-
-Requires pysqlite.
-
-Tested on freevo 1.5.3 and a 12.000 mp3/6.0 MB database.
-
-= Pre Installation =
-
-The sqlite-meta-database should be available.
-
-The audio.rating and audio.logger plugin allso use this database
-,you can skip the rest of the pre-install if those plugins
-are already succesfully installed.
-
- *install pysqlite,sqlite
- *edit your local_config.py : Configure AUDIO_ITEMS
- ('''AudioConfig''' ,don't leave it at the default!)
- *run {{{freevo cache}}}
- *wait.....
- *The meta database should be available now.
-
-= Installation =
-
- *Download freevo-audio-album-tree-0.x.x.tgz
- *{{{
-tar -zxvf freevo-audio-album-tree-0.x.x.tgz
-cd freevo-audio-album-tree0.x.x
-python setup.py
-}}}
-
-= Configuration =
-
- Edit your local_config.py and add this:
-{{{
-plugin.activate('audio.album_tree')
-AUDIO_ALBUM_TREE_SPEC = []
-
-#You could add all trees below:, but probably you only want 1 or 2 of them:
-AUDIO_ALBUM_TREE_SPEC.append({'name':'Artist/Album/Track'
- ,'spec':["artist","album","track||'-'||title"]
- ,'alt_grouping':[None,None,'track']
- })
-#A case sensitive tree like above...
-#Is easy to convert to a convert to a case insensitive tree like below:
-AUDIO_ALBUM_TREE_SPEC.append({'name':'nocase:artist/album/Track'
- ,'spec':["lower(artist)","lower(album)","track||'-'||title"]
- ,'alt_grouping':[None,None,'track']
- })
-
-#my favorite layout:
-AUDIO_ALBUM_TREE_SPEC.append({'name':'(A-Z)/Artist/Album-Year/Track'
- ,'spec':["upper(substr(artist,0,1))"
- ,"artist","album||'-'||year"
- ,"track||'-'||title"]
- ,'alt_grouping':[None,None,'year||album','track']
- })
-
-#you can comment out a tree definition like this:
-#AUDIO_ALBUM_TREE_SPEC.append({'name':'Artist-Album/Track'
-# ,'spec':["artist||'-'||album","track||'-'||title"]
-# ,'alt_grouping':[None,'track']
-# })
-
-#More Examples:
-AUDIO_ALBUM_TREE_SPEC.append({'name':'Year/Artist-Album/Track'
- ,'spec':["year","artist||'-'||album","track||'-'||title"]
- ,'alt_grouping':[None,None,None,'track']
- })
-
-AUDIO_ALBUM_TREE_SPEC.append({'name':'Dirtitle/Artist/Album/Track'
- ,'spec':["dirtitle","artist","album","track||'-'||title"]
- ,'alt_grouping':[None,None,None,'track']
- })
+ Plugin to browse songs in a tree-like way.
-#see http://www.sqlite.org/lang_expr.html for "scripting" functions
-}}}
+ Requires:
+ * pysqlite.
-= Post Installation =
-New plugins are not immediately visible on the freevo webserver.
+ = Pre Installation =
+
+ The sqlite-meta-database should be available.
+
+ The audio.rating and audio.logger plugin allso use this database
+ ,you can skip the rest of the pre-install if those plugins
+ are already succesfully installed.
+
+ *install pysqlite,sqlite
+ *edit your local_config.py : Configure AUDIO_ITEMS
+ ('''AudioConfig''' ,don't leave it at the default!)
+ *run {{{freevo cache}}}
+ *wait.....
+ *The meta database should be available now.
+
+ = Installation =
+
+ *Download freevo-audio-album-tree-0.x.x.tgz
+ *{{{
+ tar -zxvf freevo-audio-album-tree-0.x.x.tgz
+ cd freevo-audio-album-tree0.x.x
+ python setup.py
+ }}}
+
+ = Configuration =
+
+ Edit your local_config.py and add this:
+ {{{
+ plugin.activate('audio.album_tree')
+ AUDIO_ALBUM_TREE_SPEC = []
+
+ #You could add all trees below:, but probably you only want 1 or 2 of them:
+ AUDIO_ALBUM_TREE_SPEC.append({'name':'Artist/Album/Track'
+ ,'spec':["artist","album","track||'-'||title"]
+ ,'alt_grouping':[None,None,'track']
+ })
+ #A case sensitive tree like above...
+ #Is easy to convert to a convert to a case insensitive tree like below:
+ AUDIO_ALBUM_TREE_SPEC.append({'name':'nocase:artist/album/Track'
+ ,'spec':["lower(artist)","lower(album)","track||'-'||title"]
+ ,'alt_grouping':[None,None,'track']
+ })
+
+ #my favorite layout:
+ AUDIO_ALBUM_TREE_SPEC.append({'name':'(A-Z)/Artist/Album-Year/Track'
+ ,'spec':["upper(substr(artist,0,1))"
+ ,"artist","album||'-'||year"
+ ,"track||'-'||title"]
+ ,'alt_grouping':[None,None,'year||album','track']
+ })
+
+ #you can comment out a tree definition like this:
+ #AUDIO_ALBUM_TREE_SPEC.append({'name':'Artist-Album/Track'
+ # ,'spec':["artist||'-'||album","track||'-'||title"]
+ # ,'alt_grouping':[None,'track']
+ # })
+
+ #More Examples:
+ AUDIO_ALBUM_TREE_SPEC.append({'name':'Year/Artist-Album/Track'
+ ,'spec':["year","artist||'-'||album","track||'-'||title"]
+ ,'alt_grouping':[None,None,None,'track']
+ })
+
+ AUDIO_ALBUM_TREE_SPEC.append({'name':'Dirtitle/Artist/Album/Track'
+ ,'spec':["dirtitle","artist","album","track||'-'||title"]
+ ,'alt_grouping':[None,None,None,'track']
+ })
+
+ #see http://www.sqlite.org/lang_expr.html for "scripting" functions
+ }}}
+
+ = Post Installation =
+ New plugins are not immediately visible on the freevo webserver.
+
+ You might want to restart the [wiki:Webserver freevo webserver] after the
+ installation of a new plugin.
-You might want to restart the [wiki:Webserver freevo webserver] after the
installation of a new plugin.
"""
+ __version__ = "album_tree v0.51"
+
def __init__(self):
plugin.MainMenuPlugin.__init__(self)
#config.EVENTS['audio']['DISPLAY'] = Event(FUNCTION_CALL,
arg=self.detach)
Modified: branches/rel-1/freevo/src/audio/plugins/apodcast.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/apodcast.py (original)
+++ branches/rel-1/freevo/src/audio/plugins/apodcast.py Sun Oct 14 12:10:01 2007
@@ -23,24 +23,21 @@
class PluginInterface(plugin.MainMenuPlugin):
-
"""
- AUDIO PODCAST plugin
+ Audio podcast plugin
+
Add to local_conf.py
-
- plugin.activate('audio.apodcast')
- APODCAST_LOCATIONS = [
+ plugin.activate('audio.apodcast')
+ APODCAST_LOCATIONS = [
('TWIT','http://leo.am/podcasts/twit'),
('NPR: Science Friday',
'http://www.sciencefriday.com/audio/scifriaudio.xml'),
('NPR: Story of the Day',
'http://www.npr.org/rss/podcast.php?id=1090'),
('PodTech.net: Technology and Entertainment Video Network',
'http://www.podtech.net/?feed=rss2'),
(' 60 Minutes Podcast - Selected Segments',
'http://www.cbsnews.com/common/includes/podcast/podcast_60min_1.rss'),
('English as a Second Language Podcast',
'http://feeds.feedburner.com/EnglishAsASecondLanguagePodcast')
- ]
+ ]
APODCAST_DIR = '/home/user_name/apodcast'
-
-
"""
def __init__(self):
@@ -55,11 +52,9 @@
'''
freevo plugins -i audio.apodcast returns the info
'''
-
-
return [
- ('APODCAST_LOCATIONS',' ' ,'List of podcast locations'),
- ('APODCAST_DIR',' ' ,'Dir for downloaded podcasts')
+ ('APODCAST_LOCATIONS', None, 'List of podcast locations'),
+ ('APODCAST_DIR', None, 'Dir for downloaded podcasts')
]
def check_dir(self):
@@ -112,7 +107,7 @@
"""
return a list of actions for this item
"""
- items = [ ( self.play , _( 'Listen Audio Podcast' ) ) ]
+ items = [ ( self.play, _( 'Listen Audio Podcast' ) ) ]
return items
def play(self, arg=None, menuw=None):
@@ -157,7 +152,7 @@
"""
return a list of actions for this item
"""
- return [ ( self.create_podcast_menu , 'stations' ) ]
+ return [ ( self.create_podcast_menu, 'stations' ) ]
def create_podcast_submenu(self, arg=None, menuw=None, image=None):
Modified: branches/rel-1/freevo/src/audio/plugins/lastfm.py
==============================================================================
--- branches/rel-1/freevo/src/audio/plugins/lastfm.py (original)
+++ branches/rel-1/freevo/src/audio/plugins/lastfm.py Sun Oct 14 12:10:01 2007
@@ -24,9 +24,10 @@
class PluginInterface(plugin.MainMenuPlugin):
"""
- Last FM plugin
- To activate this plugin, put the following in your local_conf.py.
- -------------------------------------------------------------------
+ Last FM player client
+
+ To activate this plugin, put the following in your local_conf.py:
+
plugin.activate('audio.lastfm')
LASTFM_USER = '<last fm user name>'
LASTFM_PASS = '<last fm password>'
@@ -44,7 +45,6 @@
RIGHT - skip song
1 - send to last.fm LOVE song
9 - send to last.fm BAN song
-
"""
def __init__(self):
Modified: branches/rel-1/freevo/src/directory.py
==============================================================================
--- branches/rel-1/freevo/src/directory.py (original)
+++ branches/rel-1/freevo/src/directory.py Sun Oct 14 12:10:01 2007
@@ -723,8 +723,6 @@
pl.autoplay = True
items = [ pl ] + items
-
-
if pop:
pop.destroy()
# closing the poup will rebuild the menu which may umount
@@ -961,6 +959,9 @@
# ======================================================================
class Dirwatcher(plugin.DaemonPlugin):
+ """
+ Directory handling
+ """
def __init__(self):
plugin.DaemonPlugin.__init__(self)
Modified: branches/rel-1/freevo/src/plugins/freevo-rendezvous.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/freevo-rendezvous.py (original)
+++ branches/rel-1/freevo/src/plugins/freevo-rendezvous.py Sun Oct 14
12:10:01 2007
@@ -43,15 +43,15 @@
class PluginInterface(plugin.DaemonPlugin):
"""
Rendezvous Broadcaster Plugin
+
See: http://www.porchdogsoft.com/products/howl/ (Win32
Plugin/Linux/FreeBSD)
This plugin has been tested with
* Safari on Mac OS X Panther
* IE6 + Howl on Windows XP
- To enable this plugin, add
+ To enable this plugin, add to your local_conf.py:
plugin.activate('freevo-rendezvous')
- to your local_conf.py
"""
r = RendezVous.Rendezvous()
Modified: branches/rel-1/freevo/src/plugins/idlebar/progactive.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/idlebar/progactive.py (original)
+++ branches/rel-1/freevo/src/plugins/idlebar/progactive.py Sun Oct 14
12:10:01 2007
@@ -39,10 +39,13 @@
'''
class PluginInterface(IdleBarPlugin):
- '''
- Display an Icon if prog is active, put following Lines in local_conf.py:
- plugin.activate('idlebar.progactive')
- '''
+ """
+ Display an Icon if prog is active.
+
+ To activate put following Lines in local_conf.py:
+ plugin.activate('idlebar.progactive')
+ """
+
def __init__(self):
IdleBarPlugin.__init__(self)
self.plugin_name='idlebar.progactive'
Modified: branches/rel-1/freevo/src/plugins/idlebar/transcode.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/idlebar/transcode.py (original)
+++ branches/rel-1/freevo/src/plugins/idlebar/transcode.py Sun Oct 14
12:10:01 2007
@@ -51,11 +51,13 @@
class PluginInterface(IdleBarPlugin):
- '''
- This plugin shows the current encoding status
+ """
+ Shows the status of the current encoding job
+
Activate with:
- plugin.activate('idlebar.encoding')
- '''
+ plugin.activate('idlebar.transcode')
+ """
+
def __init__(self):
_debug_('__init__(self)', 2)
IdleBarPlugin.__init__(self)
@@ -109,7 +111,7 @@
def config(self):
- return [ ('ENCODING_IDLEBAR', True, 'Use the idlebar'), ]
+ return [ ('ENCODING_IDLEBAR', True, 'Show on the idlebar, otherwise on
the main screen'), ]
def getprogress(self):
Modified: branches/rel-1/freevo/src/plugins/screensaver/balls.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/screensaver/balls.py (original)
+++ branches/rel-1/freevo/src/plugins/screensaver/balls.py Sun Oct 14
12:10:01 2007
@@ -39,6 +39,10 @@
class PluginInterface(ScreenSaverPlugin):
+ """
+ A bouncing balls screensaver
+ """
+
def __init__(self):
ScreenSaverPlugin.__init__(self)
self.plugin_name = 'screensaver.balls'
Modified: branches/rel-1/freevo/src/plugins/screensaver/bouncing_freevo.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/screensaver/bouncing_freevo.py
(original)
+++ branches/rel-1/freevo/src/plugins/screensaver/bouncing_freevo.py Sun Oct
14 12:10:01 2007
@@ -41,6 +41,10 @@
osd = osd.get_singleton()
class PluginInterface(ScreenSaverPlugin):
+ """
+ A sliding and bouncing Freevo screensaver
+ """
+
def __init__(self):
ScreenSaverPlugin.__init__(self)
self.plugin_name = 'screensaver.bouncing_freevo'
Modified: branches/rel-1/freevo/src/plugins/usbstorage.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/usbstorage.py (original)
+++ branches/rel-1/freevo/src/plugins/usbstorage.py Sun Oct 14 12:10:01 2007
@@ -38,6 +38,7 @@
class PluginInterface(plugin.MainMenuPlugin):
"""
Plugin for usb storage devices.
+
Parameter: name and mountpoint..
You should also activate the usb plugin so that the menu will change
when you plugin in or remove the usb storage device.
Modified: branches/rel-1/freevo/src/plugins/vfd.py
==============================================================================
--- branches/rel-1/freevo/src/plugins/vfd.py (original)
+++ branches/rel-1/freevo/src/plugins/vfd.py Sun Oct 14 12:10:01 2007
@@ -269,7 +269,8 @@
class PluginInterface(plugin.DaemonPlugin):
- """Display context info on Shuttle's VFD (Versatile Front-panel Display)
+ """
+ Display context info on Shuttle's VFD (Versatile Front-panel Display)
Requirements:
* pyusb: installed (http://pyusb.berlios.de/) with name patch as
@@ -283,7 +284,6 @@
local_conf.py file:
plugin.activate('vfd')
-
"""
__author__ = 'Duncan Webb'
__author_email__ = '[EMAIL PROTECTED]'
@@ -292,7 +292,9 @@
__version__ = '$Revision$'
def send(self, data):
- '''Send a piece of data to specified VFD device, retrying if
necessary'''
+ '''
+ Send a piece of data to specified VFD device, retrying if necessary
+ '''
attempts = 3
while attempts > 0:
try:
Modified: branches/rel-1/freevo/src/video/plugins/imdb.py
==============================================================================
--- branches/rel-1/freevo/src/video/plugins/imdb.py (original)
+++ branches/rel-1/freevo/src/video/plugins/imdb.py Sun Oct 14 12:10:01 2007
@@ -48,6 +48,16 @@
from util import htmlenties2txt
class PluginInterface(plugin.ItemPlugin):
+ """
+ You can add IMDB information for video items with the plugin.
+
+ activate with:
+ plugin.activate('video.imdb')
+
+ You can also set imdb_search on a key (e.g. '1') by setting
+ EVENTS['menu']['1'] = Event(MENU_CALL_ITEM_ACTION,
arg='imdb_search_or_cover_search')
+ """
+
def __init__(self, license=None):
if not config.USE_NETWORK:
self.reason = 'no network'
Modified: branches/rel-1/freevo/src/video/plugins/reencode.py
==============================================================================
--- branches/rel-1/freevo/src/video/plugins/reencode.py (original)
+++ branches/rel-1/freevo/src/video/plugins/reencode.py Sun Oct 14 12:10:01 2007
@@ -43,12 +43,12 @@
class PluginInterface(plugin.ItemPlugin):
- '''
- Plug-in to archive recorded TV programmes using EncodingServer
+ """
+ Archive recorded TV programmes using EncodingServer
- This plugin NEEDS a running encodingserver to work properly.
+ This plugin needs a running encodingserver to work properly.
You can start an encodingserver with 'freevo encodingserver start'.
- '''
+ """
def __init__(self):
_debug_('__init__(self)')
-------------------------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc.
Still grepping through log files to find problems? Stop.
Now Search log events and configuration files using AJAX and a browser.
Download your FREE copy of Splunk now >> http://get.splunk.com/
_______________________________________________
Freevo-cvslog mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/freevo-cvslog
