|
1 |
| -# Typed rtorrent rpc client |
2 |
| - |
3 |
| -[](https://pypi.org/project/rtorrent-rpc/) |
4 |
| -[](https://pypi.org/project/rtorrent-rpc/) |
5 |
| -[](https://rtorrent-rpc.readthedocs.io/) |
6 |
| - |
7 |
| -`rtorrent-rpc` is a python wrapper on top of rtorrent XML RPC protocol, |
8 |
| -hosted on GitHub |
9 |
| -at [github.com/trim21/rtorrent-rpc](https://github.com/trim21/rtorrent-rpc) |
10 |
| - |
11 |
| -Document is hosted at https://rtorrent-rpc.readthedocs.io/ by readthedocs. |
12 |
| - |
13 |
| -## Introduction |
14 |
| - |
15 |
| -```console |
16 |
| -pip install rtorrent-rpc |
17 |
| -``` |
18 |
| - |
19 |
| -supported extras: |
20 |
| - |
21 |
| -- `orjson`: use [orjson](https://github.com/ijl/orjson) as jsonlib |
22 |
| - |
23 |
| -```console |
24 |
| -pip install 'rtorrent-rpc[orjson]' |
25 |
| -``` |
26 |
| - |
27 |
| -## Contributing |
28 |
| - |
29 |
| -All kinds of PRs (docs, feature, bug fixes and eta...) are most welcome. |
30 |
| - |
31 |
| -## Quick Start |
32 |
| - |
33 |
| -```python |
34 |
| -from rtorrent_rpc import RTorrent |
35 |
| - |
36 |
| -client = RTorrent(address='scgi://127.0.0.1:5000') |
37 |
| -unix_client = RTorrent(address='scgi:///home/ubuntu/.local/share/rtorrent.sock') |
38 |
| -``` |
39 |
| - |
40 |
| -tls cert validation is enabled when you are using `https` protocol, set environment |
41 |
| -variable `PY_RTORRENT_RPC_DISABLE_TLS_CERT=1` to disable. |
42 |
| - |
43 |
| -## Known Problem |
44 |
| - |
45 |
| -rTorrent's [xmlrpc do not support all utf8 characters](https://github.com/rakshasa/rtorrent/issues/1250), |
46 |
| -for example, emoji. |
47 |
| - |
48 |
| -If torrent name of file name contains any emoji, |
49 |
| -you can't retrieve correct torrent name or file name through xmlrpc. |
50 |
| - |
51 |
| -Please consider use a rtorrent distro with json-rpc support, |
52 |
| -for example: [jesec/rtorrent](https://github.com/jesec/rtorrent), which support utf8 |
53 |
| -correctly. |
54 |
| - |
55 |
| -If your rtorrent distro support jsonrpc, |
56 |
| -you can use send json-rpc request with `RTorrent(...).jsonrpc.call(...)`. |
57 |
| - |
58 |
| -## License |
59 |
| - |
60 |
| -`rtorrent-rpc` is licensed under the MIT license. |
| 1 | +bangumi wiki syntax parser for python |
0 commit comments