Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 1.79 KB

README.rst

File metadata and controls

65 lines (41 loc) · 1.79 KB

Clutch

Documentation badge PyPI badge PyPI versions badge Black formatter badge License badge PyPI downloads badge

Documentation

Found here: https://clutch.readthedocs.io

Quick start

Install the package:

$ pip install transmission-clutch

Make a client:

from clutch import Client
client = Client()

If you find the client isn't connecting (an error will be raised), make sure you're entering the address correctly. Reference urllib.parse.urlparse for parsing rules.

You can specify Transmission's address when making the client:

client = Client(address="http://localhost:9091/transmission/rpc")

RPC methods are separated into groups: torrent, session, queue and misc.

Methods are called by first specifying a group:

client.torrent.add(...)