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