fix document
[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
100The interactive mode\r
101^^^^^^^^^^^^^^^^^^^^\r
102\r
103While your personal stream is continued, you are also ready to tweet,\r
104search, reply, retweet… directly from console. Simply type “h” and hit\r
105the Enter key to see the help.\r
106\r
107Input is in interactive mode. It means that you can use arrow key to\r
108move up and down history, tab-autocomplete or 2 tab to view available\r
109suggestion. Input history from previous run is available as well.\r
110\r
111Here is full list of supported command:\r
112\r
113**Explore Commands**\r
114\r
115- ``trend`` will show global trending topics. ``trend US`` will show\r
116 trends in United States while ``trend JP Tokyo`` will show trends in\r
117 Tokyo/Japan.\r
118\r
119- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
120 tweets.\r
121\r
122- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
123 mention tweets.\r
124\r
125- ``whois @dtvd88`` will show profile of @dtvd88.\r
126\r
127- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
128 exactly 9 tweets.\r
129\r
03e08f86
O
130- ``s noah`` will search the word *‘noah’*. Result will come back with\r
131 highlight. Search can be performed with or without hashtag.\r
c264071c 132\r
133**Tweet Commands**\r
134\r
135- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
136 rainbow is god’s promise to noah’*.\r
137\r
138- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
139 each tweet beside the time.\r
140\r
162af8aa
O
141- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
142 the quote will be cancelled.\r
143\r
c264071c 144- ``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
145\r
fd87ddac
O
146- ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*.\r
147\r
c264071c 148- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
149\r
150- ``fav 12`` will favorite the tweet with *[id=12]*.\r
151\r
152- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
153\r
154- ``del 12`` will delete tweet with *[id=12]*.\r
155\r
156- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
157 OS’s image viewer.\r
158\r
162af8aa
O
159- ``open 12`` will open url in tweet with *[id=12]* in your\r
160 OS’s default browser.\r
161\r
c264071c 162**Direct Messages Commands**\r
163\r
ff1a4e5f 164- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.\r
c264071c 165\r
ff1a4e5f 166- ``thread 2`` will show full thread with [id=2].\r
c264071c 167\r
168- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
169\r
170- ``trash 5`` will remove message with *[message\_id=5]*\r
171\r
172**Friends and followers Commands**\r
173\r
174- ``ls fl`` will list all your followers (people who are following\r
175 you).\r
176\r
177- ``ls fr`` will list all your friends (people who you are following).\r
178\r
179- ``fl @dtvd88`` will follow @dtvd88.\r
180\r
181- ``ufl @dtvd88`` will unfollow @dtvd88.\r
182\r
183- ``mute @dtvd88`` will mute @dtvd88.\r
184\r
185- ``unmute @dtvd88`` will unmute @dtvd88.\r
186\r
187- ``muting`` will list muting users.\r
188\r
189- ``block @dtvd88`` will block @dtvd88.\r
190\r
191- ``unblock @dtvd88`` will unblock @dtvd88.\r
192\r
193- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
194\r
bef33491
O
195**Twitter list**\r
196\r
197- ``list`` will show all lists you are belong to.\r
198\r
199- ``list home`` will show timeline of list. You will be asked for list's name.\r
200\r
201- ``list all_mem`` will show list's all members.\r
202\r
203- ``list all_sub`` will show list's all subscribers.\r
204\r
205- ``list add`` will add specific person to a list owned by you.\r
bef33491
O
206\r
207- ``list rm`` will remove specific person from a list owned by you.\r
bef33491
O
208\r
209- ``list sub`` will subscribe you to a specific list.\r
210\r
211- ``list unsub`` will unsubscribe you from a specific list.\r
212\r
213- ``list own`` will show all list owned by you.\r
214\r
215- ``list new`` will create a new list.\r
216\r
217- ``list update`` will update a list owned by you.\r
218\r
219- ``list del`` will delete a list owned by you.\r
220\r
c264071c 221**Switching Stream Commands**\r
222\r
223- ``switch public #AKB48`` will switch current stream to public stream\r
224 and track keyword ``AKB48``\r
225\r
226- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
227 to provide 2 list:\r
228\r
229 ``Only nicks`` decide what nicks will be include only.\r
230\r
231 ``Ignore nicks``\ decide what nicks will be exclude.\r
232\r
233- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
234 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
235\r
236- ``switch mine`` will switch current stream to personal stream. ``-f``\r
237 and ``-d`` will work as well.\r
238\r
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
271- ``q`` will quit.\r
272\r
e5057f23
O
273Theme customization\r
274^^^^^^^^^^^^^^^^^^^\r
275\r
06302419 276Rainbow Stream is shipped with some default themes.\r
e5057f23
O
277You can either change theme by ``theme`` command or create your favorite one.\r
278\r
155083ad
O
279Theme’s screenshot:\r
280\r
3681056d
O
281- Monokai\r
282\r
155083ad
O
283.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
284 :alt: monokai\r
285\r
3681056d
O
286- Solarized\r
287\r
155083ad
O
288.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
289 :alt: solarized\r
290\r
3681056d
O
291- Tomorrow Night\r
292\r
aa835f48
O
293.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
294 :alt: tomorrownight\r
295\r
3681056d
O
296- Larapaste\r
297\r
aa835f48
O
298.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
299 :alt: larapaste\r
300\r
e5057f23 301For detaile information, see `theme usage and customization`_.\r
c264071c 302\r
29fd0be6
O
303Config explanation\r
304^^^^^^^^^^^^^^^^^^\r
305\r
84808427 306Rainbow 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
307\r
308You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
1603ff45 309\r
cb45dc23 310- ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
311\r
312- ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
313\r
4ef01bda 314- ``THEME``: current theme.\r
29fd0be6 315\r
4ef01bda 316- ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
29fd0be6 317\r
cb45dc23 318- ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
319\r
320- ``PREFIX``: display string of prompt.\r
335e7803 321\r
4ef01bda 322- ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
29fd0be6 323\r
4ef01bda
O
324- ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
325\r
326- ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
327\r
fd87ddac
O
328- ``CONVERSATION_MAX``: max tweet in a 'conversation' thread.\r
329\r
7c437a0f
O
330- ``QUOTE_FORMAT``: format when quote a tweet\r
331\r
332 + ``#comment``: Your own comment about the tweet\r
333 + ``#owner``: owner's username with '@'\r
334 + ``#tweet``: original tweet\r
335\r
4ef01bda
O
336- ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
337\r
338- ``TREND_MAX``: default trends to display on 'trend' command.\r
339\r
340- ``LIST_MAX``: default tweets to display on 'list home' command.\r
341\r
342- ``ONLY_LIST``: filter list on 'switch' command.\r
343\r
344- ``IGNORE_LIST``: ignore list on 'switch' command.\r
345\r
346- ``HISTORY_FILENAME``: name of file which stores input history.\r
347\r
348- ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
349\r
350- ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
351\r
352- ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
353\r
354- ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
355\r
356- ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
29fd0be6 357\r
7746aa96
O
358- ``FORMAT``: display format for tweet and message.\r
359\r
33cef8f6
O
360 + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
361 + ``DISPLAY``: decide how tweet will be printed.\r
d6cc4c67 362\r
33cef8f6
O
363 + ``#name``: Twitter's name\r
364 + ``#nick``: Twitter's screen name\r
365 + ``#clock``: Datetime\r
318cdd67
O
366 + ``#rt_count``: retweets count\r
367 + ``#fa_count``: favorites count\r
33cef8f6
O
368 + ``#id``: ID\r
369 + ``#fav``: favorited symbol\r
318cdd67 370 + ``#fav``: favorited symbol\r
33cef8f6
O
371 + ``#tweet``: Tweet's content\r
372 + ``#sender_name``: Message's sender name\r
373 + ``#sender_nick``: Message's sender screen name\r
374 + ``#to``: '>>>' symbol\r
375 + ``#recipient_name``: Message's recipient name\r
376 + ``#recipient_nick``: Message's recipient screen name\r
7746aa96
O
377\r
378\r
2d341029
O
379Development\r
380-----------\r
381\r
382If you want to build a runnable version yourself, follow these simple\r
383steps\r
384\r
385- `Create your own Twitter Application`_\r
386- Get your Twitter application’s API key and secret\r
9e1f9d56 387- Fork github's repo and clone in your system.\r
2d341029
O
388- Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
389 following content\r
390\r
391 .. code:: python\r
392\r
393 # Consumer information\r
394 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
395 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
396\r
397- Use pip to install in local\r
398\r
399 .. code:: bash\r
400\r
9e1f9d56 401 # cd to directory which contains setup.py (cloned directory)\r
2d341029
O
402 virtualenv venv # Python3 users: use -p to specify python3\r
403 source venv/bin/activate\r
404 pip install -e .\r
9e1f9d56
O
405 which rainbowstream # /this-directory/venv/bin/rainbowstream\r
406 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
407 # Remove ~/.rainbow_oauth if exists\r
2d341029 408 rainbowstream # local version of rainbowstream\r
c264071c 409\r
2d341029
O
410.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
411.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
c264071c 412.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
413.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
e5057f23 414.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
0dc0dd00 415.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
98f3deaa 416.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
7746aa96 417.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
bdc155b7
O
418.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
419.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
92d14ca1 420.. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
5bfc62f2 421\r