fix rst file
[rainbowstream.git] / README.rst
CommitLineData
3108149e 1Rainbow Stream\r
2--------------\r
3\r
3216f3f4
O
4.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
5 :target: https://pypi.python.org/pypi/rainbowstream\r
6\r
7.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
8 :target: https://pypi.python.org/pypi/rainbowstream\r
c96321cc 9\r
3108149e 10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
3216f3f4 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
3108149e 14\r
15Screenshot\r
16----------\r
17\r
3216f3f4
O
18.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
19 :alt: rainbowstream\r
20\r
21.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
22 :alt: rainbowstreamIOT\r
3108149e 23\r
24Install\r
25-------\r
26\r
27You will need Python 2.7+ and pip.\r
28\r
29.. code:: bash\r
30\r
31 pip install rainbowstream\r
32\r
33Usage\r
34-----\r
35\r
36The stream\r
37^^^^^^^^^^\r
38\r
39Just type\r
40\r
41.. code:: bash\r
42\r
43 rainbow\r
44\r
45and see your stream.\r
46\r
3216f3f4
O
47I shipped a feature which can display **tweet's images directly on terminal**.\r
48You can try it with:\r
4373c17c
O
49\r
50.. code:: bash\r
51\r
c1fa7c94 52 rainbow -iot # Or rainbow --image-on-term\r
4373c17c 53\r
3108149e 54In the first time you will be asked for authorization of Rainbow Stream\r
55app at Twitter. Just click the “Authorize access” button and paste PIN\r
3216f3f4 56number to the terminal, the rainbow will start.\r
3108149e 57\r
58The interactive mode\r
59^^^^^^^^^^^^^^^^^^^^\r
60\r
61While your personal stream is continued, you are also ready to tweet,\r
62search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 63the Enter key to see the help.\r
3108149e 64\r
65Input is in interactive mode. It means that you can use arrow key to\r
66move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 67suggestion. Input history from previous run is available as well.\r
3108149e 68\r
69Here is full list of supported command\r
70\r
eebc0ae6 71**Action Commands**\r
3108149e 72\r
eebc0ae6 73- ``trend`` will show global trending topics. ``trend US`` will show\r
3216f3f4
O
74 trends in United States while ``trend JP Tokyo`` will show trends\r
75 in Tokyo/Japan.\r
3108149e 76\r
77- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
e2b81717 78 tweets.\r
3108149e 79\r
80- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
e2b81717
O
81 exactly 9 tweets.\r
82\r
3216f3f4
O
83- ``mentions`` will show mentions timeline. ``mentions 7`` will show\r
84 7 mention tweets.\r
3108149e 85\r
86- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
3216f3f4 87 rainbow is god’s promise to noah’*\r
3108149e 88\r
89- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
90 each tweet beside the time.\r
91\r
92- ``fav 12`` will favorite the tweet with *[id=12]*.\r
93\r
94- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
95\r
96- ``del 12`` will delete tweet with *[id=12]*.\r
97\r
98- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
99\r
3216f3f4
O
100- ``s #noah`` will search the word *‘noah’*. Result will come back\r
101 with highlight.\r
3108149e 102\r
d286f104
O
103- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
104\r
3216f3f4 105- ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
3108149e 106\r
3216f3f4 107- ``ls fl`` will list all your followers (people who are following you).\r
b8cc314c 108\r
109- ``ls fr`` will list all your friends (people who you are following).\r
110\r
3216f3f4
O
111- ``inbox`` will show inbox messages. ``inbox 7`` will show newest\r
112 7 message.\r
e2b81717 113\r
3216f3f4
O
114- ``sent`` will show sent messages. ``sent 7`` will show newest\r
115 7 message.\r
e2b81717 116\r
3216f3f4 117- ``trash 5`` will remove message with *[message_id=5]*.\r
e2b81717
O
118\r
119- ``whois @dtvd88`` will show profile of @dtvd88.\r
120\r
f5677fb1
O
121- ``fl @dtvd88`` will follow @dtvd88.\r
122\r
123- ``ufl @dtvd88`` will unfollow @dtvd88.\r
3108149e 124\r
125- ``h`` will show the help.\r
126\r
127- ``c`` will clear the screen.\r
128\r
129- ``q`` will quit.\r
130\r
eebc0ae6
O
131**Stream Commands**\r
132\r
3216f3f4 133- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
eebc0ae6
O
134\r
135- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
136 to provide 2 list:\r
137\r
138 ``Only nicks`` decide what nicks will be include only.\r
139\r
3216f3f4 140 ``Ignore nicks`` decide what nicks will be exclude.\r
eebc0ae6
O
141\r
142- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
143 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
144\r
145- ``switch mine`` will switch current stream to personal stream. ``-f``\r
146 and ``-d`` will work as well.\r
147\r
3216f3f4 148\r
3108149e 149For example see the screenshot above.\r
150\r
151Bug Report\r
152----------\r
153\r
3216f3f4 154Please `create an issue`_ or contact me at `@dtvd88`_\r
3108149e 155\r
156License\r
157-------\r
158\r
159Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
160details\r
161\r
162\r
163.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 164.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3216f3f4 165.. _EarthQuake: https://github.com/jugyo/earthquake\r
3108149e 166.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
3216f3f4 167.. _@dtvd88: https://twitter.com/dtvd88\r