blob: c68d4410e058b7e52de047288361df8fdcb6a9d0 [file] [log] [blame]
Joe Gregorio48d361f2010-08-18 13:19:21 -04001This is a prototype implementation of a client
2for discovery based APIs.
3
Joe Gregorio8097e2a2011-05-17 11:11:34 -04004
Joe Gregorio48d361f2010-08-18 13:19:21 -04005Installation
6============
7
Tom Miller7c95d812010-10-11 11:50:52 -07008To install, simply say
Joe Gregorio48d361f2010-08-18 13:19:21 -04009
Joe Gregorio8097e2a2011-05-17 11:11:34 -040010 $ python setup.py install
Tom Miller7c95d812010-10-11 11:50:52 -070011
12If you want to do a "mock install" and simply extend your PYTHONPATH
13for the current shell to include this folder and the packages in it, do
14
15 $ source setpath.sh
16
17from the root of the project directory.
18
19
Joe Gregorio48d361f2010-08-18 13:19:21 -040020Running
21=======
22
Joe Gregorio8097e2a2011-05-17 11:11:34 -040023After following the install directions (using setup.py or setpath.sh) you
24should be able to cd to samples/buzz and run buzz.py from there, which will use
25the apiclient library to retrieve the title of the most recent entry in Buzz
26and post a test message. The first time you run it you will be prompted to
27authorize the application to access your Buzz information.
Joe Gregorio48d361f2010-08-18 13:19:21 -040028
Tom Millerc378c6d2010-10-11 12:00:36 -070029 $ python samples/buzz/buzz.py
Joe Gregorio48d361f2010-08-18 13:19:21 -040030
31
Tom Miller3a49e4c2010-09-28 15:16:25 -070032Third Party Libraries
Joe Gregorioe9e236f2011-03-21 22:23:14 -040033=====================
34
Joe Gregorio20a5aa92011-04-01 17:44:25 -040035These libraries will be installed when you install the client library:
Joe Gregorio48d361f2010-08-18 13:19:21 -040036
37http://code.google.com/p/httplib2
38http://code.google.com/p/uri-templates
Joe Gregorio8097e2a2011-05-17 11:11:34 -040039http://code.google.com/p/python-gflags
Joe Gregorio48d361f2010-08-18 13:19:21 -040040http://github.com/simplegeo/python-oauth2
Joe Gregorio8097e2a2011-05-17 11:11:34 -040041
42Depending on your version of Python, these libraries may also be installed:
43
44http://pypi.python.org/pypi/simplejson/
Joe Gregorio432f17e2011-05-22 23:18:00 -040045
46For developement you will also need:
47
48http://pythonpaste.org/webtest/