add setuptools packaging, support for CSV output, and an API

MANIFEST.in

@@ -0,0 +1,4 @@
+include *.py
+include hmp/countries_all
+include LICENSE README.md
+exclude MANIFEST.in

README.md

@@ -30,7 +30,7 @@ using these proxies. If someone gets pwned, don't look at me.
 
 ## REQUIREMENTS
 
-All you need is Python 3, and the Python requests library.
+All you need is Python 2 or 3, and the Python requests library.
 
 ## USAGE
 
@@ -48,7 +48,8 @@ Don't forget to make the script executable with:
 To see a list of the options, just issue:
 
 	./hide_my_python.py -h
-	usage: hide_my_python [-h] -o DATABASE_FILE [-n NUMBER_OF_PROXIES]
+	usage: hide_my_python [-h] -o DATABASE_FILE [-f {csv,sqlite3}]
+	       		      	      		  [-n NUMBER_OF_PROXIES]
 						  [-ct COUNTRIES_FILE] [-p PORTS [PORTS ...]]
 						  [-pr {http,https,socks} [{http,https,socks} ...]] [-a]
 						  [-ka] [-s] [-c] [-v]
@@ -58,6 +59,7 @@ To see a list of the options, just issue:
 	optional arguments:
 	  -h, --help            show this help message and exit
 	  -o DATABASE_FILE      database file where the proxies will be saved
+	  -f {csv,sqlite3}      format of output file (default: sqlite3)
 	  -n NUMBER_OF_PROXIES  maximum number of proxies to retrieve (default: all)
 	  -ct COUNTRIES_FILE    file containing the countries where the proxies can be
 							based (default: countries_all)
@@ -87,7 +89,8 @@ To see a list of the options, just issue:
 
 ### Database file
 
-The proxies will be saved in this file. If the file doesn't exist, it will be
+The proxies will be saved in this file. If no file is specified, the proxies are
+written to the screen in CSV format. If the file doesn't exist, it will be
 created. If it exists, the proxies will be appended to it (the file won't be
 overwritten). The database contains only one table, named `proxies`, with the
 following structure:
@@ -101,6 +104,11 @@ following structure:
 * `speed`: the speed level of the proxy (type: `TEXT`)
 * `connection_time`: the connection time of the proxy (type: `TEXT`)
 
+### Database file format
+
+This option can be used to choose whether to save the proxies 
+in a sqlite3 file or a CSV file. Only CSV data may be written to the screen.
+
 ### Number of proxies
 
 If this argument is defined, the script will only return the first `n`
@@ -238,12 +246,20 @@ parsing.
 	[info] speed: ['Medium', 'High']
 	[info] retrieved 100/100 proxies
 
+### API
+
+Other Python programs can access HideMyPython's functionality via the
+`hmp.api.get_proxies()` function. Proxies are returned as a list of tuples, each
+of which contains the proxy ip, port, type, country, anonymity, and speed.
+
 ## COPYRIGHT
 
 HideMyPython! - A parser for the free proxy list on HideMyAss!
 
 Yannick Méheut [useless (at) utouch (dot) fr] - Copyright © 2013
 
+Lev Givon [lev (at) columbia (dot) edu] - Copyright © 2014
+
 This program is free software: you can redistribute it and/or modify it 
 under the terms of the GNU General Public License as published by the 
 Free Software Foundation, either version 3 of the License, or (at your