Kral

http://github.com/Tawlk/kral

About

kral (pronounced: "crawl") is a python library intended to be a flexible solution for retreiving live streaming data from a variety of social network apis on given keyword(s), and yeilding the retreived data in a unified format.

Current Features

• Ability to harvest user information, and posts from Twitter, Facebook, Reddit, and Youtube (more to be added)
• Ability to expand all short-urls into full real URLs.
• Ability to track number of mentions of a given URL across multiple networks.
• Modular design. Easily add or disable plugins for different social networks.

Requirements

• python2.7
• pip
• virtualenv (recommended)

Usage / Installation

1. Install kral

   pip install -e git+https://github.com/Tawlk/kral/#egg=kral

2. Configuration

   After installation simply run the kral cli command which will copy a configuration file to: ~/.kral/config.py This file is a basic key-value mapping of the configuration options available. You will want to set your credentials and other service specific settings here.

   Note: The user configuration settings need to be set in order for kral streaming to work from the CLI; however you may also set the configuration options at runtime within your application by doing: from kral import config and setting the values according to the config.py template. (i.e config.TWITTER = {'user': 'cute', 'password': 'kitty'})

3. Collect data

   From here you can start using the kral.stream() generator to collect data within your appliction.

   Example that outputs the latest social data on "android" and "bitcoin" across all available networks.

   import kral
   
   for item in kral.stream(['android','bitcoin']):
       print "%s | %s" % (item.service,item.text)

   Example that outputs the latest social data on "obama" using only twitter.

   import kral
   
   for item in kral.stream('obama','twitter'):
       print "%s | %s" % (item.service,item.text)

   You can also collect data via the CLI interface.

   kral stream  --services="twitter,facebook" --queries="android"

   For more information on the CLI interface run:

   kral --help

Notes

Many more features coming soon as this project is under active development.

This is by no means production-ready code. Do not actually use it in production unless you wish to be eaten by a grue.

Questions/Comments? Please check us out on IRC via irc://udderweb.com/#uw