***********************************************************
About
***********************************************************

SmartTypes is an open lab for online social network analysis (initially twitter).

Our goal is to provide an accurate, searchable, map of your online universe!

***********************************************************
Get going
***********************************************************

Following is a pseudo shell script to get going w/ smarttypes. It assumes you have virtualenv and virtualenvwrapper installed, and your virtualenv directory is ~/.virtualenvs. It also assumes you have postgresql installed.  It also assumes you have a twitter account, and you are following people:

#create a smarttypes virtualenv
$ mkvirtualenv --no-site-packages smarttypes

#get the code from github
$ cd ~/

#everyone should have a projects dir
$ mkdir projects

$ cd ~/projects
$ git clone git@github.com:smarttypes/smarttypes.git smarttypes

#add smarttypes to your python path
#your home dir probably isn't timmyt
#also double check your python version, mine is 2.7 
$ echo '/home/timmyt/projects/smarttypes' >> smarttypes.pth; mv smarttypes.pth ~/.virtualenvs/smarttypes/lib/python2.7/site-packages/.

#install dependencies (may not need these exact versions) 
Genshi==0.6
WebOb==1.2b3
networkx==1.6
numpy==1.6.1
psycopg2==2.4.4
python-dateutil==2.0
scikit-learn==0.10
scipy==0.10.0
simplejson==2.3.2
tweepy==1.8

#add config params
$ cd ~/projects/smarttypes/smarttypes/
$ cp config.py.blank config.py

#now fill in config.py, don't worry about sensitive info it's in .gitignore

#to get CONSUMER_KEY and CONSUMER_SECRET you need to register your 
#twitter app @ https://dev.twitter.com/apps/new

#now, assuming postgres is installed, create the data schema
$ python scripts/create_db_schema.py

#start a dev server
$ python start_dev_server.py

#now pull up http://localhost:9999/ in your browser

#click the 'Sign in w/ twitter' link, and sign up for your app

#that should be enough to get you going, for more info please contact us @ hello@smarttypes.org

***********************************************************
License
***********************************************************

Copyright (c) 2012 SmartTypes, released under the MIT license

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.