Python library for GNIP.
Project description
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 gnippyQuickstart
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.jsonFire 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, 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"))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:
passDeleting 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:
passSource available on GitHub: http://github.com/abh1nav/gnippy/
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
gnippy-0.4.0.tar.gz
(7.0 kB
view details)
File details
Details for the file gnippy-0.4.0.tar.gz.
File metadata
- Download URL: gnippy-0.4.0.tar.gz
- Upload date:
- Size: 7.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2965ded8062a5d603fc61a282a7908a64f4e27f401eecf678b5721b292881db8 |
|
| MD5 | bdc04e6acb3d006ca399b63246238e65 |
|
| BLAKE2b-256 | e505091b76e867cc8b40e9e8742b706b4840042c65b15f45cd450da6d9c5d5ce |
