Metadata-Version: 2.1
Name: transmission-clutch
Version: 6.0.2
Summary: An RPC client library for the Transmission BitTorrent client
Home-page: https://github.com/mhadam/clutch
License: MIT
Author: mhadam
Author-email: michael@hadam.us
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: pydantic (>=1.4,<2.0)
Requires-Dist: requests (>=2.22.0,<3.0.0)
Requires-Dist: typing-extensions (>=3.7.4,<4.0.0); python_version == "3.7"
Project-URL: Documentation, https://clutch.readthedocs.io/en/latest/
Project-URL: Repository, https://github.com/mhadam/clutch
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/pyversions/transmission-clutch.svg
    :target: https://pypi.org/project/transmission-clutch
    :alt: PyPI versions badge

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
    :target: https://github.com/ambv/black
    :alt: Black formatter badge

.. image:: https://img.shields.io/pypi/l/transmission-clutch.svg
    :target: https://en.wikipedia.org/wiki/MIT_License
    :alt: License badge

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

Support
=======
btc: bc1q9spjh7nuqatz4pa7dscd0357p3ql588tla6af7

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(...)

