Peapod.peapod

Package Peapod :: Module peapod

[show private | hide private]

Module Peapod.peapod

Python podcast client

This script uses the excellent RSS/Atom feed parser from http://feedparser.org and the "openanything" module from the equally excellent "Dive into Python" http://diveintopython.org/ .

Classes
`importfeeds`	Class to import feeds from RSS and OPML sources.
`newTracks`	A class to manage actions based on recent changes to the peapod databases.
`peapodConf`	Class to manage the configuration for peapod.
`podcastListXML`	Manages the spawning of threads to fetch each feed in the list of known feeds.
`podcastThreaded`	Update a feed and parse it for new enclosures, using conditional download information, if available.

Exceptions
`PeapodError`

Function Summary
	`cleanpath(path)` Takes a path and expands any variables and ~ and returns an absolute path
	`downloadList()` Parse download.log and extract information about previously downloaded files.
	`downloadListFull()` Parses old version of download.log to extract filenames of previously downloaded files.
	`exportfeeds(feedlist)` Export feeds to OPML on stdout.
	`feedLog()` Parse feed.log and extract information about known feeds, and any associated conditional download information (e-tag, modified timestamps).
	`getConfig(cmd_line)` A function to wrap the creation of peapodConf as a singleton class.
	`purgeConfig()` A function to unload the config object.
	`upgradeDownloadLog(logfile)` Upgrade a comma-delimited download.log to new format, using '\|\|' as a delimiter.

Variable Summary
`str`	`__version__` = `'pre1.0'`
`RootLogger`	`logger` = `<logging.RootLogger instance at 0xb756d6ac>`
`int`	`threadcount` = 0
`str`	`USER_AGENT` = `'Peapod/pre1.0 +http://www.peapodpy.org.uk'...`

Function Details

cleanpath(path)

Takes a path and expands any variables and ~ and returns an absolute path

downloadList()

Parse download.log and extract information about previously downloaded files. Returns a dict, composed of two lists.

downloadListFull()

Parses old version of download.log to extract filenames of previously downloaded files. Returns a list.

I believe this is no longer used and can be purged.

exportfeeds(feedlist)

Export feeds to OPML on stdout.

feedLog()

Parse feed.log and extract information about known feeds, and any associated conditional download information (e-tag, modified timestamps). Returns information as a dict, indexed by URL.

getConfig(cmd_line=None)

A function to wrap the creation of peapodConf as a singleton class. Only the first call to getConfig will recognise any command line options passed to it.

purgeConfig()

A function to unload the config object. This shouldn't be necessary during normal functioning, but is very handy for running test suites over the config class. Note that the object is still only subject to garbage collection, and is not destroyed immediately.

upgradeDownloadLog(logfile)

Upgrade a comma-delimited download.log to new format, using '||' as a delimiter.

Variable Details

version

Type:: str
Value:: 'pre1.0'

logger

Type:: RootLogger
Value:: <logging.RootLogger instance at 0xb756d6ac>

threadcount

Type:: int
Value:: 0

USER_AGENT

Type:: str
Value:: 'Peapod/pre1.0 +http://www.peapodpy.org.uk'

Generated by Epydoc 2.1 on Sun Feb 13 06:25:12 2011

http://epydoc.sf.net