A lightweight pure-python rpc client for deluge. Note, does not support events and any additional replies from deluge will mess up the datastream.
- Deluge 1.3.x, 2.0 beta
- Python 2.7, 3.4, 3.5, 3.6
From GitHub (develop):
pip install git+https://github.com/JohnDoee/deluge-client.git#develop
From PyPi (stable):
pip install deluge-client
>>> from deluge_client import DelugeRPCClient >>> client = DelugeRPCClient('127.0.0.1', 12345, 'username', 'password') >>> client.connect() >>> client.connected True >>> client.call('core.get_torrents_status', {}, ['name']) {'79816060ea56d56f2a2148cd45705511079f9bca': {'name': 'TPB.AFK.2013.720p.h264-SimonKlose'}} >>> client.core.get_torrents_status({}, ['name']) {'79816060ea56d56f2a2148cd45705511079f9bca': {'name': 'TPB.AFK.2013.720p.h264-SimonKlose'}}
It is also usable as a context manager.
>>> from deluge_client import DelugeRPCClient >>> with DelugeRPCClient('127.0.0.1', 12345, 'username', 'password') as client: ... client.call('core.get_torrents_status', {}, ['name']) {'79816060ea56d56f2a2148cd45705511079f9bca': {'name': 'TPB.AFK.2013.720p.h264-SimonKlose'}}
Idiom to use for automatic reconnect where the daemon might be offline at call time.
import time from deluge_client import DelugeRPCClient, FailedToReconnectException def call_retry(client, method, *args, **kwargs): # We will only try the command 10 times for _ in range(10): try: return client.call(method, *args, **kwargs) except FailedToReconnectException: # 5 second delay between calls time.sleep(5)
Idiom usage
client = DelugeRPCClient('127.0.0.1', 58846, 'username', 'password', automatic_reconnect=True) # The client has to be online when you start the process, # otherwise you must handle that yourself. client.connect() call_retry(client, 'core.get_torrents_status', {}, ['name'])
Sadly, this part isn't well documented. Your best bet is to check out the source code and try to figure
out what you need. The commands are namespaced so the commands you mostly need, core commands, are prefixed
with a core.
- Check out this search for all commands
and core.py for core commands.
The exported commands are decorated with @export
.
You can also get a list of exported commands by calling the daemon.get_method_list
method:
client.call('daemon.get_method_list')
MIT, see LICENSE