putio-automator 0.4.1.dev3

Automate management of torrents and files on Put.IO.

# 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.

To the people who installed the first version, apologies for the change in direction. It’s a lot easier to rely on cron to schedule things than to fiddle with threads.

## Docker

Pull the latest image:

docker pull datashaman/putio-automator

Run the image:

docker run –rm -it

-e PUTIO_TOKEN=oauth_token -p 9001:9001 -v /local/incomplete:/files/incomplete -v /local/downloads:/files/downloads -v /local/torrents:/files/torrents datashaman/putio-automator

Open http://localhost:9001 to manage processes. Drop torrent files in /local/torrents, and they’ll be uploaded to Put.IO.

Start the downloader service to download the torrents to /local/downloads.

### TODO

• Runtime configure immediate or scheduled downloads.

• Fix logging (currently not visible).

## Setup

Create a virtualenv (recommended, assuming you’re using virtualenvwrapper):

mkvirtualenv putio

Install the package:

pip install -r requirements.txt

Or do both of the above in one command:

mkvirtualenv putio -r requirements.txt

## Configure

Copy the distributed config file:

cp config.py.dist config.py

Edit the config in the file. If you do not specify a LOG_FILENAME, the application will log to the console.

To get a put.io token [register your application](https://put.io/oauth/apps/new) in put.io, and copy the Oauth token (found under the key icon).

## Run

Run the application (while in virtualenv):

python manage.py command

Where command is one of the following:

• torrents_add [ –parent_id 0 ]

  Adds existing torrents to put.io.

• torrents_watch [ –add_first True ] [ –parent_id 0 ]

  Watches torrents folder to add to put.io. By default, adds existing torrents first.

• transfers_cancel_completed

  Cancels completed transfers on put.io.

• transfers_cancel_seeding

  Cancels seeding transfers on put.io.

• transfers_cancel_by_status status[,status]

  Cancels transfers on put.io with a specific statuses (comma delimited list, no spaces).

• transfers_clean

  Cleans your transfers list on put.io.

• transfers_groom

  Cancels seeding and then cleans your transfers list on put.io.

• files_download [ –limit n ] [ –chunk_size 256 ] [ –parent_id 0 ]

  Downloads files from put.io (optionally limited, or with chunk size of 256KB, or within a specific folder on put.io).

• files_list [ –parent_id 0 ]

  Shows JSON of the files available for download on put.io (optionally within a specific folder on put.io).

• forget name

  If the application has encountered a file before, it logs a warning and moves on. Downloads and torrent uploads are recorded in a sqlite3 database: application.db (configurable).

  A simple case-insensitive substring search is done on the downloads table in the sqlite3 database, and any records found are deleted. This will allow the files_download task to re-download a file it has downloaded before.

## Operations

The etc folder contains a supervisor config file for a watcher and a downloader, as well as a cron file for cron.d with a suggested schedule.

The cron file uses flock so the jobs don’t run over eachother if they take a long time (transfer grooming should not take long, though).

I get cheaper bandwidth at an offpeak time, so I schedule my downloads to happen between midnight and 6AM.

The downloader program in supervisor does not start automatically. At 5 minutes past midnight, cron starts the downloader using supervisorctl. Then at 5 minutes to 6AM, it stops it.

If an exception is thrown during the download process, the supervisor program restarts. There is a retry with backoff built into the downloader, so you could lose connectivity to the server for up to 2 minutes and the download will continue.

If the downloader program continues to completion, the program stays stopped until the next day.

If the downloader fails partway through downloading a file, it will resume from where it left off the next time it is asked to download that file.

The chunk size for HTTP traffic is set to 256KB by default, YMMV. You can change the default in the files_download command.

Downloaded files are only deleted from the server if they are the correct expected size and they pass CRC32 verification. A log warning is written for files that fail verification. You must manually remove the corrupted file, the command won’t delete it for you.