stov/README

=== ABOUT ===

stov is a program which allows you to subscribe to channels, playlists and search results on youtube. (More platforms may be implemented later) You don't need a youtube account for the program to work since it uses read-only access to the youtube API. You can for example run it as a cron job to automatically download your favourite videos.

=== USAGE ===

see ./stov.py --help

=== DEPENDENCIES ===

stov depends on the following software to be installed:

	* Python 2.6 or higher (it might also work with earlier versions, but hasn't been tested, python 3 is not supported yet)
	* youtube-dl (get it from http://rg3.github.com/youtube-dl/ if you don't have it yet

=== COPYING ===

see LICENSE

=== CONFIGURATION ===
By default, the configuration is defined in ~/stov/stov.config. A default config file is created for you when you run the program for the first time. The following parameters are currently available which you can alter manually:

MAILTO: Recipient address used for notitifications
MAILFROM: Sender address used for notifications
MAILHOST: Host name or ip address of the mail server which is used to send notifications
AUTH_NEEDED: Define if the smtp server need authentication (yes or no)
USER_NAME: User name to use for smtp authentication if defined
PASSWORD: Password to use for SMTP authentication
YOUTUBE-DL: Path to the youtube-dl binary if not found automatically
DOWNLOADDIR: Path the downloaded videos are saved into
DATABASE: File name to use for the database
SMTPPORT: Port used to connect to the mail server
MAXVIDEOS: Maximum number of videos to retrieve from the youtube API for each subscription,
	default 25, maximum 50, reduce this parameter for better parsing performance
NOTIFY: Define if you want to be notified via email about new episodes of your subscriptions,
	valid values: yes or no
DB_VERSION: Database version (Do not change!)
CONFIG_VERSION: Configuration version (Do not change!)
VIDEOCODEC: Video codec used for downloaded videos (valid values: h264, webm or flv)
MAXRESOLUTION: Maximum resolution to use for downloaded videos, please note
	that not all codecs and resolutions might be available so a lower resolution
	or other codec might be used in these cases
MAXFAILS: Number of times the download of a video may fail until it is marked as failed
	and won't be tried again

=== KNOWN ISSUES ===

Currently none, contact me if you find some.

=== INSTALLATION ===

You can just run the main file "stov.py" directly from this directory by calling
it from the shell or with the python interpreter ("./stov.py" or "python stov.py").
A simple install script is also provided which can be used to install stov to a
directory of your choice. Simply run "install.py" with the path as argument.