Metadata-Version: 1.1
Name: yanktv
Version: 0.2
Summary: Yank torrents for the latest episodes of your tv shows.
Home-page: https://github.com/lmas/yanktv
Author: A. Svensson
Author-email: lmasvensson@gmail.com
License: MIT
Description: ======
        yanktv
        ======
        This simple tool will try to scrape a torrent site for new episodes to your
        favorite tv shows and download the torrents for you.
        
        
        Installation
        ============
        Simply install it with pip: ::
        
            $ pip install yanktv
        
        
        Usage
        =====
        (**Optional**) Initiate the database and fill it with old episodes you might
        already have watched, thus avoiding having to download old torrents: ::
        
            $ yanktv --init
        
        Whenever you want to check for new episodes and download the associated
        torrents, simply run: ::
        
            $ yanktv
        
        If you have set up a virtualenv and installed yanktv inside it, you can
        always reach yanktv by calling: ::
        
            $ /PATH/TO/VENV/bin/yanktv
        
        
        Command line
        ============
        Optional arguments: ::
        
          -h, --help            show this help message and exit
          -v, --version         show program's version number and exit
          -c PATH, --config PATH
                                path to config file (defaults to XDG_CONFIG_HOME:
                                /home/USER/.config/.yanktvrc)
          -i, --init            initiate the database and fill it with episode data,
                                but does NOT download torrents
        
        
        Configuration
        =============
        The config file for yanktv is a regular python module, that can be placed
        anywhere in your system. The default location is **~/.yanktvrc**.
        
        
        TV_SHOWS
        --------
        (**Required**) A python list of the tv shows you want to yank. Example: ::
        
            TV_SHOWS = ('south park')
        
        
        NEW_ITEM
        --------
        (**Required**) A python function, which yanktv calls whenever it finds a new
        episode for a tv show. Required function arguments are **episode** name and
        **url** to the torrent. Example: ::
        
            def NEW_ITEM(episode, url):
                print('New episode found, called:', episode)
                print('Torrent URL:', url)
        
        
        BASE_URL
        --------
        A python string, telling yanktv from where it should scrape for new
        torrents. If you insert **{SEARCH}** in the URL, it will be replaced with
        the name of the current tv show that's being scraped. Example: ::
        
            BASE_URL = 'https://somewhere.com/tvshow/{SEARCH}'
        
        
        DATABASE_FILE
        -------------
        A python string, it should contain a full path to where yanktv will
        store it's database. Default is **~/.yanktv.db**. Example: ::
        
            DATABASE_FILE = '/var/cache/yanktv.db'
        
        
        DEBUG
        -----
        A python boolean, if it's set to **True**, yanktv will show some extra
        information when it's running. Example: ::
        
            DEBUG = True
        
        
        License
        =======
        MIT License, see LICENSE.txt
        
Keywords: tv show torrent episodes
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Topic :: Communications :: File Sharing
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Utilities
