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`_.
21 You will need Python and pip (2.7.x or 3.x).
25 sudo pip install rainbowstream
26 # Python 3 users: sudo pip3 install rainbowstream
36 # Python 3 users : use -p to specify your Python 3 localtion as below
37 # virtualenv -p /usr/bin/python3 venv
38 source venv/bin/activate
39 pip install rainbowstream
56 I shipped a feature which can display **tweet's images directly on terminal**.
61 rainbowstream -iot # Or rainbowstream --image-on-term
63 In the first time you will be asked for authorization of Rainbow Stream
64 app at Twitter. Just click the “Authorize access” button and paste PIN
65 number to the terminal, the rainbow will start.
70 While your personal stream is continued, you are also ready to tweet,
71 search, reply, retweet… directly from console. Simply type “h” and hit
72 the Enter key to see the help.
74 Input is in interactive mode. It means that you can use arrow key to
75 move up and down history, tab-autocomplete or 2 tab to view available
76 suggestion. Input history from previous run is available as well.
78 Here is full list of supported command:
82 - ``trend`` will show global trending topics. ``trend US`` will show
83 trends in United States while ``trend JP Tokyo`` will show trends in
86 - ``home`` will show your timeline. ``home 10`` will print exactly 10
89 - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7
92 - ``whois @dtvd88`` will show profile of @dtvd88.
94 - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
97 - ``s #noah`` will search the word *‘noah’*. Result will come back with
102 - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
103 rainbow is god’s promise to noah’*.
105 - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
106 each tweet beside the time.
108 - ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,
109 the quote will be cancelled.
111 - ``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.
113 - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
115 - ``fav 12`` will favorite the tweet with *[id=12]*.
117 - ``ufav 12`` will unfavorite tweet with *[id=12]*.
119 - ``del 12`` will delete tweet with *[id=12]*.
121 - ``show image 12`` will show the image in tweet with *[id=12]* in your
124 - ``open 12`` will open url in tweet with *[id=12]* in your
125 OS’s default browser.
127 **Direct Messages Commands**
129 - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7
132 - ``sent`` will show sent messages. ``sent 7`` will show newest 7
135 - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
137 - ``trash 5`` will remove message with *[message\_id=5]*
139 **Friends and followers Commands**
141 - ``ls fl`` will list all your followers (people who are following
144 - ``ls fr`` will list all your friends (people who you are following).
146 - ``fl @dtvd88`` will follow @dtvd88.
148 - ``ufl @dtvd88`` will unfollow @dtvd88.
150 - ``mute @dtvd88`` will mute @dtvd88.
152 - ``unmute @dtvd88`` will unmute @dtvd88.
154 - ``muting`` will list muting users.
156 - ``block @dtvd88`` will block @dtvd88.
158 - ``unblock @dtvd88`` will unblock @dtvd88.
160 - ``report @dtvd88`` will report @dtvd88 as a spam account.
164 - ``list`` will show all lists you are belong to.
166 - ``list home`` will show timeline of list. You will be asked for list's name.
168 - ``list all_mem`` will show list's all members.
170 - ``list all_sub`` will show list's all subscribers.
172 - ``list add`` will add specific person to a list owned by you.
174 - ``list rm`` will remove specific person from a list owned by you.
176 - ``list sub`` will subscribe you to a specific list.
178 - ``list unsub`` will unsubscribe you from a specific list.
180 - ``list own`` will show all list owned by you.
182 - ``list new`` will create a new list.
184 - ``list update`` will update a list owned by you.
186 - ``list del`` will delete a list owned by you.
188 **Switching Stream Commands**
190 - ``switch public #AKB48`` will switch current stream to public stream
191 and track keyword ``AKB48``
193 - ``switch public #AKB48 -f`` will do exactly as above but will ask you
196 ``Only nicks`` decide what nicks will be include only.
198 ``Ignore nicks``\ decide what nicks will be exclude.
200 - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
201 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
203 - ``switch mine`` will switch current stream to personal stream. ``-f``
204 and ``-d`` will work as well.
208 - Put anything to terminal, the app will try to eval and display result as a python interactive shell.
210 + ``142857*2`` or ``101**3`` like a calculator.
211 + Even ``cal`` will show the calendar for current month.
212 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)
214 **Screening Commands**
216 - ``theme`` will list available themes.
218 + ``theme monokai`` will apply *monokai* theme immedaitely.
219 + ``theme current_as_default`` will remember current theme as next time default.
221 - ``h`` will show the help.
223 - ``c`` will clear the screen.
227 Available commands are listed in `Read The Docs`_.
232 Rainbow Stream is shipped with some default themes.
233 You can either change theme by ``theme`` command or create your favorite one.
239 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
244 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
249 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
254 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
257 For detaile information, see `theme usage and customization`_.
262 If you want to build a runnable version yourself, follow these simple
265 - `Create your own Twitter Application`_
266 - Get your Twitter application’s API key and secret
268 - Create a file ``consumer.py`` in ```rainbowstream```_ folder with
273 # Consumer information
274 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
275 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
277 - Use pip to install in local
281 # cd to directory which contains setup.py
282 virtualenv venv # Python3 users: use -p to specify python3
283 source venv/bin/activate
285 pip list | grep rainbowstream # confirm installed version
286 rainbowstream # local version of rainbowstream
288 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
289 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
290 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
291 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
292 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
293 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/