Update README.md
[rainbowstream.git] / README.rst
... / ...
CommitLineData
1Rainbow Stream\r
2--------------\r
3\r
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
9\r
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
19.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
20 :alt: v0.0.1\r
21\r
22.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
23 :alt: v0.0.3\r
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
48I shipped a feature which can display **tweet's images directly on terminal**.\r
49You can try it with:\r
50\r
51.. code:: bash\r
52\r
53 rainbow -iot # Or rainbow --image-on-term\r
54\r
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
64the Enter key to see the help.\r
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
68suggestion. Input history from previous run is available as well.\r
69\r
70Here is full list of supported command\r
71\r
72**Action Commands**\r
73\r
74- ``trend`` will show global trending topics. ``trend US`` will show\r
75 trends in United States while ``trend JP Tokyo`` will show trends\r
76 in Tokyo/Japan.\r
77\r
78- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
79 tweets.\r
80\r
81- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
82 exactly 9 tweets.\r
83\r
84- ``mentions`` will show mentions timeline. ``mentions 7`` will show\r
85 7 mention tweets.\r
86\r
87- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
88 rainbow is god’s promise to noah’*\r
89\r
90- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
91 each tweet beside the time.\r
92\r
93- ``fav 12`` will favorite the tweet with *[id=12]*.\r
94\r
95- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
96\r
97- ``del 12`` will delete tweet with *[id=12]*.\r
98\r
99- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
100\r
101- ``s #noah`` will search the word *‘noah’*. Result will come back\r
102 with highlight.\r
103\r
104- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
105\r
106- ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
107\r
108- ``ls fl`` will list all your followers (people who are following you).\r
109\r
110- ``ls fr`` will list all your friends (people who you are following).\r
111\r
112- ``inbox`` will show inbox messages. ``inbox 7`` will show newest\r
113 7 message.\r
114\r
115- ``sent`` will show sent messages. ``sent 7`` will show newest\r
116 7 message.\r
117\r
118- ``trash 5`` will remove message with *[message_id=5]*.\r
119\r
120- ``whois @dtvd88`` will show profile of @dtvd88.\r
121\r
122- ``fl @dtvd88`` will follow @dtvd88.\r
123\r
124- ``ufl @dtvd88`` will unfollow @dtvd88.\r
125\r
126- ``h`` will show the help.\r
127\r
128- ``c`` will clear the screen.\r
129\r
130- ``q`` will quit.\r
131\r
132**Stream Commands**\r
133\r
134- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
135\r
136- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
137 to provide 2 list:\r
138\r
139 ``Only nicks`` decide what nicks will be include only.\r
140\r
141 ``Ignore nicks`` decide what nicks will be exclude.\r
142\r
143- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
144 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
145\r
146- ``switch mine`` will switch current stream to personal stream. ``-f``\r
147 and ``-d`` will work as well.\r
148\r
149\r
150For example see the screenshot above.\r
151\r
152Bug Report\r
153----------\r
154\r
155Please `create an issue`_ or contact me at `@dtvd88`_\r
156\r
157License\r
158-------\r
159\r
160Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
161details\r
162\r
163\r
164.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
165.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
166.. _EarthQuake: https://github.com/jugyo/earthquake\r
167.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
168.. _@dtvd88: https://twitter.com/dtvd88\r