Change of behavior| Now a URL is required as an argument
[tweeper.git] / README
1 Tweeper is a web scraper which extracts the most recent public tweets of
2 a given user from their home page on Twitter.com and formats them in RSS, so
3 the information can be conveniently accessed and collected by a feed reader.
4
5 Since Jun 11th 2013 Twitter.com retired their API v1.0, so it's not possible
6 to access a user timeline via RSS anymore, and it's also become mandatory to
7 authenticate via OAuth to access this _public_ information in JSON format:
8
9   https://dev.twitter.com/discussions/16289
10   https://dev.twitter.com/discussions/11564
11
12 Some services came up to overcome this "problem":
13
14   http://twss.55uk.net/
15   http://twitter-rss.com/ (now redirecting to google.com)
16
17 However these solutions are still shady and let no control to the user about
18 who collects the information about the visited user timelines.
19
20 This is why Tweeper[1] was born, as an Open Source way to keep following your
21 friends with a certain degree of anonymity, without having to tell Twitter.com
22 whom you are friend to.
23
24 [1] http://www.urbandictionary.com/define.php?term=TWEEPER&defid=3743173
25
26 Tweeper can be used via web or as a command line program, for example as
27 a filter in your feed reader, by passing the user's "screen name" (without the
28 '@') as the first argument.
29
30 Example of use on the command line:
31
32   $ php tweeper.php NSACareers
33
34 Example of use as a Liferea[2] filter:
35
36   $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php NSAcareers"
37
38 [2] http://lzone.de/liferea/
39
40 Tweeper is licensed under the GPLv3.
41 Tweeper was written by Antonio Ospite http://ao2.it