wiki:Plugins/series

Context Navigation


Series

Intelligent filter for TV-series.

Features

  • Episode history aware, no duplicate downloads
  • Plenty of quality options
  • Timeframe, get best quality in given timeframe
  • Episode tracking (for season, episode).
  • Proper & Repack aware
  • Specials aware (grabs episodes with the series title and the word 'special')
  • Tries to ignore season packs, you can use content_size for extra insurance against them.
  • Supports double episodes. i.e. S01E01-E02
  • Series searching support (via discover and emit_series plugins)

Simple configuration:

series:
  - some series
  - another series

If some series and another series have understandable episode numbering any given episode is downloaded only once. FlexGet should support all known episode numbering schemes without any configuration, including dates.

So if we get same episode twice:

  • Some.Series.S2E10.720p.x264-FlexGet
  • Some.Series.S2E10.HR.x264-FooBar

Only one of them is downloaded, with default configuration best quality is chosen.

Related plugins

These plugins are complementary to the series plugin.

  • all_series - Grab all series in the task
  • import_series - Automatically configures series by using another input, some examples:
    • thetvdb_favorites - TheTVDB.com favorites
    • trakt_list - Trakt.tv lists
    • listdir - You local directory listing
  • series_premiere - Download all premieres

Settings

The series plugin supports a number of settings to customize it's behavior. Though the examples show the settings being applied to a single series, they can all be applied to a group of series as well.

How to configure settings per series
How to configure settings with groups

OptionDescription
qualityRequired quality.
qualitiesDownload all listed qualities when they become available.
upgradeKeeps getting the better qualities as they become available.
timeframeWait given amount of time for specified quality to become available, after that fall back to best so far.
targetThe target quality that should be downloaded without waiting for timeframe to complete.
alternate_nameDefine other names which this show is also released as.
parse_onlySeries plugin will not accept or reject any entries, merely fill in all metadata fields.
pathSet path field for this series.
setUse set plugin to set any fields for this series.
exactConfigure exact matching behavior. Needed for series which have similar named series. Uses 'auto' mode as default.
from_groupAccept series only from given groups.
identified_byConfigure how episode numbering is detected. Uses 'auto' mode as default.
propersConfigure how propers are handled.
specialsTurn off specials support for series. (on by default)
special_idsDefines other IDs which will cause entries to be flagged as specials.
prefer_specialsFlag entries matching both special and a normal ID type as specials.
beginManually specify first episode to start series on.
trackingTurn latest episode tracking off, or put into backfill mode.
name_regexpManually specify regexp(s) that matches to series name.
ep_regexpManually specify regexp(s) that matches to episode, season numbering.
id_regexpManually specify regexp(s) that matches to series identifier (numbering).
assume_specialAssume any entry with no series numbering detected is a special and treat it accordingly.

Notes

  • If the series appears in task(s) with slightly different naming conventions and spinoffs like FooBar and FooBar US read this guide.
  • FlexGet respects propers which means that the same episode will be downloaded twice if the second one contains words such as proper, repack, rerip, or real.
  • If series name is written in multiple different ways, don't add them as separate series. This will confuse episode tracking.
  • Check series cookbook for more complete examples and advanced uses.

series Commandline Arguments

The series plugin has several features available at the command line via the flexget series command:

list

Display series summary. flexget series list

show

Displays the releases for a given show that the series plugin has seen. flexget series show <name>

forget

Delete episodes from database or whole series completely.

To delete single episode, use:

flexget series forget <name> <id>

To delete whole series, use:

flexget series forget <name>

begin

Sets the first episode of a show that the series plugin should look for. flexget series begin <name> <id>

execute Commandline Arguments

There are also options to the flexget execute command which affect the series plugin:

--disable-tracking

If episode tracking is causing problems downloading latest episode due large gap in the series history, you can use this option to disable advancement enforcement temporarily. If the latest episode that FlexGet should download is in the feed this argument with --disable-cache is usually enough. If the episode is not anymore in the feed you can feed the task imaginary episode via --inject and --learn. Example:

flexget execute --inject "Pioneer.One.S01E05.For.FlexGet" --learn --disable-tracking --tasks NAME

--stop-waiting

Stops timeframe for given name, thus downloading any episode that is currently pending in the timeframe.

Last modified 3 months ago Last modified on 08/13/14 20:37:04
gipoco.com is neither affiliated with the authors of this page nor responsible for its contents. This is a safe-cache copy of the original web site.