flexget.plugins.input.next_sonarr_episodes module

class flexget.plugins.input.next_sonarr_episodes.NextSonarrEpisodes

Bases: object

Return the 1st missing episode of every show configures in Sonarr.

This can be used with the discover plugin or set_series_begin plugin to get the relevant data from Sonarr.

Syntax:

next_sonarr_episodes:
  base_url=<value> (Required)
  port=<value> (Default is 80)
  api_key=<value> (Required)
  include_ended=<yes|no> (Default is yes)
  only_monitored=<yes|no> (Default is yes)
  page_size=<value> (Default is 50)

Page size determines the amount of results per each API call. Higher value means a bigger response. Lower value means more calls. Should be changed if there are performance issues.

Usage (Example with discover):

discover_from_sonarr_task:
  discover:
    what:
      - next_sonarr_episodes:
          base_url: '{? credentials.sonarr.url ?}'
          port: 8989
          api_key: '{? credentials.sonarr.api_key ?}'
          include_ended: false
    from:
      - kat:
          verified: yes
  all_series: yes
  download: c:\bla\

Usage (Example with set_series_begin):

set-series-begin-from-sonarr:
  next_sonarr_episodes:
    base_url: '{{ secrets.credentials.sonarr.url }}'
    port: 8989
    api_key: '{{ secrets.credentials.sonarr.api_key }}'
    include_ended: false
  accept_all: yes
  set_series_begin: yes

get_page(task, config, page_number)

on_task_input(task, config)

schema = {'additionalProperties': False, 'properties': {'api_key': {'type': 'string'}, 'base_url': {'type': 'string'}, 'include_ended': {'default': True, 'type': 'boolean'}, 'only_monitored': {'default': True, 'type': 'boolean'}, 'page_size': {'default': 50, 'type': 'number'}, 'port': {'default': 80, 'type': 'number'}}, 'required': ['api_key', 'base_url'], 'type': 'object'}

flexget.plugins.input.next_sonarr_episodes.register_plugin()