4.9 KiB
The RSS plugin
Reading
rss info <url|feed>
Returns information from the given RSS feed, namely the title, URL, description, and last update date, if available.
rss announce list [<channel>]
Returns the list of feeds announced in <channel>. <channel> is only necessary if the message isn't sent in the channel itself.
rss rss <url> [<number of headlines>]
Gets the title components of the given RSS feed. If <number of headlines> is given, return only that many headlines.
Administration
rss remove <name>
Removes the command for looking up RSS feeds at <name> from this plugin.
rss add <name> <url>
Adds a command to this plugin that will look up the RSS feed at the given URL.
rss announce remove [<channel>] <nameurl> ...]
Removes the list of feeds from the current list of announced feeds in <channel>. Valid feeds include the names of registered feeds as well as URLs for RSS feeds. <channel> is only necessary if the message isn't sent in the channel itself.
rss announce add [<channel>] <nameurl> ...]
Adds the list of feeds to the current list of announced feeds in <channel>. Valid feeds include the names of registered feeds as well as URLs for RSS feeds. <channel> is only necessary if the message isn't sent in the channel itself.
Configuration
supybot.plugins.RSS.announcementPrefix
Default value: New news from
Determines what prefix is prepended (if any) to the new news item announcements made in the channel.
supybot.plugins.RSS.bold
Default value: True
Determines whether the bot will bold the title of the feed when it announces new news.
supybot.plugins.RSS.headlineSeparator
Default value: ||
Determines what string is used to separate headlines in new feeds.
supybot.plugins.RSS.initialAnnounceHeadlines
Default value: 5
Indicates how many headlines an rss feed will output when it is first added to announce for a channel.
supybot.plugins.RSS.keywordBlacklist
Default value: []
Space separated list of strings, lets you filter headlines to those not containing any items in this blacklist.
supybot.plugins.RSS.keywordWhitelist
Default value: []
Space separated list of strings, lets you filter headlines to those containing one or more items in this whitelist.
supybot.plugins.RSS.showLinks
Default value: False
Determines whether the bot will list the link along with the title of the feed when the rss command is called. supybot.plugins.RSS.announce.showLinks affects whether links will be listed when a feed is automatically announced.
supybot.plugins.RSS.announce
Default value: []
Determines which RSS feeds should be announced in the channel; valid input is a list of strings (either registered RSS feeds or RSS feed URLs) separated by spaces.
supybot.plugins.RSS.announce.showLinks
Default value: False
Determines whether the bot will list the link along with the title of the feed when a feed is automatically announced.
supybot.plugins.RSS.defaultNumberOfHeadlines
Default value: 1
Indicates how many headlines an rss feed will output by default, if no number is provided.
supybot.plugins.RSS.feeds
Default value: []
Determines what feeds should be accessible as commands.
supybot.plugins.RSS.public
Default value: True
Determines whether this plugin is publicly visible.
supybot.plugins.RSS.waitPeriod
Default value: 1800
Indicates how many seconds the bot will wait between retrieving RSS feeds; requests made within this period will return cached results.