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
57 I shipped a feature which can display **tweet's images directly on terminal**.
62 rainbowstream -iot # Or rainbowstream --image-on-term
64 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
65 to enable above feature (see `config management`_ section).
67 In the first time you will be asked for authorization of Rainbow Stream
68 app at Twitter. Just click the “Authorize access” button and paste PIN
69 number to the terminal, the rainbow will start.
74 While your personal stream is continued, you are also ready to tweet,
75 search, reply, retweet… directly from console. Simply type “h” and hit
76 the Enter key to see the help.
78 Input is in interactive mode. It means that you can use arrow key to
79 move up and down history, tab-autocomplete or 2 tab to view available
80 suggestion. Input history from previous run is available as well.
82 Here is full list of supported command:
86 - ``trend`` will show global trending topics. ``trend US`` will show
87 trends in United States while ``trend JP Tokyo`` will show trends in
90 - ``home`` will show your timeline. ``home 10`` will print exactly 10
93 - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
96 - ``whois @dtvd88`` will show profile of @dtvd88.
98 - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
101 - ``s noah`` will search the word *‘noah’*. Result will come back with
102 highlight. Search can be performed with or without hashtag.
106 - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
107 rainbow is god’s promise to noah’*.
109 - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
110 each tweet beside the time.
112 - ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
113 the quote will be cancelled.
115 - ``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.
117 - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
119 - ``fav 12`` will favorite the tweet with *[id=12]*.
121 - ``ufav 12`` will unfavorite tweet with *[id=12]*.
123 - ``del 12`` will delete tweet with *[id=12]*.
125 - ``show image 12`` will show the image in tweet with *[id=12]* in your
128 - ``open 12`` will open url in tweet with *[id=12]* in your
129 OS’s default browser.
131 **Direct Messages Commands**
133 - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
136 - ``sent`` will show sent messages. ``sent 7`` will show newest 7
139 - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
141 - ``trash 5`` will remove message with *[message\_id=5]*
143 **Friends and followers Commands**
145 - ``ls fl`` will list all your followers (people who are following
148 - ``ls fr`` will list all your friends (people who you are following).
150 - ``fl @dtvd88`` will follow @dtvd88.
152 - ``ufl @dtvd88`` will unfollow @dtvd88.
154 - ``mute @dtvd88`` will mute @dtvd88.
156 - ``unmute @dtvd88`` will unmute @dtvd88.
158 - ``muting`` will list muting users.
160 - ``block @dtvd88`` will block @dtvd88.
162 - ``unblock @dtvd88`` will unblock @dtvd88.
164 - ``report @dtvd88`` will report @dtvd88 as a spam account.
168 - ``list`` will show all lists you are belong to.
170 - ``list home`` will show timeline of list. You will be asked for list's name.
172 - ``list all_mem`` will show list's all members.
174 - ``list all_sub`` will show list's all subscribers.
176 - ``list add`` will add specific person to a list owned by you.
178 - ``list rm`` will remove specific person from a list owned by you.
180 - ``list sub`` will subscribe you to a specific list.
182 - ``list unsub`` will unsubscribe you from a specific list.
184 - ``list own`` will show all list owned by you.
186 - ``list new`` will create a new list.
188 - ``list update`` will update a list owned by you.
190 - ``list del`` will delete a list owned by you.
192 **Switching Stream Commands**
194 - ``switch public #AKB48`` will switch current stream to public stream
195 and track keyword ``AKB48``
197 - ``switch public #AKB48 -f`` will do exactly as above but will ask you
200 ``Only nicks`` decide what nicks will be include only.
202 ``Ignore nicks``\ decide what nicks will be exclude.
204 - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
205 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
207 - ``switch mine`` will switch current stream to personal stream. ``-f``
208 and ``-d`` will work as well.
212 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
214 + ``142857*2`` or ``101**3`` like a calculator.
215 + Even ``cal`` will show the calendar for current month.
216 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
218 **Config Management**
220 - ``theme`` will list available themes.
222 + ``theme monokai`` will apply *monokai* theme immediately.
223 + Changed theme will be remember as the next time's default theme.
225 - ``config`` will list all config key.
227 + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.
228 + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.
229 + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.
230 + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.
232 **Screening Commands**
234 - ``h`` will show the help.
236 - ``c`` will clear the screen.
240 Available commands are listed in `Read The Docs`_.
245 Rainbow Stream is shipped with some default themes.
246 You can either change theme by ``theme`` command or create your favorite one.
252 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
257 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
262 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
267 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
270 For detaile information, see `theme usage and customization`_.
275 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.
276 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
278 - ``THEME``: current theme.
280 - ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
282 - ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
284 - ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
286 - ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
288 - ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
290 - ``TREND_MAX``: default trends to display on 'trend' command.
292 - ``LIST_MAX``: default tweets to display on 'list home' command.
294 - ``ONLY_LIST``: filter list on 'switch' command.
296 - ``IGNORE_LIST``: ignore list on 'switch' command.
298 - ``HISTORY_FILENAME``: name of file which stores input history.
300 - ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.
302 - ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.
304 - ``USER_DOMAIN``: user URL of Twitter Streaming API.
306 - ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.
308 - ``SITE_DOMAIN``: site URL of Twitter Streaming API.
310 - ``FORMAT``: display format for tweet and message.
312 + `CLOCK_FORMAT`: time format, see `Python's strftime format`_.
313 + `DISPLAY`: decide how tweet will be printed.
315 + `#name`: Twitter's name
316 + `#nick`: Twitter's screen name
319 + `#fav`: favorited symbol
320 + `#tweet`: Tweet's content
321 + `#sender_name`: Message's sender name
322 + `#sender_nick`: Message's sender screen name
323 + `#to`: '>>>' symbol
324 + `#recipient_name`: Message's recipient name
325 + `#recipient_nick`: Message's recipient screen name
331 If you want to build a runnable version yourself, follow these simple
334 - `Create your own Twitter Application`_
335 - Get your Twitter application’s API key and secret
336 - Fork github's repo and clone in your system.
337 - Create a file ``consumer.py`` in ```rainbowstream```_ folder with
342 # Consumer information
343 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
344 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
346 - Use pip to install in local
350 # cd to directory which contains setup.py (cloned directory)
351 virtualenv venv # Python3 users: use -p to specify python3
352 source venv/bin/activate
354 which rainbowstream # /this-directory/venv/bin/rainbowstream
355 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
356 # Remove ~/.rainbow_oauth if exists
357 rainbowstream # local version of rainbowstream
359 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
360 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
361 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
362 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
363 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
364 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
365 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode
366 .. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime