flexget.plugins.clients.transmission module#

class flexget.plugins.clients.transmission.PluginTransmission[source]#

Bases: TransmissionBase

Add url from entry url to transmission.

Example:

transmission:
  host: localhost
  port: 9091
  netrc: /home/flexget/.tmnetrc
  username: myusername
  password: mypassword
  path: the download location

Default values for the config elements:

transmission:
  host: localhost
  port: 9091
  enabled: yes

_make_torrent_options_dict(config, entry)[source]#

on_task_abort(task, config)#: Make sure all temp files are cleaned up when entries are learned.

on_task_download(task, config)[source]#: Call download plugin to generate the temp files we will load into deluge then verify they are valid torrents.

on_task_learn(task, config)[source]#: Make sure all temp files are cleaned up when entries are learned.

on_task_output(task, config)[source]#

prepare_config(config)[source]#

schema = {'anyOf': [{'type': 'boolean'}, {'additionalProperties': False, 'properties': {'action': {'enum': ['add', 'remove', 'purge', 'pause', 'resume', 'bypass_queue'], 'type': 'string'}, 'add_paused': {'type': 'boolean'}, 'bandwidth_priority': {'type': 'number'}, 'content_filename': {'type': 'string'}, 'enabled': {'type': 'boolean'}, 'honor_limits': {'type': 'boolean'}, 'host': {'type': 'string'}, 'include_files': {'oneOf': [{'items': {'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'title': 'single value', 'type': 'string'}]}, 'include_subs': {'type': 'boolean'}, 'labels': {'oneOf': [{'items': {'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'title': 'single value', 'type': 'string'}]}, 'magnetization_timeout': {'type': 'integer'}, 'main_file_only': {'type': 'boolean'}, 'main_file_ratio': {'type': 'number'}, 'max_connections': {'type': 'integer'}, 'max_down_speed': {'type': 'number'}, 'max_up_speed': {'type': 'number'}, 'netrc': {'type': 'string'}, 'password': {'type': 'string'}, 'path': {'type': 'string'}, 'port': {'type': 'integer'}, 'queue_position': {'type': 'integer'}, 'ratio': {'type': 'number'}, 'rename_like_files': {'type': 'boolean'}, 'skip_files': {'oneOf': [{'items': {'title': 'single value', 'type': 'string'}, 'minItems': 1, 'title': 'multiple values', 'type': 'array', 'uniqueItems': False}, {'title': 'single value', 'type': 'string'}]}, 'username': {'type': 'string'}}, 'type': 'object'}]}#

class flexget.plugins.clients.transmission.PluginTransmissionClean[source]#

Bases: TransmissionBase

DEPRECATED: A separate task using from_transmission and transmission with remove action should be used instead.

Remove completed torrents from Transmission.

Examples:

clean_transmission: yes  # ignore both time and ratio

clean_transmission:      # uses transmission's internal limits for idle time and seed ratio ( if defined )
  transmission_seed_limits: yes

clean_transmission:      # matches time only
  finished_for: 2 hours

clean_transmission:      # matches ratio only
  min_ratio: 0.5

clean_transmission:      # matches time OR ratio
  finished_for: 2 hours
  min_ratio: 0.5

Default values for the config elements:

clean_transmission:
  host: localhost
  port: 9091
  enabled: yes

on_task_exit(task, config)[source]#

schema = {'anyOf': [{'type': 'boolean'}, {'additionalProperties': False, 'properties': {'delete_files': {'type': 'boolean'}, 'directories': {'items': {'format': 'regex', 'type': 'string'}, 'type': 'array'}, 'enabled': {'type': 'boolean'}, 'finished_for': {'format': 'interval', 'type': 'string'}, 'host': {'type': 'string'}, 'min_ratio': {'type': 'number'}, 'netrc': {'format': 'file', 'type': 'string'}, 'password': {'type': 'string'}, 'port': {'type': 'integer'}, 'preserve_tracker': {'format': 'regex', 'type': 'string'}, 'tracker': {'format': 'regex', 'type': 'string'}, 'transmission_seed_limits': {'type': 'boolean'}, 'username': {'type': 'string'}}, 'type': 'object'}], 'deprecated': True, 'deprecationMessage': 'The clean_transmission plugin is deprecated. Configure a new task using the from_transmission plugin as well as the transmission plugin using the remove or purge action.'}#

class flexget.plugins.clients.transmission.PluginTransmissionInput[source]#

Bases: TransmissionBase

on_task_input(task, config)[source]#

prepare_config(config)[source]#

schema = {'anyOf': [{'type': 'boolean'}, {'additionalProperties': False, 'properties': {'enabled': {'type': 'boolean'}, 'host': {'type': 'string'}, 'netrc': {'format': 'file', 'type': 'string'}, 'only_complete': {'type': 'boolean'}, 'password': {'type': 'string'}, 'port': {'type': 'integer'}, 'username': {'type': 'string'}}, 'type': 'object'}]}#

class flexget.plugins.clients.transmission.TransmissionBase[source]#

Bases: object

check_seed_limits(torrent, session)[source]#

Parameters:: torrent (Torrent)

create_rpc_client(config)[source]#

Return type:: transmission_rpc.Client

on_task_start(task, config)[source]#

prepare_config(config)[source]#

torrent_info(torrent, config)[source]#

Parameters:: torrent (Torrent)

flexget.plugins.clients.transmission.register_plugin()[source]#