added example in readme

README.rst

@@ -8,6 +8,7 @@ EARLY ALPHA AT THE MOMENT
 
 API MIGHT CHANGE UNTIL V 1.0
 
+------------
 Installation
 ------------
 
@@ -25,16 +26,34 @@ or checkout from github: ::
     $ cd pyque
     $ python setup.py install
 
+-------
+Example
+-------
+
+Create a gziped MySQL dump of every database on localhost for user 'backupuser':
+
+	from pyque.db.mysql import db_list, db_dump
+	from pyque.utils import gzip
+
+	username = 'backupuser'
+	password = 'test'
+
+	for db in db_list(username = username, password=password):
+    dumpfilename = '/tmp/' + db + '.sql'
+    db_dump(dumpfilename, dbname=db, username=username, password=password)
+    gzip(dumpfilename)
+
+----------
 Contribute
-------------------
+----------
 
 contributions welcome
 
 pull-request please and/or create a issue on github
 
-
+-------
 LICENCE
-------------
+-------
 
 The MIT License (MIT)
 Copyright © 2013 Bernhard Mäser, http://bmaeser.io

mysql_dump_all.py

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+'''
+Creates a gziped dump of every MySQL database on localhost
+'''
+
+from pyque.db.mysql import db_list, db_dump
+from pyque.utils import gzip
+
+username = 'backupuser'
+password = 'test'
+
+for db in db_list(username = username, password=password):
+    dumpfilename = '/tmp/' + db + '.sql'
+    db_dump(dumpfilename, dbname=db, username=username, password=password)
+    gzip(dumpfilename)

pyque/db/mysql.py

@@ -56,6 +56,7 @@ def db_dump(filename, dbname, username=None, password=None, host=None,
     return infodict
 
 def _cursor(username=None, password=None, host=None, port=None):
+    "returns a connected cursor to the database-server."
 
     c_opts = {}
 
@@ -71,7 +72,7 @@ def _cursor(username=None, password=None, host=None, port=None):
 
 def db_list(username=None, password=None, host=None, port=None):
     "returns a list of all databases on this server"
-    
+
     cur = _cursor(username=username, password=password, host=host, port=port)
     cur.execute('SHOW DATABASES')
     rows = cur.fetchall()