rtorrent-rpc 0.9.5

Typed rtorrent rpc client

Typed rtorrent rpc client

rtorrent-rpc is a python wrapper on top of rtorrent XML RPC protocol, hosted on GitHub at github.com/trim21/rtorrent-rpc

Document is hosted at https://rtorrent-rpc.readthedocs.io/ by readthedocs.

Introduction

pip install rtorrent-rpc

supported extras:

• orjson: use orjson as jsonlib

pip install 'rtorrent-rpc[orjson]'

Contributing

All kinds of PRs (docs, feature, bug fixes and eta...) are most welcome.

Quick Start

from rtorrent_rpc import RTorrent

client = RTorrent(address='scgi://127.0.0.1:5000')
unix_client = RTorrent(address='scgi:///home/ubuntu/.local/share/rtorrent.sock')

tls cert validation is enabled when you are using https protocol, set environment variable PY_RTORRENT_RPC_DISABLE_TLS_CERT=1 to disable.

Known Problem

rTorrent's xmlrpc-c does not support all utf8 characters, for example, emoji.

If torrent name of file name contains any emoji, you can't retrieve correct torrent name or file name through xmlrpc-c.

Please consider either:

• Compiling rtorrent with tinyxml2 instead of xmlrpc-c, which will allow all unicode characters
• Using a rtorrent distro with json-rpc support, for example: jesec/rtorrent, which support utf8 correctly. If your rtorrent distro support jsonrpc, you can use send json-rpc request with RTorrent(...).jsonrpc.call(...).

License

rtorrent-rpc is licensed under the MIT license.