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