From 0d63faf44c8a2dd1315f81b0ee7260ffdd444beb Mon Sep 17 00:00:00 2001 From: DelRay Davis Date: Mon, 5 Mar 2012 00:12:04 -0800 Subject: [PATCH] adding in a little more documentation for the actual implementation file --- example.py | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/example.py b/example.py index a54101e..abd8eb9 100644 --- a/example.py +++ b/example.py @@ -1,8 +1,43 @@ +""" +Application id and applicaiton key +these are supplied to you by PeopleBrowsr + +All PeopleBrowsr API requests use consistent parameters in making their requests. + +Time Period: The time period parameters require that exactly 2 of the three possible +parameters be submitted. Possible choices are 'first', 'last' (both of which denote +dates in any one of various formats. See https://developer.peoplebrowsr.com/pbapi/), and count +which denotes how many time increments the request should span. This defaults to days. +Therefore a value of 30 will denote a time span of 30 days. + +source: Denotes the network from which the results should be pulled. blogs, facebook, twitter are all options +for this parameter. + +term: The term or terms that should serve as the key for the search. + +Optional Parameters: + period: defines the time span of the count parameter. This value is designated in seconds. period=86400 denotes one day. + limit: places a cap on the number of returned results + number: Specifies number of items in non-histogram queries. If the parameter &number=10, the query will only return 10 data points. + reverse: When set to reverse=true, this will reverse the order of the histograms, charts. +""" import PeopleBrowsr x = PeopleBrowsr("[APP ID]", "[APP KEY]") test = x.mentions(last = "yesterday", count = "30", source = "twitter", term = "pepsi") print test +""" +All Kred API requests use consistent parameters in making their requests. +For this library. + +Application id and applicaiton key +these are supplied to you by PeopleBrowsr + +source: Denotes the network from which the results should be pulled. blogs, facebook, twitter are all options +for this parameter. + +term: The term or terms that should serve as the key for the search. +""" import Kred x = Kred("[APP ID]", "[APP KEY]") test = x.Kred(source = "twitter", term = "pepsi")