4 .. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square
5 :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt
7 .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square
8 :target: https://pypi.python.org/pypi/rainbowstream
10 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
11 favorite … and much more fun directly from terminal.
13 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,
14 can run on Python 2.7.x and 3.x .
16 Home page : http://www.rainbowstream.org/
18 Source code : https://github.com/DTVD/rainbowstream
26 You will need Python and pip (2.7.x or 3.x).
30 sudo pip install rainbowstream
31 # Python 3 users: sudo pip3 install rainbowstream
41 # Python 3 users : use -p to specify your Python 3 localtion as below
42 # virtualenv -p /usr/bin/python3 venv
43 source venv/bin/activate
44 pip install rainbowstream
49 If you use Linux, you might need to install some packages if you haven't already.
50 For debian-based distros, these can be installed with
54 sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev
56 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with
57 the ``Pillow`` package installation - a dependency of this app.
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.
62 export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future
64 If installation in *the quick way* doesn't work:
66 - ``sudo pip uninstall rainbowstream``
67 - use the *virtualenv way* above
68 - `create an issue`_ and provide:
87 I shipped a feature which can display **tweet's images directly on terminal**.
92 rainbowstream -iot # Or rainbowstream --image-on-term
94 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
95 to enable above feature,
96 change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)
97 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.
98 (see `config management`_ section).
100 In the first time you will be asked for authorization of Rainbow Stream
101 app at Twitter. Just click the “Authorize access” button and paste PIN
102 number to the terminal, the rainbow will start.
104 You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are
109 rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP
110 # or using the short form:
111 rainbowstream -ph localhost -pp 1337 -pt HTTP
113 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default
114 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.
119 While your personal stream is continued, you are also ready to tweet,
120 search, reply, retweet… directly from console. Simply type “h” and hit
121 the Enter key to see the help.
123 Input is in interactive mode. It means that you can use arrow key to
124 move up and down history, tab-autocomplete or 2 tab to view available
125 suggestion. Input history from previous run is available as well.
127 Here is full list of supported command:
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.
133 - ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets.
135 - ``notification`` will show your notification from the time you started RainbowStream.
137 - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets.
139 - ``whois @dtvd88`` will show profile of @dtvd88.
141 - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print exactly 9 tweets.
143 - ``s noah`` will search the word *‘noah’*. Result will come back with highlight. Search can be performed with or without hashtag.
147 - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the rainbow is god’s promise to noah’*.
149 - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
151 - ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added, the quote will be cancelled.
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.
155 - ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*.
157 - ``rep 12 Really`` will reply *‘Really’* to the owner of the tweet with *[id=12]*.
159 - ``repall 12 Really`` will reply *‘Really’* to all people in the tweet with *[id=12]*.
161 - ``fav 12`` will favorite the tweet with *[id=12]*.
163 - ``ufav 12`` will unfavorite tweet with *[id=12]*.
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.
167 - ``del 12`` will delete tweet with *[id=12]*.
169 - ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.
171 - ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser.
173 **Direct Messages Commands**
175 - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.
177 - ``thread 2`` will show full thread with [id=2].
179 - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
181 - ``trash 5`` will remove message with *[message\_id=5]*
183 **Friends and followers Commands**
185 - ``ls fl`` will list all your followers (people who are following you).
187 - ``ls fr`` will list all your friends (people who you are following).
189 - ``fl @dtvd88`` will follow @dtvd88.
191 - ``ufl @dtvd88`` will unfollow @dtvd88.
193 - ``mute @dtvd88`` will mute @dtvd88.
195 - ``unmute @dtvd88`` will unmute @dtvd88.
197 - ``muting`` will list muting users.
199 - ``block @dtvd88`` will block @dtvd88.
201 - ``unblock @dtvd88`` will unblock @dtvd88.
203 - ``report @dtvd88`` will report @dtvd88 as a spam account.
207 - ``list`` will show all lists you are belong to.
209 - ``list home`` will show timeline of list. You will be asked for list's name.
211 - ``list all_mem`` will show list's all members.
213 - ``list all_sub`` will show list's all subscribers.
215 - ``list add`` will add specific person to a list owned by you.
217 - ``list rm`` will remove specific person from a list owned by you.
219 - ``list sub`` will subscribe you to a specific list.
221 - ``list unsub`` will unsubscribe you from a specific list.
223 - ``list own`` will show all list owned by you.
225 - ``list new`` will create a new list.
227 - ``list update`` will update a list owned by you.
229 - ``list del`` will delete a list owned by you.
231 **Switching Stream Commands**
233 - ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``
235 - ``switch public #AKB48 -f`` will do exactly as above but will ask you to provide 2 list:
237 ``Only nicks`` decide what nicks will be include only.
239 ``Ignore nicks``\ decide what nicks will be exclude.
241 - ``switch mine`` will switch current stream to personal stream. ``-f`` will work as well.
243 - ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.
247 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
249 + ``142857*2`` or ``101**3`` like a calculator.
250 + Even ``cal`` will show the calendar for current month.
251 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
253 **Config Management**
255 - ``theme`` will list available themes.
257 + ``theme monokai`` will apply *monokai* theme immediately.
258 + Changed theme will be remember as the next time's default theme.
260 - ``config`` will list all config key.
262 + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.
263 + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.
264 + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.
265 + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.
267 **Screening Commands**
269 - ``h`` will show the help.
271 - ``p`` will pause the stream.
273 - ``r`` will unpause the stream.
275 - ``c`` will clear the screen.
277 - ``v`` will show version info.
284 Rainbow Stream is shipped with some default themes.
285 You can either change theme by ``theme`` command or create your favorite one.
291 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
296 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
301 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
306 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
309 For detaile information, see `theme usage and customization`_.
314 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.
316 You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
318 - ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.
320 - ``IMAGE_ON_TERM``: display tweet's image directly on terminal.
322 - ``THEME``: current theme.
324 - ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
326 - ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.
328 - ``PREFIX``: display formated string of prompt.
330 + ``#me``: Your username with '@', only available in personal stream.
331 + ``#place``: List name, only available in list stream.
332 + ``#owner``: Owner of list name, only available in list stream.
333 + ``#keyword``: Keyword, only available on public stream.
335 - ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').
337 - ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
339 - ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
341 - ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
343 - ``CONVERSATION_MAX``: max tweet in a 'conversation' thread.
345 - ``QUOTE_FORMAT``: format when quote a tweet
347 + ``#comment``: Your own comment about the tweet
348 + ``#owner``: owner's username with '@'
349 + ``#tweet``: original tweet
351 - ``THREAD_META_LEFT``: format for meta information of messages from partner which is display in the left of screen.
353 - ``THREAD_META_RIGHT``: format for meta information of messages from you which is display in the right of screen.
355 - ``THREAD_MIN_WIDTH``: minimum width of a message frame.
357 - ``NOTIFY_FORMAT``: format of a notification.
359 - ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
361 - ``TREND_MAX``: default trends to display on 'trend' command.
363 - ``LIST_MAX``: default tweets to display on 'list home' command.
365 - ``ONLY_LIST``: filter list on 'switch' command. Eg: ["@fat","mdo"]
367 - ``IGNORE_LIST``: ignore list on 'switch' command. Eg: ["@fat"]
369 - ``HISTORY_FILENAME``: name of file which stores input history.
371 - ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.
373 - ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.
375 - ``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.
377 - ``USER_DOMAIN``: user URL of Twitter Streaming API.
379 - ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.
381 - ``SITE_DOMAIN``: site URL of Twitter Streaming API.
383 - ``FORMAT``: display format for tweet and message.
385 + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.
386 + ``DISPLAY``: decide how tweet will be printed.
388 + ``#name``: Twitter's name
389 + ``#nick``: Twitter's screen name
390 + ``#clock``: Datetime
391 + ``#rt_count``: retweets count
392 + ``#fa_count``: favorites count
394 + ``#fav``: favorited symbol
395 + ``#fav``: favorited symbol
396 + ``#tweet``: Tweet's content
397 + ``#sender_name``: Message's sender name
398 + ``#sender_nick``: Message's sender screen name
399 + ``#to``: '>>>' symbol
400 + ``#recipient_name``: Message's recipient name
401 + ``#recipient_nick``: Message's recipient screen name
403 In every format, you can use unicode characters like ``\u2665``.
404 Mac users also can use emoji characters as well (Ex: ``::zap::``).
405 See `Emoji cheatsheet`_ for details.
410 If you want to build a runnable version yourself, follow these simple
413 - `Create your own Twitter Application`_
414 - Get your Twitter application’s API key and secret
415 - Fork github's repo and clone in your system.
416 - Create a file ``consumer.py`` in ```rainbowstream```_ folder with
421 # Consumer information
422 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
423 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
425 - Use pip to install in local
429 # cd to directory which contains setup.py (cloned directory)
430 virtualenv venv # Python3 users: use -p to specify python3
431 source venv/bin/activate
433 which rainbowstream # /this-directory/venv/bin/rainbowstream
434 # Remove ~/.rainbow_oauth if exists
435 rainbowstream # local version of rainbowstream
437 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
438 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
439 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
440 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
441 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
442 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
443 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation
444 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime
445 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
446 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10
447 .. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config
448 .. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/