@@ -18,11 +18,11 @@ Simply run the setup.py script provided. % sudo python setup.py install == Quick Start == -Gnip has a test publisher "gnipherald": -https://api-v21.gnip.com/gnip/publishers/gnipherald/notification +Gnip has a test publisher "gnip-sample": +https://api-v21.gnip.com/gnip/publishers/gnip-sample/notification The following example retrieves notification data from the current bucket for -"gnipherald." Please note that the current bucket is not static and +"gnip-sample." Please note that the current bucket is not static and therefore will contain a variable amount of data, but you'll get quick feedback to know if you can connect and access the public notification data. @@ -32,7 +32,7 @@ to "my". import gnip gnip = gnip.Gnip("<your account email>","<your account password>") - response = gnip.get_publisher_notifications("gnip", "gnipherald") + response = gnip.get_publisher_notifications("gnip", "gnip-sample") print response.result You should see an Activities object. @@ -56,7 +56,7 @@ gnip.test.publisher=your-test-publisher Note, for the tests to pass, you must reference a Gnip test publisher that exists and that you own and thus can be used for publishing activities -from a unit test. The "gnipherald" does not work for the tests. +from a unit test. The "gnip-sample" does not work for the tests. For more information about creating a Gnip Publisher, see: @@ -85,31 +85,31 @@ As a consumer one thing you might be interested in immediately is grabbing data from a publisher. To do this you must create a connection to Gnip using your username and password. Once the connection is established you can get the publisher and request the stream. These examples uses the publisher -"gnipherald". +"gnip-sample". *** Notification data stream request *** import gnip gnip = gnip.Gnip("<your account email>","<your account password>") - response = gnip.get_publisher_notifications("gnip", "gnipherald") + response = gnip.get_publisher_notifications("gnip", "gnip-sample") print response.code You should see '200'. You can also view the current notifications bucket via web on the Gnip site: - https://api-v21.gnip.com/gnip/publishers/gnipherald/notification/current.xml + https://api-v21.gnip.com/gnip/publishers/gnip-sample/notification/current.xml *** Notification data stream request with optional date param *** import gnip gnip = gnip.Gnip("<your account email>","<your account password>") - response = gnip.get_publisher_notifications("gnip", "gnipherald", datetime.datetime.utcnow() - datetime.timedelta(minutes=1)) + response = gnip.get_publisher_notifications("gnip", "gnip-sample", datetime.datetime.utcnow() - datetime.timedelta(minutes=1)) print response.code You should see '200'. You can see the running list of notification buckets on the Gnip site: - https://api-v21.gnip.com/gnip/publishers/gnipherald/notification/ + https://api-v21.gnip.com/gnip/publishers/gnip-sample/notification/ === Example 2: Filter notifications or activities by a set of users === @@ -122,7 +122,7 @@ delicious, etc.). You can only retrieve activity data (full data) from publishers that you don't own by creating a filter. -The test actor for "gnipherald" is "jvaleski". To test your filter, be sure +The test actor for "gnip-sample" is "jvaleski". To test your filter, be sure "jvaleski" appears in your rule set. The following examples illustrate creating filters for both notification and activity @@ -134,24 +134,24 @@ Note that the full data (second parameter) of the filter object must be set to false. This example does not include a POST URL, meaning you'll have to poll Gnip for the results when you need them. The following snippet creates (and retrieves) a notification filter called "myNotificationFilter" on the publisher -gnipherald. +gnip-sample. import gnip from gnip import * gnip = gnip.Gnip("<your account email>","<your account password>") my_filter = filter.Filter(name="myNotificationFilter", full_data=False, post_url=None, rules=[Rule("actor", "you"), Rule("actor", "mary"), Rule("actor", "jvaleski")]) - gnip.create_filter("gnip", "gnipherald", my_filter) - response = gnip.get_filter_notifications("gnip", "gnipherald", "myNotificationFilter") + gnip.create_filter("gnip", "gnip-sample", my_filter) + response = gnip.get_filter_notifications("gnip", "gnip-sample", "myNotificationFilter") print response.code You should see '200' You can also see your filters list for each publisher by going to the Gnip site: - https://api-v21.gnip.com/gnip/publishers/gnipherald/filters + https://api-v21.gnip.com/gnip/publishers/gnip-sample/filters You can view notification buckets on the Gnip site by going to: - https://api-v21.gnip.com/gnip/publishers/gnipherald/filters/myNotificationFilter/notification + https://api-v21.gnip.com/gnip/publishers/gnip-sample/filters/myNotificationFilter/notification *** Activity Filter with POST URL *** @@ -159,7 +159,7 @@ Note that the full data (second parameter) of the filter object must be set to true to view activity data. This example includes the optional POST URL, meaning Gnip will POST via an HTTP HEAD request to this URL. The following snippet creates (and gets) a notification filter called "myActivityFilter" on -the publisher gnipherald. +the publisher gnip-sample. If you want notifications to be sent to a script on your server for processing, you must ensure that the postURL parameter you set responds successfully to an @@ -171,8 +171,8 @@ URL is invalid). gnip = gnip.Gnip("<your account email>","<your account password>") my_filter = filter.Filter(name="myActivityFilter", full_data=True, post_url=None, rules=[Rule("actor", "you"), Rule("actor", "mary"), Rule("actor", "jvaleski")]) - gnip.create_filter("gnip", "gnipherald", my_filter) - response = gnip.get_filter_activities("gnip", "gnipherald", "myActivityFilter") + gnip.create_filter("gnip", "gnip-sample", my_filter) + response = gnip.get_filter_activities("gnip", "gnip-sample", "myActivityFilter") print response.code You should see '200'. @@ -180,11 +180,11 @@ You should see '200'. Your actors list should be (not necessarily in this order): you, mary, jvaleski You can also see your filters list for each publisher by going to the Gnip site: - https://api-v21.gnip.com/gnip/publishers/gnipherald/filters + https://api-v21.gnip.com/gnip/publishers/gnip-sample/filters You can view notification buckets on the Gnip site by going to: - https://api-v21.gnip.com/gnip/publishers/gnipherald/filters/myActivityFilter/activity + https://api-v21.gnip.com/gnip/publishers/gnip-sample/filters/myActivityFilter/activity === Example 3: Add rules to an existing filter === @@ -193,10 +193,10 @@ two new rules to the filter we created above, myNotificationFilter: import gnip gnip = gnip.Gnip("<your account email>","<your account password>") - gnip.add_rules_to_filter("gnip", "gnipherald", "myNotificationFilter", + gnip.add_rules_to_filter("gnip", "gnip-sample", "myNotificationFilter", rules=[Rule("actor", "sam"), Rule("actor", "judy")]) - response = gnip.get_filter("gnip", "gnipherald", "myNotificationFilter") + response = gnip.get_filter("gnip", "gnip-sample", "myNotificationFilter") print response.code You should see '200'. @@ -208,7 +208,7 @@ that was created above: import gnip gnip = gnip.Gnip("<your account email>","<your account password>") - response = gnip.delete_filter("gnip", "gnipherald", "myNotificationFilter"); + response = gnip.delete_filter("gnip", "gnip-sample", "myNotificationFilter"); print response.code You should see '200'. @@ -222,11 +222,11 @@ activities for a publisher that you do not own. import gnip gnip = gnip.Gnip("<your account email>","<your account password>") - response = gnip.get_filter_notifications("gnip", "gnipherald", "myActivityFilter") + response = gnip.get_filter_notifications("gnip", "gnip-sample", "myActivityFilter") print response.code You can also view the current activity bucket via web on the Gnip site: - https://api-v21.gnip.com/gnip/publishers/gnipherald/filters/myActivityFilter/activity/current.xml + https://api-v21.gnip.com/gnip/publishers/gnip-sample/filters/myActivityFilter/activity/current.xml *** Activity Data Stream Request with Date Param *** @@ -236,12 +236,12 @@ activities for a publisher that you do not own. import gnip import datetime gnip = gnip.Gnip("<your account email>","<your account password>") - response = gnip.get_filter_notifications("gnip", "gnipherald", "myActivityFilter", datetime.datetime.utcnow() - datetime.timedelta(minutes=1)) + response = gnip.get_filter_notifications("gnip", "gnip-sample", "myActivityFilter", datetime.datetime.utcnow() - datetime.timedelta(minutes=1)) print response.code You can see the running list of activity buckets on the Gnip site: - https://api-v21.gnip.com/gnip/publishers/gnipherald/filters/myActivityFilter/activity/ + https://api-v21.gnip.com/gnip/publishers/gnip-sample/filters/myActivityFilter/activity/ ==== Publisher Actions ==== @@ -327,6 +327,7 @@ Contributions to this library are welcome. Source :: git://github.com/gnip/gnip-python.git Community Site :: http://groups.google.com/group/gnip-community Mailing List :: gnip-community@googlegroups.com +Twitter Status :: @gnipsupport To get started create a clone of the main repository, <git://github.com/gnip/gnip-python.git>, and start improving it. Feel README 6843c2d7143e97bb99f42c9222e493108b48a5f3 Ingrid Alongi ingrid@gnipcentral.com http://github.com/gnip/gnip-python/commit/3c9f829540bfb2fc58063497a99a24de6452e210 3c9f829540bfb2fc58063497a99a24de6452e210 2009-02-10T10:33:10-08:00 2009-02-10T10:33:10-08:00 Updated test publisher URL to gnip-sample. 213f954e3f1b120dc11194315ca7596689f3d7db Ingrid Alongi ingrid@gnipcentral.com