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 In the first time you will be asked for authorization of Rainbow Stream
65 app at Twitter. Just click the “Authorize access” button and paste PIN
66 number to the terminal, the rainbow will start.
71 While your personal stream is continued, you are also ready to tweet,
72 search, reply, retweet… directly from console. Simply type “h” and hit
73 the Enter key to see the help.
75 Input is in interactive mode. It means that you can use arrow key to
76 move up and down history, tab-autocomplete or 2 tab to view available
77 suggestion. Input history from previous run is available as well.
79 Here is full list of supported command:
83 - ``trend`` will show global trending topics. ``trend US`` will show
84 trends in United States while ``trend JP Tokyo`` will show trends in
87 - ``home`` will show your timeline. ``home 10`` will print exactly 10
90 - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
93 - ``whois @dtvd88`` will show profile of @dtvd88.
95 - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
98 - ``s noah`` will search the word *‘noah’*. Result will come back with
99 highlight. Search can be performed with or without hashtag.
103 - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
104 rainbow is god’s promise to noah’*.
106 - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
107 each tweet beside the time.
109 - ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
110 the quote will be cancelled.
112 - ``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.
114 - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
116 - ``fav 12`` will favorite the tweet with *[id=12]*.
118 - ``ufav 12`` will unfavorite tweet with *[id=12]*.
120 - ``del 12`` will delete tweet with *[id=12]*.
122 - ``show image 12`` will show the image in tweet with *[id=12]* in your
125 - ``open 12`` will open url in tweet with *[id=12]* in your
126 OS’s default browser.
128 **Direct Messages Commands**
130 - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
133 - ``sent`` will show sent messages. ``sent 7`` will show newest 7
136 - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
138 - ``trash 5`` will remove message with *[message\_id=5]*
140 **Friends and followers Commands**
142 - ``ls fl`` will list all your followers (people who are following
145 - ``ls fr`` will list all your friends (people who you are following).
147 - ``fl @dtvd88`` will follow @dtvd88.
149 - ``ufl @dtvd88`` will unfollow @dtvd88.
151 - ``mute @dtvd88`` will mute @dtvd88.
153 - ``unmute @dtvd88`` will unmute @dtvd88.
155 - ``muting`` will list muting users.
157 - ``block @dtvd88`` will block @dtvd88.
159 - ``unblock @dtvd88`` will unblock @dtvd88.
161 - ``report @dtvd88`` will report @dtvd88 as a spam account.
165 - ``list`` will show all lists you are belong to.
167 - ``list home`` will show timeline of list. You will be asked for list's name.
169 - ``list all_mem`` will show list's all members.
171 - ``list all_sub`` will show list's all subscribers.
173 - ``list add`` will add specific person to a list owned by you.
175 - ``list rm`` will remove specific person from a list owned by you.
177 - ``list sub`` will subscribe you to a specific list.
179 - ``list unsub`` will unsubscribe you from a specific list.
181 - ``list own`` will show all list owned by you.
183 - ``list new`` will create a new list.
185 - ``list update`` will update a list owned by you.
187 - ``list del`` will delete a list owned by you.
189 **Switching Stream Commands**
191 - ``switch public #AKB48`` will switch current stream to public stream
192 and track keyword ``AKB48``
194 - ``switch public #AKB48 -f`` will do exactly as above but will ask you
197 ``Only nicks`` decide what nicks will be include only.
199 ``Ignore nicks``\ decide what nicks will be exclude.
201 - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
202 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
204 - ``switch mine`` will switch current stream to personal stream. ``-f``
205 and ``-d`` will work as well.
209 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
211 + ``142857*2`` or ``101**3`` like a calculator.
212 + Even ``cal`` will show the calendar for current month.
213 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
217 - ``theme`` will list available themes.
219 + ``theme monokai`` will apply *monokai* theme immedaitely.
220 + ``theme current_as_default`` will remember current theme as next time default.
222 - ``config`` will list all config key.
224 + ``config ASCII_ART`` will output current valut of *ASCII_ART* config key.
225 + ``config ASCII_ART default`` will output default valut of *ASCII_ART* config key.
226 + ``config ASCII_ART = False`` will set valut of *ASCII_ART* config key to *False*.
228 **Screening Commands**
230 - ``h`` will show the help.
232 - ``c`` will clear the screen.
236 Available commands are listed in `Read The Docs`_.
241 Rainbow Stream is shipped with some default themes.
242 You can either change theme by ``theme`` command or create your favorite one.
248 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
253 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
258 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
263 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
266 For detaile information, see `theme usage and customization`_.
271 Rainbow Stream has a config file located at ``~/.rainbow_config.json``.
272 You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).
274 - ``THEME``: current theme.
276 - ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.
278 - ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.
280 - ``HOME_TWEET_NUM``: default tweets to display on 'home' command.
282 - ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.
284 - ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.
286 - ``TREND_MAX``: default trends to display on 'trend' command.
288 - ``LIST_MAX``: default tweets to display on 'list home' command.
290 - ``ONLY_LIST``: filter list on 'switch' command.
292 - ``IGNORE_LIST``: ignore list on 'switch' command.
294 - ``HISTORY_FILENAME``: name of file which stores input history.
296 - ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.
298 - ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.
300 - ``USER_DOMAIN``: user URL of Twitter Streaming API.
302 - ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.
304 - ``SITE_DOMAIN``: site URL of Twitter Streaming API.
309 If you want to build a runnable version yourself, follow these simple
312 - `Create your own Twitter Application`_
313 - Get your Twitter application’s API key and secret
314 - Fork github's repo and clone in your system.
315 - Create a file ``consumer.py`` in ```rainbowstream```_ folder with
320 # Consumer information
321 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
322 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
324 - Use pip to install in local
328 # cd to directory which contains setup.py (cloned directory)
329 virtualenv venv # Python3 users: use -p to specify python3
330 source venv/bin/activate
332 which rainbowstream # /this-directory/venv/bin/rainbowstream
333 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
334 # Remove ~/.rainbow_oauth if exists
335 rainbowstream # local version of rainbowstream
337 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
338 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
339 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
340 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
341 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
342 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/