gnippy 0.3.0

Python library for GNIP.

gnippy provides an easy way to access the Power Track stream provided by GNIP. You can also use gnippy to programatically add rules to your Power Track stream.

Installation:

pip install gnippy

Quickstart:

Create a .gnippy file and place it in your home directory. It should contain the following:

[Credentials]
username = [e-mail]
password = mypassword

[PowerTrack]
url = https://my.gnip.powertrack/url.json

Fire up the client:

#!/usr/bin/env python
import time
from gnippy import PowerTrackClient

# Define a callback
def callback(activity):
    print activity

# Create the client
client = PowerTrackClient(callback)
client.connect()

# Wait for 2 minutes and then disconnect
time.sleep(120)
client.disconnect()

If you don’t want to create a config file or you want it put it in another location:

client = PowerTrackClient(callback, url = "http://my.gnip.powertrack/url.json", auth = ('MyUserName', 'MyPassword'))
# OR
client = PowerTrackClient(callback, config_file_path="/etc/gnippy")

If you want to add rules to your PowerTrack:

from gnippy import rules
from gnippy.errors import RuleAddFailedException

# Add a
try:
    rules.add_rule('(Hello OR World OR "this is a test") AND lang:en', tag="MyRule") # The tag is optional
except RuleAddFailedException:
    pass # uh oh

# OR ... add multiple rules at once
rule_list = []
rule_list.append(rules.build_rule("Hello World", tag="asdf"))
rule_list.append(rules.build_rule("Rule Without a Tag"))
try:
    rules.add_rules(rule_list)
except RuleAddFailedException:
    pass # uh oh

Source available on GitHub: http://github.com/abh1nav/gnippy/