simpkins/tweetledee

Easy access to Twitter RSS and JSON data

Installs: 23

Dependents: 0

Stars: 125

Watchers: 25

Forks: 19

Open Issues: 6

Language: PHP

v0.4.0 2014-02-25 04:26 UTC

README

A PHP library that provides an incredibly easy way to access Twitter data as JSON, pretty printed JSON, or RSS feeds by URL or standard command line syntax. The Tweetledee files include caching to avoid exceeding the Twitter API v1.1 rate limits (see caveats in the documentation!).

Documentation

Current Release

  • 0.4.1 : added support for JSON pretty printing in PHP versions 5.3+ (from 5.4+ previously) issue #40. Thanks much to Martín Lucas Golini @SpartanJ for his new pretty printing functions that led to this update!

Recent Changes

  • 0.4.0 : added caching to all Tweetledee files with default 90 sec duration. This default cache interval can be changed with the cache_interval URL parameter (with a value in seconds). Great big thanks to Christian Varga (@levymetal) for his contributions to this update! The non-cached versions of the files from v0.3.6 have been renamed with an appended _nocache (e.g. userrss.php > userrss_nocache.php) for anyone who would like to implement their own caching.
  • 0.3.6 : bug fix for multi-parameter search query exception bug issue #30. Thanks much for the issue report @adjeD!
  • 0.3.5 : bug fix for Twitter search filters issue #28. Thanks much for the issue report @molis83!
  • 0.3.4 : added Python and Ruby wrappers for the Tweetledee files
  • 0.3.3 : bug fixes for issue #15 & issue #16. Thanks much for the contributions from @jjschwartz, @kabookey, and @mikeklimczak.
  • 0.3.2 : bug fixes for issue #14
  • 0.3.1 : Updated all standard JSON files with cross site access to your Twitter JSON data from client side JavaScript code (sets the Access-Control-Allow-Origin header to accept all connections, i.e. cross origin resource sharing). Defaults to off. Set the flag $TLD_JS = 1 in the file to activate this capability.
  • 0.3.0 : You can now access Tweetledee from the command line locally or remotely via SSH and pipe the output to any application. Data is returned via the standard output stream when you access files with a terminal. Tweetledee will parse the parameters as standard command line switches. For single character parameters use short switches -q and for multiple character parameters use long switches --user.
  • 0.2.9 : Added Twitter user lists RSS feeds listsrss.php, JSON listsjson.php, pretty printed JSON listsjson_pp.php

The 1.5 Minute Guide to a Successful Install

You will need the following:

  • Access via URL: PHP version 5.3 or higher
  • Access via command line: PHP version 5.3 or higher
  • libcurl installed (provides cURL - http://curl.haxx.se/libcurl/)
  • A Twitter application account from which you will obtain the:

    1) consumer key 2) consumer secret 3) access key 4) access secret

3-Step Installation instructions:

  1. Open the file on the path tweetledee > tldlib > keys > tweetledee_keys.php in any text editor and enter the information that you obtained from your Twitter app in the corresponding fields. Leave the single quotes around the alphanumeric strings that you enter.

  2. Upload the 'tweetledee' directory (that is located in the directory where this README file resides) to the public facing directory on your web server. On many servers, this is the public_html directory

  3. Kick the tires with the following test (it gives you a user timeline RSS feed for your account): http://[yourdomain]/tweetledee/userrss.php

That was easy... Go crazy, be good, have fun.

What You Get

Twitter RSS Feeds

Favorites RSS Feed [favoritesrss.php] + [favoritesrss_nocache.php] Home Timeline RSS Feed [homerss.php] + [homerss_nocache.php] User Lists RSS Feed [listsrss.php] + [listrss_nocache.php] User Timeline RSS Feed [userrss.php] + [userrss_nocache.php] Search RSS Feed [searchrss.php] + [searchrss_nocache.php]

Twitter JSON

Favorites JSON [favoritesjson.php] + [favoritesjson_nocache.php] Home Timeline JSON [homejson.php] + [homejson_nocache.php] User Lists JSON [listsjson.php] + [listsjson_nocache.php] User Timeline JSON [userjson.php] + [userjson_nocache.php] Search JSON [searchjson.php] + + [searchjson_nocache.php]

Pretty Printed JSON

Favorites Pretty Printed JSON [favoritesjson_pp.php] + [favoritesjson_pp_nocache.php] Home Timeline Pretty Printed JSON [homejson_pp.php] + [homejson_pp_nocache.php] User Lists Pretty Printed JSON [listsjson_pp.php] + [listsjson_pp_nocache.php] User Timeline Pretty Printed JSON [userjson_pp.php] + [userjson_pp_nocache.php] Search Pretty Printed JSON [searchjson_pp.php] + [searchjson_pp_nocache.php]

Usage

Tweetledee Usage Examples

Bugs & Questions

If you find a bug, please post it as a new issue on the GitHub repository with this information in your report.

Looking for support? Check this page.

Contribute

If you would like to contribute to the project, have at it. Fork the Tweetledee project, include your changes, and submit a pull request back to the main repository.

License

MIT License - see the LICENSE.txt file in the source distribution

✪ Chris