Metadata-Version: 2.1
Name: putio-automator
Version: 2.1.1.dev4
Summary: Automate management of torrents and files on Put.IO.
Home-page: https://github.com/datashaman/putio-automator
Author: Marlin Forbes
Author-email: marlinf@datashaman.com
License: MIT
Description: # put.io automator
        
        A suite of commands for managing torrents, transfers and files on **Put.IO**
        
        Configure Sickrage to use a Torrent black hole folder. Configure this application to
        monitor that folder and download to the same folder used for post-processing in Sickrage.
        
        **Note** Version 2 drops Docker and RPi support. The application should still run just fine in both contexts; however it is no longer directly supported. Also, support for Python 2 has been dropped.
        
        ## Table of Contents
        
        <!-- toc -->
        
        * [Installation](#installation)
        * [Configuration](#configuration)
        * [Regular usage](#regular-usage)
          * [Torrents](#torrents)
          * [Files](#files)
          * [Transfers](#transfers)
          * [Database](#database)
        
        <!-- toc stop -->
        
        ## Installation
        
        Install the putio-automator package locally **for your user**. System-wide installation is not supported.
        
            pip install --user putio-automator
        
        This will install a new command-line utility `putio` in `$HOME/.local/bin`. Ensure it's on your path:
        
            echo 'PATH=$HOME/.local/bin:$PATH' >> .profile # or .bashrc or .zshrc, ymmv
        
        ## Configuration
        
        Initialize the application with a basic configuration locally for your user:
        
            putio config init
        
        This will interactively prompt you with some questions about where files should be stored, and your **Put.IO** `OAuth Token`.
        
        To get an `OAuth Token` register your application on **Put.IO**, and copy the `OAuth Token` (found under the key icon).
        
        **NB** The directories entered must be writable by the user running the application.
        
        Check that the connection is working:
        
            putio account info
        
        You should see a JSON packet with information about your account. If not, check your `OAuth Token` is correct.
        
        To help you debug config issues, show the current config:
        
            putio config show
        
        ## Regular usage
        
        ### Torrents
        
        Watch configured directory for torrents and add to **Put.IO**:
        
            putio torrents watch [-a] [-p PARENT_ID]
        
        * -a, --add_existing
          Add existing torrents first.
        * -p PARENT_ID, --parent_id PARENT_ID
          Parent folder to add files to.
        
        Add existing torrents to **Put.IO**:
        
            putio torrents add [-p PARENT_ID]
        
        * -p PARENT_ID, --parent_id PARENT_ID
          Parent folder to add files to.
        
        ### Files
        
        List files on **Put.IO**:
        
            putio files list [-p PARENT_ID]
        
        * -p PARENT_ID, --parent_id PARENT_ID
          Parent folder to list files from.
        
        Download files from **Put.IO** to configured downloads directory:
        
            putio files download [-l LIMIT] [-c CHUNK_SIZE] [-p PARENT_ID]
        
        * -l LIMIT, --limit LIMIT
          Maximum number of files to download in one go.
        * -c CHUNK_SIZE, --chunk_size CHUNK_SIZE
          Defaults to 256kb.
        * -p PARENT_ID, --parent_id PARENT_ID
          Parent folder to download files from.
        * -f FOLDER, --folder FOLDER
          Folder in the downloads directory download to.
        
        ### Transfers
        
        List transfers on **Put.IO**:
        
            putio transfers list
        
        Cancel by status:
        
            putio transfers cancel_by_status statuses
        
        * statuses
          Comma-delimited list of statuses.
        
        Cancel completed transfers:
        
            putio transfers cancel_completed
        
        Cancel seeding transfers:
        
            putio transfers cancel_seeding
        
        Clean finished transfers:
        
            putio transfers clean
        
        Groom transfers (cancels seeding and completed transfers, and cleans afterwards):
        
            putio transfers groom
        
        ### Database
        
        The application records downloads in a SQLite database, so you don't inadvertently download the same file over and over when there's an error. This command clears the database record of a specific substring so you can download it again:
        
            putio db forget name
        
        * name
          A substring found in the filename.
        
Keywords: torrent,download,seedbox,media
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
