Tranny Documentation - Read the Docs

Tranny Documentation

Release 0.1.1 Leigh MacDonald

May 04, 2017

Contents

1 Tranny Setup Info

3

1.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.2 Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.3 Unix System Prep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.4 Windows System Prep . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.5 Common configuration setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.6 Auto Start On Boot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.7 Linux (supervisord) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

1.8 Windows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

2 Management Scripts

7

2.1 manage.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.2 tranny-add.py . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

3 Torrent Client Configuration

9

3.1 rTorrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.2 Deluge (JSON-RPC) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.3 UTorrent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

3.4 Transmission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

4 Metadata Services

11

4.1 IMDB (HTTP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.2 IMDB (SQL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

4.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

5 Providers

13

5.1 BTN API Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5.2 RSS Feed Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

5.3 PTP Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

5.4 HDBits Provider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

6 External Services

15

6.1 IMDB . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

6.1.1 SQL Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

7 Notification Services

17

7.1 IRC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

i

7.2 Email . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 7.3 SMS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 7.4 Growl . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

8 Developer Guide

19

8.1 Python Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

8.2 Web Development Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

8.2.1 Problems . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

8.3 Building Release Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

8.4 Testing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

9 Deluge API Methods

23

9.1 Pre Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

9.2 Post Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

10 Tranny

27

10.1 tranny package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

10.1.1 Subpackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

10.1.2 Submodules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.3 tranny.app module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.4 tranny.configuration module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.5 tranny.constants module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.6 tranny.datastore module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.7 tranny.events module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.8 tranny.exceptions module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.9 tranny.extensions module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.10 tranny.forms module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.11 tranny.manager module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.12 tranny.models module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.13 module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.14 tranny.notification module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.15 tranny.parser module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.16 tranny.plugin module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.17 tranny.release module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.18 tranny.stats module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.19 tranny.torrent module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.20 tranny.ui module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.21 tranny.util module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.22 tranny.watch module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.23 Module contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

10.1.24 Client API Info . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

11 Indices and tables

31

ii

Contents:

Tranny Documentation, Release 0.1.1

Contents

1

Tranny Documentation, Release 0.1.1

2

Contents

1 CHAPTER

Tranny Setup Info

This documents outlines setting up the tranny process to start on boot as well as configuring different services to fetch from.

Requirements

One of the following torrent clients configured for remote API access ? deluge This is currently the only client that will function with webui capabilities ? rTorrent (scgi) (Partial support) ? Transmission (jsonrpc) (Not recommended yet) ? uTorrent 3.x (webui) (Not recommended yet)

Along with a python distribution and required python libraries ? Python 2.7 - Python 3 support will come with python 3 gevent support ? watchdog ? transmissionrpc ? requests ? feedparser ? jsonrpclib

Setup

Its recommended to use a virtualenv to install if possible. Ill outline how to install using it below. Checkout the sources:

3

Tranny Documentation, Release 0.1.1

$ git clone git://leighmacdonald/tranny.git $ cd tranny

Unix System Prep

If you are using a Unix like system (linux,osx,bsd,solaris) you should use these steps, for windows users please see below. Install virtualenv with your package manager if its not already installed. Install the dependencies using pip and the dependencies which are listed under the requirements.txt file.: $ virtualenv virtenv # Create virtualenv for tranny $ source virtenv/bin/activate # Activate new interpreter on your path $ pip install -r requirements.txt # Install required dependencies

Windows System Prep

Below are links to installers for some of the libraries required. Make sure you choose the correct one for your python version. Sticking with CPython 2.7 would be considered best for now.

? distribute ? pip ? psutil The following libraries are installed using pip as they are not available from the site above. You can install them like so: pip install package_name ? six ? pathtools A precompiled installer for pyimdb 32bit python 2.7. - imdbpy

Common configuration setup

Create your own config based on the example provided and rename it to tranny.ini. We will also put this in the user's config directory under ~/.config/tranny

$ mkdir ~/.config/tranny $ cp tranny_dist.ini ~/.config/tranny/tranny.ini From this point you will want to take a moment and setup your configuration file. You should enable all the services you want to now. For more info check out the following setup doc pages:

? External Services Service configuration [imdb, trakt, tmdb, etc] ? Notification Services Using the editor of your choice, configure any options desired in your new configuration.

$ vim tranny.ini

4

Chapter 1. Tranny Setup Info

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download