Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 2.36 KB

rtrss-README.md

File metadata and controls

65 lines (39 loc) · 2.36 KB

rtrss

Description

TV episode RSS feed processor.

This is personal homegrown solution to processing subscriptions of RSS feeds of TV shows available on BitTorrent. It's probably not good enough for you, but it works for me.

If you want to help improve it: Great!

If you want me to help you use it: You're better off finding something else.

Usage

  • Configure the script. (see Configuration)

  • Run the script:

    ./rtrss.py

  • Shedule the script to run periodically with cron or launchd.

Configuration

Set your configuration in the rtrss script.

  • CONFIGFILE : The path to the rtrss config file describing your current subscriptions. (see Config File Format)
  • TORRENT_DIRECTORY : The path to the output directory for where .torrent file should be saved.
  • LOGFILE : The path to the log file. This file is rotated.
  • LOGLEVEL : A log level defined in the logging module.

Config File Format

Basic INI-style format which is parsed by the ConfigParser module. This file is updated after downloading .torrent files to track the most recently downloaded episodes.

Some components of the format are vestigial, and were required in previous versions, but are not necessary anymore.

  • Each show that you subscribe to is defined in it's own section, identified by the heading in [brackets].
  • name : The base name of the show, used in logging and .torrent file renaming. (vestigial)
  • keywords : Space delimited (required) keywords to search for in the RSS feed entry title.
  • season : The season number of the last downloaded episode. If a feed contains items matching all keywords, and the season is newer than the current value the torrent will be downloaded.
  • episode : The number of the last downloaded episode. If a feed contains items matching all keywords, and the season is equal to the current season value, and the episode is newer than the current value the torrent will be downloaded.
  • url : The RSS feed URL.

Example

[Alice In Wonderland]
episode = 0
name = alice.in.wonderland
season = 0
keywords = Alice Adventures Wonderland
url = http://example.com/rss.php

Known Issues

  • rtrss is designed only to support the "the.show.title.s##e##.misc.gibberish" format so shows with no seasons like a miniseries are not supported..

License

MIT - See LICENSE.txt

Contact

Brian Partridge - @brianpartridge on Twitter and alpha.app.net