bumped version
[rainbowstream.git] / docs / index.rst
1 Rainbow 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
10 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11 favorite … and much more fun directly from terminal.\r
12 \r
13 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
14 can run on Python 2.7.x and 3.x .\r
15 \r
16 Home page : http://www.rainbowstream.org/\r
17 \r
18 Source code : https://github.com/DTVD/rainbowstream\r
19 \r
20 Install\r
21 -------\r
22 \r
23 The quick way\r
24 ^^^^^^^^^^^^^\r
25 \r
26 You will need Python and pip (2.7.x or 3.x).\r
27 \r
28 .. code:: bash\r
29 \r
30     sudo pip install rainbowstream\r
31     # Python 3 users: sudo pip3 install rainbowstream\r
32 \r
33 The recommended way\r
34 ^^^^^^^^^^^^^^^^^^^\r
35 \r
36 Use `virtualenv`_\r
37 \r
38 .. code:: bash\r
39 \r
40     virtualenv venv\r
41     # Python 3 users : use -p to specify your Python 3 localtion as below\r
42     # virtualenv -p /usr/bin/python3 venv\r
43     source venv/bin/activate\r
44     pip install rainbowstream\r
45 \r
46 Troubleshooting\r
47 ^^^^^^^^^^^^^^^\r
48 \r
49 If you use Linux, you might need to install some packages if you haven't already.\r
50 For debian-based distros, these can be installed with\r
51 \r
52 .. code:: bash\r
53 \r
54     sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
55 \r
56 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
57 the ``Pillow`` package installation - a dependency of this app.\r
58 If you are in this case, I recommend taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you.\r
59 \r
60 .. code:: bash\r
61 \r
62     export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
63 \r
64 If installation in *the quick way* doesn't work:\r
65 \r
66 -  ``sudo pip uninstall rainbowstream``\r
67 -  use the *virtualenv way* above\r
68 -  `create an issue`_ and provide:\r
69 \r
70   + Your OS\r
71   + Your Python version\r
72 \r
73 Usage\r
74 -----\r
75 \r
76 The stream\r
77 ^^^^^^^^^^\r
78 \r
79 Just type\r
80 \r
81 .. code:: bash\r
82 \r
83     rainbowstream\r
84 \r
85 and see your stream.\r
86 \r
87 I shipped a feature which can display **tweet's images directly on terminal**.\r
88 You can try it with:\r
89 \r
90 .. code:: bash\r
91 \r
92     rainbowstream -iot # Or rainbowstream --image-on-term\r
93 \r
94 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
95 to enable above feature,\r
96 change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)\r
97 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
98 (see `config management`_ section).\r
99 \r
100 In the first time you will be asked for authorization of Rainbow Stream\r
101 app at Twitter. Just click the “Authorize access” button and paste PIN\r
102 number to the terminal, the rainbow will start.\r
103 \r
104 You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are\r
105 provided as follows:\r
106 \r
107 .. code:: bash\r
108 \r
109     rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP\r
110     # or using the short form:\r
111     rainbowstream -ph localhost -pp 1337 -pt HTTP\r
112 \r
113 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default\r
114 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.\r
115 \r
116 The interactive mode\r
117 ^^^^^^^^^^^^^^^^^^^^\r
118 \r
119 While your personal stream is continued, you are also ready to tweet,\r
120 search, reply, retweet… directly from console. Simply type “h” and hit\r
121 the Enter key to see the help.\r
122 \r
123 Input is in interactive mode. It means that you can use arrow key to\r
124 move up and down history, tab-autocomplete or 2 tab to view available\r
125 suggestion. Input history from previous run is available as well.\r
126 \r
127 Here is full list of supported command:\r
128 \r
129 **Explore Commands**\r
130 \r
131 -  ``trend`` will show global trending topics. ``trend US`` will show trends in United States while ``trend JP Tokyo`` will show trends in Tokyo/Japan.\r
132 \r
133 -  ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets.\r
134 \r
135 -  ``notification`` will show your notification from the time you started RainbowStream.\r
136 \r
137 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets.\r
138 \r
139 -  ``whois @dtvd88`` will show profile of @dtvd88.\r
140 \r
141 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print exactly 9 tweets.\r
142 \r
143 -  ``s noah`` will search the word *‘noah’*. Result will come back with highlight. Search can be performed with or without hashtag.\r
144 \r
145 **Tweet Commands**\r
146 \r
147 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the rainbow is god’s promise to noah’*.\r
148 \r
149 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.\r
150 \r
151 -  ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added, the quote will be cancelled.\r
152 \r
153 -  ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
154 \r
155 -  ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*.\r
156 \r
157 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
158 \r
159 -  ``fav 12`` will favorite the tweet with *[id=12]*.\r
160 \r
161 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
162 \r
163 -  ``share 12`` will copy link to tweet with *[id=12]* to your clipboard if you are on a Mac, or display it directly if you are on Linux.\r
164 \r
165 -  ``del 12`` will delete tweet with *[id=12]*.\r
166 \r
167 -  ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.\r
168 \r
169 -  ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser.\r
170 \r
171 **Direct Messages Commands**\r
172 \r
173 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.\r
174 \r
175 -  ``thread 2`` will show full thread with [id=2].\r
176 \r
177 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
178 \r
179 -  ``trash 5`` will remove message with *[message\_id=5]*\r
180 \r
181 **Friends and followers Commands**\r
182 \r
183 -  ``ls fl`` will list all your followers (people who are following you).\r
184 \r
185 -  ``ls fr`` will list all your friends (people who you are following).\r
186 \r
187 -  ``fl @dtvd88`` will follow @dtvd88.\r
188 \r
189 -  ``ufl @dtvd88`` will unfollow @dtvd88.\r
190 \r
191 -  ``mute @dtvd88`` will mute @dtvd88.\r
192 \r
193 -  ``unmute @dtvd88`` will unmute @dtvd88.\r
194 \r
195 -  ``muting`` will list muting users.\r
196 \r
197 -  ``block @dtvd88`` will block @dtvd88.\r
198 \r
199 -  ``unblock @dtvd88`` will unblock @dtvd88.\r
200 \r
201 -  ``report @dtvd88`` will report @dtvd88 as a spam account.\r
202 \r
203 **Twitter list**\r
204 \r
205 -  ``list`` will show all lists you are belong to.\r
206 \r
207 -  ``list home`` will show timeline of list. You will be asked for list's name.\r
208 \r
209 -  ``list all_mem`` will show list's all members.\r
210 \r
211 -  ``list all_sub`` will show list's all subscribers.\r
212 \r
213 -  ``list add`` will add specific person to a list owned by you.\r
214 \r
215 -  ``list rm`` will remove specific person from a list owned by you.\r
216 \r
217 -  ``list sub`` will subscribe you to a specific list.\r
218 \r
219 -  ``list unsub`` will unsubscribe you from a specific list.\r
220 \r
221 -  ``list own`` will show all list owned by you.\r
222 \r
223 -  ``list new`` will create a new list.\r
224 \r
225 -  ``list update`` will update a list owned by you.\r
226 \r
227 -  ``list del`` will delete a list owned by you.\r
228 \r
229 **Switching Stream Commands**\r
230 \r
231 -  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
232 \r
233 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you to provide 2 list:\r
234 \r
235    ``Only nicks`` decide what nicks will be include only.\r
236 \r
237    ``Ignore nicks``\ decide what nicks will be exclude.\r
238 \r
239 -  ``switch mine`` will switch current stream to personal stream. ``-f`` will work as well.\r
240 \r
241 -  ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.\r
242 \r
243 **Smart shell**\r
244 \r
245 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
246 \r
247   + ``142857*2`` or ``101**3`` like a calculator.\r
248   + Even ``cal`` will show the calendar for current month.\r
249   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
250 \r
251 **Config Management**\r
252 \r
253 -  ``theme`` will list available themes.\r
254 \r
255   + ``theme monokai`` will apply *monokai* theme immediately.\r
256   + Changed theme will be remember as the next time's default theme.\r
257 \r
258 -  ``config`` will list all config key.\r
259 \r
260   + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
261   + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.\r
262   + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.\r
263   + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.\r
264 \r
265 **Screening Commands**\r
266 \r
267 -  ``h`` will show the help.\r
268 \r
269 -  ``p`` will pause the stream.\r
270 \r
271 -  ``r`` will unpause the stream.\r
272 \r
273 -  ``c`` will clear the screen.\r
274 \r
275 -  ``v`` will show version info.\r
276 \r
277 -  ``q`` will quit.\r
278 \r
279 Theme customization\r
280 ^^^^^^^^^^^^^^^^^^^\r
281 \r
282 Rainbow Stream is shipped with some default themes.\r
283 You can either change theme by ``theme`` command or create your favorite one.\r
284 \r
285 Theme’s screenshot:\r
286 \r
287 - Monokai\r
288 \r
289 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
290    :alt: monokai\r
291 \r
292 - Solarized\r
293 \r
294 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
295    :alt: solarized\r
296 \r
297 - Tomorrow Night\r
298 \r
299 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
300    :alt: tomorrownight\r
301 \r
302 - Larapaste\r
303 \r
304 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
305    :alt: larapaste\r
306 \r
307 For detaile information, see `theme usage and customization`_.\r
308 \r
309 Config explanation\r
310 ^^^^^^^^^^^^^^^^^^\r
311 \r
312 Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the `default config`_ to solve format problems.\r
313 \r
314 You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
315 \r
316 -  ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
317 \r
318 -  ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
319 \r
320 -  ``THEME``: current theme.\r
321 \r
322 -  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
323 \r
324 -  ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
325 \r
326 -  ``PREFIX``: display formated string of prompt.\r
327 \r
328     + ``#me``: Your username with '@', only available in personal stream.\r
329     + ``#place``: List name, only available in list stream.\r
330     + ``#owner``: Owner of list name, only available in list stream.\r
331     + ``#keyword``: Keyword, only available on public stream.\r
332 \r
333 -  ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
334 \r
335 -  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
336 \r
337 -  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
338 \r
339 -  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
340 \r
341 -  ``CONVERSATION_MAX``: max tweet in a 'conversation' thread.\r
342 \r
343 -  ``QUOTE_FORMAT``: format when quote a tweet\r
344 \r
345     + ``#comment``: Your own comment about the tweet\r
346     + ``#owner``: owner's username with '@'\r
347     + ``#tweet``: original tweet\r
348 \r
349 -  ``THREAD_META_LEFT``: format for meta information of messages from partner which is display in the left of screen.\r
350 \r
351 -  ``THREAD_META_RIGHT``: format for meta information of messages from you which is display in the right of screen.\r
352 \r
353 -  ``THREAD_MIN_WIDTH``: minimum width of a message frame.\r
354 \r
355 -  ``NOTIFY_FORMAT``: format of a notification.\r
356 \r
357 -  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
358 \r
359 -  ``TREND_MAX``: default trends to display on 'trend' command.\r
360 \r
361 -  ``LIST_MAX``: default tweets to display on 'list home' command.\r
362 \r
363 -  ``ONLY_LIST``: filter list on 'switch' command. Eg: ["@fat","mdo"]\r
364 \r
365 -  ``IGNORE_LIST``: ignore list on 'switch' command. Eg: ["@fat"]\r
366 \r
367 -  ``HISTORY_FILENAME``: name of file which stores input history.\r
368 \r
369 -  ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
370 \r
371 -  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
372 \r
373 -  ``STREAM_DELAY``: seconds to wait before displaying another tweet, will drop all tweets while waiting. This value can be used to slow down the stream.\r
374 \r
375 -  ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
376 \r
377 -  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
378 \r
379 -  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
380 \r
381 -  ``FORMAT``: display format for tweet and message.\r
382 \r
383   + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
384   + ``DISPLAY``: decide how tweet will be printed.\r
385 \r
386     + ``#name``: Twitter's name\r
387     + ``#nick``: Twitter's screen name\r
388     + ``#clock``: Datetime\r
389     + ``#rt_count``: retweets count\r
390     + ``#fa_count``: favorites count\r
391     + ``#id``: ID\r
392     + ``#fav``: favorited symbol\r
393     + ``#fav``: favorited symbol\r
394     + ``#tweet``: Tweet's content\r
395     + ``#sender_name``: Message's sender name\r
396     + ``#sender_nick``: Message's sender screen name\r
397     + ``#to``: '>>>' symbol\r
398     + ``#recipient_name``: Message's recipient name\r
399     + ``#recipient_nick``: Message's recipient screen name\r
400 \r
401 In every format, you can use unicode characters like ``\u2665``.\r
402 Mac users also can use emoji characters as well (Ex: ``::zap::``).\r
403 See `Emoji cheatsheet`_ for details.\r
404 \r
405 Development\r
406 -----------\r
407 \r
408 If you want to build a runnable version yourself, follow these simple\r
409 steps\r
410 \r
411 -  `Create your own Twitter Application`_\r
412 -  Get your Twitter application’s API key and secret\r
413 -  Fork github's repo and clone in your system.\r
414 -  Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
415    following content\r
416 \r
417    .. code:: python\r
418 \r
419        # Consumer information\r
420        CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
421        CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
422 \r
423 -  Use pip to install in local\r
424 \r
425    .. code:: bash\r
426 \r
427        # cd to directory which contains setup.py (cloned directory)\r
428        virtualenv venv # Python3 users: use -p to specify python3\r
429        source venv/bin/activate\r
430        pip install -e .\r
431        which rainbowstream # /this-directory/venv/bin/rainbowstream\r
432        # Remove ~/.rainbow_oauth if exists\r
433        rainbowstream # local version of rainbowstream\r
434 \r
435 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
436 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
437 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
438 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
439 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
440 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
441 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
442 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
443 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
444 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
445 .. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
446 .. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/\r