Typed rtorrent rpc client
Project description
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 do 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.
Please consider use 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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for rtorrent_rpc-0.7.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50c812a7e9b8c3913c34e090f625b5daaf75d38c0bd67433aefca0f8e0828b5b |
|
MD5 | e4ef28698ce26a29a67d80f2fdd14760 |
|
BLAKE2b-256 | 6b8f902ecc862b65fb023e0d0b2ce0900cdb3518d5d5390a3fc477bfe9b5bf31 |