Metadata-Version: 2.1
Name: clutchless
Version: 0.1.0a1
Summary: A CLI tool to manage torrents and their data in Transmission
Home-page: https://github.com/mhadam/clutchless
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: colorama (>=0.4.4,<0.5.0)
Requires-Dist: docopt (>=0.6.2,<0.7.0)
Requires-Dist: texttable (>=1.6.3,<2.0.0)
Requires-Dist: torrentool (>=1.1.0,<2.0.0)
Requires-Dist: transmission-clutch (>=5.0.0,<6.0.0)
Project-URL: Documentation, https://github.com/mhadam/clutchless
Project-URL: Repository, https://github.com/mhadam/clutchless
Description-Content-Type: text/x-rst

**This is still under active development - use at your own risk!**

Clutchless
----------

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

.. image:: https://img.shields.io/pypi/pyversions/clutchless.svg
    :target: https://pypi.org/project/clutchless
    :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/clutchless.svg
    :target: https://en.wikipedia.org/wiki/MIT_License
    :alt: License badge

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

.. image:: https://coveralls.io/repos/github/mhadam/clutchless/badge.svg?branch=develop
    :target: https://coveralls.io/github/mhadam/clutchless?branch=develop


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

Install the package:

.. code-block:: console

    $ pip install clutchless

The ``-h`` flag can be used to bring up documentation, e.g. ``clutchless -h``::

    A tool for working with torrents and their data in the Transmission BitTorrent client.

    Usage:
        clutchless [options] <command> [<args> ...]

    Options:
        -a <address>, --address <address>   Address for Transmission (default is http://localhost:9091/transmission/rpc).
        -h, --help  Show this screen.
        --version   Show version.

    The available clutchless commands are:
        add         Add torrents to Transmission (with or without data).
        find        Locate data that belongs to torrent files.
        link        For torrents with missing data in Transmission, find the data and fix the location.
        archive     Copy .torrent files from Transmission for backup.
        organize    Migrate torrents to a new location, sorting them into separate folders for each tracker.
        prune       Remove torrents from Transmission with completely missing data.

    See 'clutchless help <command>' for more information on a specific command.

Examples
********

To copy all the ``.torrent`` files in Transmission to ``~/torrent_archive``::

    clutchless archive ~/torrent_archive


To add some torrents to Transmission, searching ``~/torrent_archive`` for ``.torrent`` files and finding data in
``~/torrent_data``::

    clutchless add ~/torrent_archive -d ~/torrent_data

To look for matching data given a search folder (``~/torrent_data``) and a directory (``~/torrent_files``)
that contains ``.torrent`` files::

    clutchless find ~/torrent_files -d ~/torrent_data


To organize torrents into folders under ``~/new_place`` and named by tracker, with ``default_folder`` for ones missing
a folder name for one reason or another::

    clutchless organize ~/new_place -d default_folder

Remove torrents that are completely missing data::

    clutchless prune client

Remove ``.torrent`` files from some folders (``folder1``, ``folder2``) that are found in Transmission::

    clutchless prune folder ~/folder1 ~/folder2

To associate torrent to their matching data found in any number of folders (in this case just two)::

    clutchless link ~/data_folder_1 ~/data_folder_2

