blob: 9a7b28c2f2b263115be5ec9a580dfacd88a530ce [file] [log] [blame]
Joe Gregorio48d361f2010-08-18 13:19:21 -04001This is a prototype implementation of a client
2for discovery based APIs.
3
4Installation
5============
6
Tom Miller7c95d812010-10-11 11:50:52 -07007To install, simply say
Joe Gregorio48d361f2010-08-18 13:19:21 -04008
Tom Miller7c95d812010-10-11 11:50:52 -07009 $ python setup.py install --record=files.txt
10
11to install the files and record what files are installed in files.txt.
12
13If you want to do a "mock install" and simply extend your PYTHONPATH
14for the current shell to include this folder and the packages in it, do
15
16 $ source setpath.sh
17
18from the root of the project directory.
19
20
21Uninstall
22=========
23
24 $ cat files.txt | xargs rm -rf
25
26You may need root privileges to do this.
27
Joe Gregorio48d361f2010-08-18 13:19:21 -040028
29Running
30=======
31
Joe Gregorioe9e236f2011-03-21 22:23:14 -040032Run buzz.py, which will use the apiclient
Joe Gregorio48d361f2010-08-18 13:19:21 -040033library to retrieve the title of the most
Tom Miller3a49e4c2010-09-28 15:16:25 -070034recent entry in Buzz and post a test message.
Joe Gregorioe9e236f2011-03-21 22:23:14 -040035The first time you run it you will be prompted
36to authorize the application to access your
37Buzz information.
Joe Gregorio48d361f2010-08-18 13:19:21 -040038
Tom Millerc378c6d2010-10-11 12:00:36 -070039 $ python samples/buzz/buzz.py
Joe Gregorio48d361f2010-08-18 13:19:21 -040040
Tom Miller7c95d812010-10-11 11:50:52 -070041After following the install directions (using setup.py or setpath.sh) you
Joe Gregorioe9e236f2011-03-21 22:23:14 -040042should be able to cd to samples/buzz and run the code from there.
Tom Miller7c95d812010-10-11 11:50:52 -070043
Joe Gregorio48d361f2010-08-18 13:19:21 -040044
Tom Miller3a49e4c2010-09-28 15:16:25 -070045Third Party Libraries
Joe Gregorioe9e236f2011-03-21 22:23:14 -040046=====================
47
Joe Gregorio20a5aa92011-04-01 17:44:25 -040048These libraries will be installed when you install the client library:
Joe Gregorio48d361f2010-08-18 13:19:21 -040049
50http://code.google.com/p/httplib2
51http://code.google.com/p/uri-templates
52http://github.com/simplegeo/python-oauth2