This is the git project for the Rainwave website at http://rainwave.cc

== Required Modules and Executables

Required on all systems:
- tornado (webserver, minimum version 2.3)
- sqlite3 (database)
- psycopg 2.x (database)
- mutagen (ID3 tag reader)
- nose (test library)
- PIL (album art) [Debian: python-imaging, Gentoo: dev-python/imaging, pip: pil]
- psutil (nice and ionice)
- pyScss (CSS/SASS compiling)
- jsmin

Required on POSIX:
- pyinotify (filesystem monitoring)
- pylibmc (preferred, C wrapper) or python-memcached (pure Python)

Required on Windows:
- python-memcached

To let Rainwave automatically mp3gain your collection, you will need to enable it
in the configs and also have the "mp3gain" executable in your path.

== Git

Recommended .git/hooks/pre-commit:
	#!/bin/bash
	python runtests.py --api
	exit $?

To see the TODO list, just grep the code:
	grep -r TODO
	
== SQLite Support for the Test Suite

Rainwave supports SQLite for testing, and only Postgres in production environments.
Important data (notably sequences/unique IDs) are not held across program restarts
with SQLite.

== Running sqlite tests

1. Copy rainwave_test.conf to [your username].conf
2. Modify the config for your OS (assumes Linux by default)
3. runtests.py

== Initial setup for Postgres testing environment

1. Install Python, Postgres, memcached, and Python modules
2. Copy rainwave_test.conf to [your username].conf
3. Modify config to fit your environment and OS
4. Modify the config to point at your music collection (MP3 only, sorry)
5. db_init.py --config etc/[username].conf
6. rw_scanner.py --full --config /etc/[username].conf
7. runtests.py