File	Date	Author	Commit
config	2012-02-26	Andreas Hell	[8970bc] Exchanged tkinter with wxpython.
database	2012-02-27	Andreas Hell	[4096eb] wxGlade used to start some frames.
docs	2012-02-26	Andreas Hell	[8970bc] Exchanged tkinter with wxpython.
files	2012-02-24	Andreas Hell	[23288a] Schulwerkzeug set under version control.
managers	2012-02-27	Andreas Hell	[4096eb] wxGlade used to start some frames.
models	2012-02-27	Andreas Hell	[4096eb] wxGlade used to start some frames.
scripts	2012-02-26	Andreas Hell	[76c708] Added scripts to create database structure alon...
utilities	2012-02-27	Andreas Hell	[5b8992] Implemented an ErrorMessage dialog.
views	2012-02-27	Andreas Hell	[5b8992] Implemented an ErrorMessage dialog.
.hgignore	2012-02-25	Andreas Hell	[45784b] Switched underlying database to mysql using inn...
README.txt	2012-02-26	Andreas Hell	[7f37f1] Rewrote README.txt
start.py	2012-02-27	Andreas Hell	[4096eb] wxGlade used to start some frames.

Read Me

Important. Please notice:

When you clone this project or simply download the files from
sourceforge.net you cannot instantly run the program. It would break.
First of all you have to set up and configure a mysql database that
matches the program's requirements.

If you want to test the program you are required to do a few tasks in advance.

a) 	I assume you have access to or can set up a mysql server. 

b)	The underlying database system of Schulwerkzeug is a mysql database using utf8 as default 
	character set. Don't worry about setting up the database. There is a script 
	for it. The only thing you have to do yourself is to create an appropriate 
	user for that database. Provided your database user is called 'schulwerkzeug'
	you can do so like this:

	GRANT ALL PRIVILEGES ON schulwerkzeug.* TO schulwerkzeug@'%' IDENTIFIED BY '<choose_a_password>';

	The script you need to run at a mysql prompt can be found at [project folder]/scripts/mysql.
	It's called create_database_schulwerkzeug.sql. 
	
	In a terminal cd to the [project_folder]/scripts/mysql/ folder and connect to your mysql server.
	Then at the mysql prompt do:
	
	mysql> source create_database_schulwerkzeug.sql
	
	It should run fine and you have got your database with ut8 support.
	
c)	Once you have your mysql server up and running, hosting a properly 
	configurated database and an apropriate database user, you are still in need
	corresponding tables. Here is how to achieve this:
		
	Again, in a terminal cd to the [project_folder]/scripts/mysql/ folder and connect to your mysql server.
	Then at the mysql prompt do:
	
	mysql> source create_tables_for_database_schulwerkzeug.sql
	
	Be aware, however, that every time you run the commands inside the scripts
	these will totally rebuild your database / table structures and thus remove any data that might already 
	be stored in your database. So be careful!
	
	The scripts also provide for some dummy data. Once you are finished your 
	program should work fine.
	

d)  Lastly, for the program to run you need to provide your database credentials inside a file called credentials.py 
	which itself residences inside the database folder. 
	
	For your convenience, there is a dummy file in the 	database folder which you can copy or rename to match 
	credentials.py. Inside, of course, are required to fill in the proper values.


Good luck and greetings,
h3lium