Skip to content

thongdong7/gnippy

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

64 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gnippy: Python library for GNIP

image

image

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.

Install

pip install gnippy

Quickstart

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

[Credentials]
username = user@company.com
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()

Configuration

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

client = PowerTrackClient(callback, config_file_path="/etc/gnippy")
# OR ... provide the url and authentication credentials to override any config files
client = PowerTrackClient(callback, url="http://my.gnip.powertrack/url.json", auth=("uname", "pwd"))

You can also configure gnippy using environment variables:

GNIPPY_URL
GNIPPY_AUTH_USERNAME
GNIPPY_AUTH_PASSWORD

Adding PowerTrack Rules

If you want to add rules to your PowerTrack:

from gnippy import rules
from gnippy.errors import RuleAddFailedException

# Synchronously add rules
try:
    rules.add_rule('(Hello OR World OR "this is a test") lang:en', tag="MyRule")
    rules.add_rule('Rule without a tag')
except RuleAddFailedException:
    pass

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

# OR ... manually pass in params - overrides any config files
rules.add_rule("My Rule String", tag="mytag", url="http://my.gnip.powertrack/url.json", \
               auth=("uname", "pwd"))

Listing Active PowerTrack Rules

from gnippy import rules
from gnippy.errors import RulesGetFailedException

try:
    rules_list = rules.get_rules()
    # rules_list is in the format:
    # [
    #    { "value": "(Hello OR World) AND lang:en" },
    #    { "value": "Hello", "tag": "mytag" }
    # ]
except RulesGetFailedException:
    pass

Deleting PowerTrack Rules

from gnippy import rules
from gnippy.errors import RuleDeleteFailedException, RulesGetFailedException

try:
    rules_list = rules.get_rules()
    # Suppose I want to delete the first rule in the list
    rules.delete_rule(rules_list[0])
    # OR ... I want to delete ALL rules
    rules.delete_rules(rules_list)

except RuleDeleteFailedException, RulesGetFailedException:
    pass

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

About

Python library for GNIP

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%