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
23 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif
32 You will need Python and pip (2.7.x or 3.x).
36 sudo pip install rainbowstream
37 # Python 3 users: sudo pip3 install rainbowstream
48 # Python 3 users : use -p to specify your Python 3 location as below
49 # virtualenv -p /usr/bin/python3 venv
50 source venv/bin/activate
51 pip install rainbowstream
56 If you use Linux, you might need to install some packages if you haven't already.
57 For debian-based distros, these can be installed with
61 sudo apt-get install python-dev libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev
67 sudo yum install python-devel libjpeg-devel
69 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with
70 the ``Pillow`` package installation - a dependency of this app.
71 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.
75 export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future
77 If installation in *the quick way* doesn't work:
79 - ``sudo pip uninstall rainbowstream``
80 - use the *virtualenv way* above
81 - `create an issue`_ and provide:
100 I shipped a feature which can display **tweet's images directly on terminal**.
105 rainbowstream -iot # Or rainbowstream --image-on-term
107 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
108 to enable above feature,
109 change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)
110 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.
111 (see `config management`_ section).
113 In the first time you will be asked for authorization of Rainbow Stream
114 app at Twitter. Just click the “Authorize access” button and paste PIN
115 number to the terminal, the rainbow will start.
117 You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are
122 rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP
123 # or using the short form:
124 rainbowstream -ph localhost -pp 1337 -pt HTTP
126 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default
127 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.
132 While your personal stream is continued, you are also ready to tweet,
133 search, reply, retweet… directly from console. Simply type “h” and hit
134 the Enter key to see the help.
136 Input is in interactive mode. It means that you can use arrow key to
137 move up and down history, tab-autocomplete or 2 tab to view available
138 suggestion. Input history from previous run is available as well.
140 Available commands are listed in `Read The Docs`_.
145 Rainbow Stream is shipped with some default themes.
146 You can either change theme by ``theme`` command or create your favorite one.
152 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
157 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
162 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
167 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
170 For detail information, see `theme usage and customization`_.
173 Bug and feature requests
174 ------------------------
176 Found a bug or a feature request ?
177 Please `create an issue`_ or contact me at `@dtvd88`_
182 If you want to build a runnable version yourself, follow these simple
185 - `Create your own Twitter Application`_
186 - Get your Twitter application’s API key and secret
187 - Fork this repo and clone in your system.
188 - Create a file ``consumer.py`` in `rainbowstream`_ folder with
193 # Consumer information
194 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
195 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
197 - Use pip to install in local
201 # cd to directory which contains setup.py (cloned directory)
202 virtualenv venv # Python3 users: use -p to specify python3
203 source venv/bin/activate
205 which rainbowstream # /this-directory/venv/bin/rainbowstream
206 # Remove ~/.rainbow_oauth if exists
207 rainbowstream # local version of rainbowstream
212 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
213 You will be listed as contributor.
218 Rainbow Stream are released under an MIT License. See LICENSE.txt for
222 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
223 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
224 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
225 .. _@dtvd88: https://twitter.com/dtvd88
226 .. _fork: https://github.com/DTVD/rainbowstream/fork
227 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
228 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
229 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
230 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
231 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
232 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
233 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
234 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation
235 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
236 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10