flexget.plugins.output.subtitles_subliminal module

class flexget.plugins.output.subtitles_subliminal.PluginSubliminal

Bases: object

Search and download subtitles using Subliminal by Antoine Bertin (https://pypi.python.org/pypi/subliminal).

Example (complete task):

subs:
  find:
    path:
      - d:\media\incoming
    regexp: '.*\.(avi|mkv|mp4)$'
    recursive: yes
  accept_all: yes
  subliminal:
    languages:
      - ita
    alternatives:
      - eng
    exact_match: no
    providers: gestdown, opensubtitles
    single: no
    directory: /disk/subtitles
    hearing_impaired: yes
    authentication:
      opensubtitles:
        username: myuser
        password: mypassword

on_task_output(task, config)

Register this as an output plugin.

Configuration:

subliminal:
    languages: List of languages (as IETF codes) in order of preference. At least one is required.
    alternatives: List of second-choice languages; subs will be downloaded but entries rejected.
    exact_match: Use file hash only to search for subs, otherwise Subliminal will try to guess by filename.
    providers: List of providers from where to download subtitles.
    single: Download subtitles in single mode (no language code added to subtitle filename).
    directory: Path to directory where to save the subtitles, default is next to the video.
    hearing_impaired: Prefer subtitles for the hearing impaired when available
    authentication: >
      Dictionary of configuration options for different providers.
      Keys correspond to provider names, and values are dictionaries, usually specifying `username` and
      `password`.

on_task_start(task, config)

schema = {'additionalProperties': False, 'properties': {'alternatives': {'items': {'type': 'string'}, 'type': 'array'}, 'authentication': {'properties': {'addic7ed': {'type': 'object'}, 'gestdown': {'type': 'object'}, 'napiprojekt': {'type': 'object'}, 'opensubtitles': {'type': 'object'}, 'opensubtitlescom': {'type': 'object'}, 'opensubtitlescomvip': {'type': 'object'}, 'opensubtitlesvip': {'type': 'object'}, 'podnapisi': {'type': 'object'}, 'tvsubtitles': {'type': 'object'}}, 'type': 'object'}, 'directory': {'type': 'string'}, 'exact_match': {'default': True, 'type': 'boolean'}, 'hearing_impaired': {'default': False, 'type': 'boolean'}, 'languages': {'items': {'type': 'string'}, 'minItems': 1, 'type': 'array'}, 'providers': {'items': {'enum': ['addic7ed', 'gestdown', 'napiprojekt', 'opensubtitles', 'opensubtitlescom', 'opensubtitlescomvip', 'opensubtitlesvip', 'podnapisi', 'tvsubtitles'], 'type': 'string'}, 'type': 'array'}, 'single': {'default': True, 'type': 'boolean'}}, 'required': ['languages'], 'type': 'object'}

flexget.plugins.output.subtitles_subliminal.register_plugin()