File: client.rst

package info (click to toggle)
python-transmission-rpc 7.0.11-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 440 kB
  • sloc: python: 2,605; sh: 9; makefile: 4
file content (35 lines) | stat: -rw-r--r-- 771 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
Client
========

Client is the class handling the Transmission JSON-RPC client protocol.

Torrent ids
------------

Many functions in Client takes torrent id.
You can find torrent-ids spec in `official docs
<https://github.com/transmission/transmission/blob/main/docs/rpc-spec.md#31-torrent-action-requests>`_

.. note::

    It's recommended that you use torrent's ``info_hash`` as torrent id. The torrent's ``info_hash`` will never change.


.. automodule:: transmission_rpc

.. autofunction:: from_url

.. autoclass:: Client
    :members:


Timeouts
--------

Since most methods results in HTTP requests against Transmission, it is
possible to provide a argument called ``timeout``. Default timeout is 30 seconds.


.. toctree::
   :maxdepth: 2
   :caption: Contents: