flexget.plugins.input.rss module

class flexget.plugins.input.rss.InputRSS

Bases: object

Parses RSS feed.

Hazzlefree configuration for public rss feeds:

rss: <url>

Configuration with basic http authentication:

rss:
  url: <url>
  username: <name>
  password: <password>

Advanced usages:

You may wish to clean up the entry by stripping out all non-ascii characters. This can be done by setting ascii value to yes.

Example:

rss:
  url: <url>
  ascii: yes

In case RSS-feed uses some nonstandard field for urls and automatic detection fails you can configure plugin to use url from any feedparser entry attribute.

Example:

rss:
  url: <url>
  link: guid

If you want to keep information in another rss field attached to the flexget entry, you can use the other_fields option.

Example:

rss:
  url: <url>
  other_fields: [date]

You can disable few possibly annoying warnings by setting silent value to yes on feeds where there are frequently invalid items.

Example:

rss:
  url: <url>
  silent: yes

You can group all the links of an item, to make the download plugin tolerant to broken urls: it will try to download each url until one works. Links are enclosures plus item fields given by the link value, in that order. The value to set is “group_links”.

Example:

rss:
  url: <url>
  group_links: yes

add_enclosure_info(entry, enclosure, filename=True, multiple=False)

Store information from an rss enclosure into an Entry.

build_config(config)

Set default values to config.

escape_content(content)

on_task_input(**kwargs)

process_invalid_content(task, data, url)

If feedparser reports error, save the received data and log error.

schema = {'additionalProperties': False, 'anyOf': [{'format': 'url'}, {'format': 'file'}], 'properties': {'all_entries': {'default': True, 'type': 'boolean'}, 'ascii': {'default': False, 'type': 'boolean'}, 'escape': {'default': False, 'type': 'boolean'}, 'filename': {'type': 'boolean'}, 'group_links': {'default': False, 'type': 'boolean'}, 'link': {'oneOf': [{'items': {'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'title': 'single value', 'type': 'string'}]}, 'other_fields': {'items': {'additionalProperties': {'type': 'string'}, 'type': ['string', 'object']}, 'type': 'array'}, 'password': {'type': 'string'}, 'silent': {'default': False, 'type': 'boolean'}, 'title': {'type': 'string'}, 'url': {'anyOf': [{'format': 'url'}, {'format': 'file'}], 'type': 'string'}, 'username': {'type': 'string'}}, 'required': ['url'], 'type': ['string', 'object']}

flexget.plugins.input.rss.fp_field_name(name)

Translate literal field name to the sanitized one feedparser will use.

flexget.plugins.input.rss.register_plugin()