Update README.md
[rainbowstream.git] / README.rst
... / ...
CommitLineData
1Rainbow Stream\r
2--------------\r
3\r
4Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
5favorite … and much more fun directly from terminal.\r
6\r
7This package build on the top of `Python Twitter Tool`_ and `Twitter\r
8Streaming API`_ and inspired by `EarthQuake`_\r
9\r
10Screenshot\r
11----------\r
12\r
13.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
14 :alt: v0.0.1\r
15\r
16.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
17 :alt: v0.0.3\r
18\r
19Install\r
20-------\r
21\r
22You will need Python 2.7+ and pip.\r
23\r
24.. code:: bash\r
25\r
26 pip install rainbowstream\r
27\r
28Usage\r
29-----\r
30\r
31The stream\r
32^^^^^^^^^^\r
33\r
34Just type\r
35\r
36.. code:: bash\r
37\r
38 rainbow\r
39\r
40and see your stream.\r
41\r
42I shipped a feature which can display **tweet's images directly on terminal**.\r
43You can try it with:\r
44\r
45.. code:: bash\r
46\r
47 rainbow -iot # Or rainbow --image-on-term\r
48\r
49In the first time you will be asked for authorization of Rainbow Stream\r
50app at Twitter. Just click the “Authorize access” button and paste PIN\r
51number to the terminal, the rainbow will start.\r
52\r
53The interactive mode\r
54^^^^^^^^^^^^^^^^^^^^\r
55\r
56While your personal stream is continued, you are also ready to tweet,\r
57search, reply, retweet… directly from console. Simply type “h” and hit\r
58the Enter key to see the help.\r
59\r
60Input is in interactive mode. It means that you can use arrow key to\r
61move up and down history, tab-autocomplete or 2 tab to view available\r
62suggestion. Input history from previous run is available as well.\r
63\r
64Here is full list of supported command\r
65\r
66**Stream Command**\r
67\r
68- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
69\r
70- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
71 to provide 2 list:\r
72\r
73 ``Only nicks`` decide what nicks will be include only.\r
74\r
75 ``Ignore nicks`` decide what nicks will be exclude.\r
76\r
77- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
78 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
79\r
80- ``switch mine`` will switch current stream to personal stream. ``-f``\r
81 and ``-d`` will work as well.\r
82\r
83**Action Command**\r
84\r
85- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
86 tweet.\r
87\r
88- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
89 exactly 9 tweet.\r
90\r
91- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
92 rainbow is god’s promise to noah’*\r
93\r
94- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
95 each tweet beside the time.\r
96\r
97- ``fav 12`` will favorite the tweet with *[id=12]*.\r
98\r
99- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
100\r
101- ``del 12`` will delete tweet with *[id=12]*.\r
102\r
103- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
104\r
105- ``s #noah`` will search the word *‘noah’*. Result will come back\r
106 with highlight.\r
107\r
108- ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
109\r
110- ``fl @dtvd88`` will follow @dtvd88.\r
111\r
112- ``ufl @dtvd88`` will unfollow @dtvd88.\r
113\r
114- ``h`` will show the help.\r
115\r
116- ``c`` will clear the screen.\r
117\r
118- ``q`` will quit.\r
119\r
120For example see the screenshot above.\r
121\r
122Bug Report\r
123----------\r
124\r
125Please `create an issue`_ or contact me at `@dtvd88`_\r
126\r
127License\r
128-------\r
129\r
130Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
131details\r
132\r
133\r
134.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
135.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
136.. _EarthQuake: https://github.com/jugyo/earthquake\r
137.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
138.. _@dtvd88: https://twitter.com/dtvd88\r