flexget.plugins.clients.aria2 module

class flexget.plugins.clients.aria2.JsonRpcClient(server, port, scheme, rpc_path, username=None, password=None, secret=None)

Bases: RpcClient

static _default_error_handle(code, message)

static _default_success_handle(response)

_get_req_params(method, params=None)

_post(method, params, on_success=<staticmethod(<function JsonRpcClient._default_success_handle>)>, on_fail=<staticmethod(<function JsonRpcClient._default_error_handle>)>)

add_torrent(torrent, options)

add_uri(uris, options)

get_global_stat()

ADDMETALINK_METHOD = 'aria2.addMetalink'

ADDTORRENT_METHOD = 'aria2.addTorrent'

ADDURI_METHOD = 'aria2.addUri'

GETGLOBALSTAT_METHOD = 'aria2.getGlobalStat'

RPC_ID = 'FLEXGET'

RPC_VERSION = '2.0'

class flexget.plugins.clients.aria2.OutputAria2

Bases: object

Simple Aria2 output.

Example:

aria2:
  path: ~/downloads/

add_entry(aria2, entry, config, task)

Add entry to Aria2.

Parameters:

aria2 (RpcClient)

on_task_output(task, config)

prepare_config(config)

schema = {'additionalProperties': False, 'properties': {'add_extension': {'default': 'no', 'oneOf': [{'type': 'string'}, {'type': 'boolean'}]}, 'filename': {'type': 'string'}, 'options': {'additionalProperties': {'oneOf': [{'type': 'string'}, {'type': 'number'}, {'type': 'boolean'}]}, 'type': 'object'}, 'password': {'default': '', 'type': 'string'}, 'path': {'type': 'string'}, 'port': {'default': 6800, 'type': 'integer'}, 'rpc_mode': {'default': 'xml', 'enum': ['xml', 'json'], 'type': 'string'}, 'rpc_path': {'default': 'rpc', 'type': 'string'}, 'scheme': {'default': 'http', 'type': 'string'}, 'secret': {'default': '', 'type': 'string'}, 'server': {'default': 'localhost', 'type': 'string'}, 'username': {'default': '', 'type': 'string'}}, 'required': ['path'], 'type': 'object'}

class flexget.plugins.clients.aria2.RpcClient(server, port, scheme, rpc_path, username, password, secret)

Bases: object

add_torrent(torrent, options)

add_uri(uris, options)

class flexget.plugins.clients.aria2.XmlRpcClient(server, port, scheme, rpc_path, username=None, password=None, secret=None)

Bases: RpcClient

add_torrent(torrent, options)

add_uri(uris, options)

flexget.plugins.clients.aria2.register_plugin()