4 .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat
5 :target: https://pypi.python.org/pypi/rainbowstream
7 .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat
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 .
22 You will need Python and pip (2.7.x or 3.x).
26 sudo pip install rainbowstream
27 # Python 3 users: sudo pip3 install rainbowstream
37 # Python 3 users : use -p to specify your Python 3 localtion as below
38 # virtualenv -p /usr/bin/python3 venv
39 source venv/bin/activate
40 pip install rainbowstream
45 If you use Linux, you might need to install the python-dev package if you haven't already.
46 For debian-based distros, these can be installed with
50 sudo apt-get install python-dev
52 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with
53 the ``Pillow`` package installation - a dependency of this app.
54 If you are in this case, I recommend take a look at `Issue #10`_ and let me know if the workaround doesn't work for you.
70 I shipped a feature which can display **tweet's images directly on terminal**.
75 rainbowstream -iot # Or rainbowstream --image-on-term
77 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
78 to enable above feature,
79 change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)
80 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.
81 (see `config management`_ section).
83 In the first time you will be asked for authorization of Rainbow Stream
84 app at Twitter. Just click the “Authorize access” button and paste PIN
85 number to the terminal, the rainbow will start.
90 While your personal stream is continued, you are also ready to tweet,
91 search, reply, retweet… directly from console. Simply type “h” and hit
92 the Enter key to see the help.
94 Input is in interactive mode. It means that you can use arrow key to
95 move up and down history, tab-autocomplete or 2 tab to view available
96 suggestion. Input history from previous run is available as well.
98 Here is full list of supported command:
102 - ``trend`` will show global trending topics. ``trend US`` will show
103 trends in United States while ``trend JP Tokyo`` will show trends in
106 - ``home`` will show your timeline. ``home 10`` will print exactly 10
109 - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
112 - ``whois @dtvd88`` will show profile of @dtvd88.
114 - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
117 - ``s noah`` will search the word *‘noah’*. Result will come back with
118 highlight. Search can be performed with or without hashtag.
122 - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
123 rainbow is god’s promise to noah’*.
125 - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
126 each tweet beside the time.
128 - ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
129 the quote will be cancelled.
131 - ``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.
133 - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
135 - ``fav 12`` will favorite the tweet with *[id=12]*.
137 - ``ufav 12`` will unfavorite tweet with *[id=12]*.
139 - ``del 12`` will delete tweet with *[id=12]*.
141 - ``show image 12`` will show the image in tweet with *[id=12]* in your
144 - ``open 12`` will open url in tweet with *[id=12]* in your
145 OS’s default browser.
147 **Direct Messages Commands**
149 - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
152 - ``sent`` will show sent messages. ``sent 7`` will show newest 7
155 - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
157 - ``trash 5`` will remove message with *[message\_id=5]*
159 **Friends and followers Commands**
161 - ``ls fl`` will list all your followers (people who are following
164 - ``ls fr`` will list all your friends (people who you are following).
166 - ``fl @dtvd88`` will follow @dtvd88.
168 - ``ufl @dtvd88`` will unfollow @dtvd88.
170 - ``mute @dtvd88`` will mute @dtvd88.
172 - ``unmute @dtvd88`` will unmute @dtvd88.
174 - ``muting`` will list muting users.
176 - ``block @dtvd88`` will block @dtvd88.
178 - ``unblock @dtvd88`` will unblock @dtvd88.
180 - ``report @dtvd88`` will report @dtvd88 as a spam account.
184 - ``list`` will show all lists you are belong to.
186 - ``list home`` will show timeline of list. You will be asked for list's name.
188 - ``list all_mem`` will show list's all members.
190 - ``list all_sub`` will show list's all subscribers.
192 - ``list add`` will add specific person to a list owned by you.
194 - ``list rm`` will remove specific person from a list owned by you.
196 - ``list sub`` will subscribe you to a specific list.
198 - ``list unsub`` will unsubscribe you from a specific list.
200 - ``list own`` will show all list owned by you.
202 - ``list new`` will create a new list.
204 - ``list update`` will update a list owned by you.
206 - ``list del`` will delete a list owned by you.
208 **Switching Stream Commands**
210 - ``switch public #AKB48`` will switch current stream to public stream
211 and track keyword ``AKB48``
213 - ``switch public #AKB48 -f`` will do exactly as above but will ask you
216 ``Only nicks`` decide what nicks will be include only.
218 ``Ignore nicks``\ decide what nicks will be exclude.
220 - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
221 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
223 - ``switch mine`` will switch current stream to personal stream. ``-f``
224 and ``-d`` will work as well.
228 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
230 + ``142857*2`` or ``101**3`` like a calculator.
231 + Even ``cal`` will show the calendar for current month.
232 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
234 **Config Management**
236 - ``theme`` will list available themes.
238 + ``theme monokai`` will apply *monokai* theme immediately.
239 + Changed theme will be remember as the next time's default theme.
241 - ``config`` will list all config key.
243 + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.
244 + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.
245 + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.
246 + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.
248 **Screening Commands**
250 - ``h`` will show the help.
252 - ``p`` will pause the stream.
254 - ``r`` will unpause the stream.
256 - ``c`` will clear the screen.
263 Rainbow Stream is shipped with some default themes.
264 You can either change theme by ``theme`` command or create your favorite one.
270 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
275 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
280 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
285 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
288 For detaile information, see `theme usage and customization`_.
293 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.
294 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
296 - ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.
298 - ``IMAGE_ON_TERM``: display tweet's image directly on terminal.
300 - ``THEME``: current theme.
302 - ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
304 - ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.
306 - ``PREFIX``: display string of prompt.
308 - ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
310 - ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
312 - ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
314 - ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
316 - ``TREND_MAX``: default trends to display on 'trend' command.
318 - ``LIST_MAX``: default tweets to display on 'list home' command.
320 - ``ONLY_LIST``: filter list on 'switch' command.
322 - ``IGNORE_LIST``: ignore list on 'switch' command.
324 - ``HISTORY_FILENAME``: name of file which stores input history.
326 - ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.
328 - ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.
330 - ``USER_DOMAIN``: user URL of Twitter Streaming API.
332 - ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.
334 - ``SITE_DOMAIN``: site URL of Twitter Streaming API.
336 - ``FORMAT``: display format for tweet and message.
338 + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.
339 + ``DISPLAY``: decide how tweet will be printed.
341 + ``#name``: Twitter's name
342 + ``#nick``: Twitter's screen name
343 + ``#clock``: Datetime
344 + ``#rt_count``: retweets count
345 + ``#fa_count``: favorites count
347 + ``#fav``: favorited symbol
348 + ``#fav``: favorited symbol
349 + ``#tweet``: Tweet's content
350 + ``#sender_name``: Message's sender name
351 + ``#sender_nick``: Message's sender screen name
352 + ``#to``: '>>>' symbol
353 + ``#recipient_name``: Message's recipient name
354 + ``#recipient_nick``: Message's recipient screen name
360 If you want to build a runnable version yourself, follow these simple
363 - `Create your own Twitter Application`_
364 - Get your Twitter application’s API key and secret
365 - Fork github's repo and clone in your system.
366 - Create a file ``consumer.py`` in ```rainbowstream```_ folder with
371 # Consumer information
372 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
373 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
375 - Use pip to install in local
379 # cd to directory which contains setup.py (cloned directory)
380 virtualenv venv # Python3 users: use -p to specify python3
381 source venv/bin/activate
383 which rainbowstream # /this-directory/venv/bin/rainbowstream
384 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
385 # Remove ~/.rainbow_oauth if exists
386 rainbowstream # local version of rainbowstream
388 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
389 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
390 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
391 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
392 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
393 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
394 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation
395 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime
396 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
397 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10