5f22618f702b15b2195da384e7f57a171f93052e
[tweeper.git] / README
1 Tweeper is a web scraper which can be used to conveniently follow the public
2 activity of social network users without the need to log in or even be
3 subscribed to the social network; tweeper converts the public information to
4 RSS so that it can be accessed and collected by a feed reader.
5
6 Since Jun 11th 2013, when Twitter.com retired their API v1.0, it has not been
7 possible anymore to access a user timeline via RSS, and it has also become
8 mandatory to authenticate via OAuth to access this _public_ information in the
9 JSON format:
10
11   https://dev.twitter.com/discussions/16289
12   https://dev.twitter.com/discussions/11564
13
14 Some services came up to overcome this "problem":
15
16   http://twss.55uk.net/
17   http://twitter-rss.com/ (now redirecting to google.com)
18   http://rssitfor.me
19
20 However these solutions are still shady and let no control to the user about
21 who collects the information about the visited user timelines.
22
23 This is why Tweeper[1] was born, as an Open Source way to keep following your
24 friends with a certain degree of anonymity, without having to tell Twitter.com
25 whom you are friend to.
26
27 [1] http://www.urbandictionary.com/define.php?term=TWEEPER&defid=3743173
28
29 Tweeper can easily scrape sites other than Twitter, it is just a matter of
30 writing an xsl stylesheet for the transformation; an example for pump.io
31 activity stream is provided in rss_converter_pump.io.xsl
32
33 The currently supported sites are:
34
35   * Twitter.com
36   * Pump.io based websites, like Identi.ca
37   * Dilbert.com
38   * Howtoons.com
39   * Instagram.com
40   * Facebook.com (public pages)
41
42 Tweeper can be used via web or as a command line program, for example as
43 a filter in your feed reader, by passing the URL of the user's public timeline
44 as the first argument.
45
46 Example of use on the command line:
47
48   $ php tweeper.php https://twitter.com/NSACareers
49
50 Example of use as a Liferea[2] filter:
51
52   $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php https://twitter.com/NSAcareers"
53
54 Example of use with identi.ca:
55
56   $ liferea-add-feed  "|php .../path_to_tweeper/tweeper.php http://identi.ca/evan"
57
58 [2] http://lzone.de/liferea/
59
60 Tweeper is licensed under the GPLv3.
61 Tweeper was written by Antonio Ospite https://ao2.it