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 .
20 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif
29 You will need Python and pip (2.7.x or 3.x).
33 sudo pip install rainbowstream
34 # Python 3 users: sudo pip3 install rainbowstream
45 # Python 3 users : use -p to specify your Python 3 localtion as below
46 # virtualenv -p /usr/bin/python3 venv
47 source venv/bin/activate
48 pip install rainbowstream
53 If you use Linux, you might need to install some packages if you haven't already.
54 For debian-based distros, these can be installed with
58 sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev
60 Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with
61 the ``Pillow`` package installation - a dependency of this app.
62 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.
66 export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future
68 If installation in *the quick way* doesn't work:
70 - ``sudo pip uninstall rainbowstream``
71 - use the *virtualenv way* above
72 - `create an issue`_ and provide:
91 I shipped a feature which can display **tweet's images directly on terminal**.
96 rainbowstream -iot # Or rainbowstream --image-on-term
98 You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app
99 to enable above feature,
100 change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)
101 or ``IMAGE_MAX_HEIGHT`` to control max height of every image.
102 (see `config management`_ section).
104 In the first time you will be asked for authorization of Rainbow Stream
105 app at Twitter. Just click the “Authorize access” button and paste PIN
106 number to the terminal, the rainbow will start.
108 You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are
113 rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP
114 # or using the short form:
115 rainbowstream -ph localhost -pp 1337 -pt HTTP
117 Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default
118 proxy port ``8080`` and default proxy type ``SOCKS5`` are used.
123 While your personal stream is continued, you are also ready to tweet,
124 search, reply, retweet… directly from console. Simply type “h” and hit
125 the Enter key to see the help.
127 Input is in interactive mode. It means that you can use arrow key to
128 move up and down history, tab-autocomplete or 2 tab to view available
129 suggestion. Input history from previous run is available as well.
131 Available commands are listed in `Read The Docs`_.
136 Rainbow Stream is shipped with some default themes.
137 You can either change theme by ``theme`` command or create your favorite one.
143 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
148 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
153 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
158 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
161 For detaile information, see `theme usage and customization`_.
164 Bug and feature requests
165 ------------------------
167 Found a bug or a feature request ?
168 Please `create an issue`_ or contact me at `@dtvd88`_
173 If you want to build a runnable version yourself, follow these simple
176 - `Create your own Twitter Application`_
177 - Get your Twitter application’s API key and secret
178 - Fork this repo and clone in your system.
179 - Create a file ``consumer.py`` in `rainbowstream`_ folder with
184 # Consumer information
185 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
186 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
188 - Use pip to install in local
192 # cd to directory which contains setup.py (cloned directory)
193 virtualenv venv # Python3 users: use -p to specify python3
194 source venv/bin/activate
196 which rainbowstream # /this-directory/venv/bin/rainbowstream
197 # Remove ~/.rainbow_oauth if exists
198 rainbowstream # local version of rainbowstream
203 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
204 You will be listed as contributor.
209 Rainbow Stream are released under an MIT License. See LICENSE.txt for
213 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
214 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
215 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
216 .. _@dtvd88: https://twitter.com/dtvd88
217 .. _fork: https://github.com/DTVD/rainbowstream/fork
218 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
219 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
220 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
221 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
222 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
223 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
224 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/
225 .. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation
226 .. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/
227 .. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10