Metadata-Version: 2.4
Name: transmission-clutch
Version: 7.0.3
Summary: An RPC client library for the Transmission BitTorrent client
Project-URL: Documentation, https://clutch.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/mhadam/clutch
Project-URL: Issues, https://github.com/mhadam/clutch/issues
Author-email: Michael Hadam <michael@hadam.us>
Maintainer-email: Michael Hadam <michael@hadam.us>
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: pydantic~=2.10
Requires-Dist: requests~=2.32
Description-Content-Type: text/x-rst

Clutch
------

.. image:: https://readthedocs.org/projects/clutch/badge/?version=latest
    :target: https://clutch.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation badge

.. image:: https://img.shields.io/pypi/v/transmission-clutch.svg
    :target: https://pypi.org/project/transmission-clutch
    :alt: PyPI badge

.. image:: https://img.shields.io/pypi/dm/transmission-clutch.svg
    :target: https://pypistats.org/packages/transmission-clutch
    :alt: PyPI downloads badge

Documentation
=============

Found here: `<https://clutch.readthedocs.io>`_

Quick start
===========

Install the package:

.. code-block:: console

    $ pip install transmission-clutch

Make a client:

.. code-block:: python

    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:

.. code-block:: python

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

.. _urllib.parse.urlparse: https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlparse

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

Methods are called by first specifying a group:

.. code-block:: python

    client.torrent.add(...)
