blob: dd951a8e7a7718ee3a1cd7d7240a951d361696d1 [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
32First run three-legged-dance.py to get OAuth
Tom Miller3a49e4c2010-09-28 15:16:25 -070033tokens for Buzz, which will be stored in
34buzz.dat in the working directory.
Joe Gregorio48d361f2010-08-18 13:19:21 -040035
Tom Millerc378c6d2010-10-11 12:00:36 -070036 $ python samples/buzz/three_legged_dance.py
Joe Gregorio48d361f2010-08-18 13:19:21 -040037
Tom Miller3a49e4c2010-09-28 15:16:25 -070038Then run buzz.py, which will use the apiclient
Joe Gregorio48d361f2010-08-18 13:19:21 -040039library to retrieve the title of the most
Tom Miller3a49e4c2010-09-28 15:16:25 -070040recent entry in Buzz and post a test message.
Joe Gregorio48d361f2010-08-18 13:19:21 -040041
Tom Millerc378c6d2010-10-11 12:00:36 -070042 $ python samples/buzz/buzz.py
Joe Gregorio48d361f2010-08-18 13:19:21 -040043
Tom Miller7c95d812010-10-11 11:50:52 -070044After following the install directions (using setup.py or setpath.sh) you
45should be able to cd to samples/cmdline and run the code from there.
46
Joe Gregorio48d361f2010-08-18 13:19:21 -040047
Tom Miller3a49e4c2010-09-28 15:16:25 -070048Third Party Libraries
Joe Gregorio48d361f2010-08-18 13:19:21 -040049====================
50
51http://code.google.com/p/httplib2
52http://code.google.com/p/uri-templates
53http://github.com/simplegeo/python-oauth2