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