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