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`_.
17 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
23 You will need Python 2.7+ and pip.
27 sudo pip install rainbowstream
29 or try with a virtualenv
33 sudo pip install virtualenv # skip if you already have virtualenv
35 source venv/bin/activate # use the brand new virtualenv.
36 pip install rainbowstream
52 I shipped a feature which can display **tweet's images directly on terminal**.
57 rainbowstream -iot # Or rainbowstream --image-on-term
59 In the first time you will be asked for authorization of Rainbow Stream
60 app at Twitter. Just click the “Authorize access” button and paste PIN
61 number to the terminal, the rainbow will start.
66 While your personal stream is continued, you are also ready to tweet,
67 search, reply, retweet… directly from console. Simply type “h” and hit
68 the Enter key to see the help.
70 Input is in interactive mode. It means that you can use arrow key to
71 move up and down history, tab-autocomplete or 2 tab to view available
72 suggestion. Input history from previous run is available as well.
74 Available commands are listed in `Read The Docs`_.
77 ------------------------
79 Rainbow Stream is shipped with some default themes.
80 You can either change theme by ``theme`` command or create your favorite one.
86 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
91 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
96 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
101 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
105 For detaile information, see `theme usage and customization`_.
107 Bug and feature requests
108 ------------------------
110 Found a bug or a feature request ?
111 Please `create an issue`_ or contact me at `@dtvd88`_
116 If you want to build a runnable version yourself, follow these simple
119 - `Create your own Twitter Application`_
120 - Get your Twitter application’s API key and secret
122 - Create a file ``consumer.py`` in ```rainbowstream```_ folder with
127 # Consumer information
128 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
129 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
131 - Use pip to install in local
135 # cd to directory which contains setup.py
136 virtualenv venv # Python3 users: use -p to specify python3
137 source venv/bin/activate
139 pip list | grep rainbowstream # confirm installed version
140 rainbowstream # local version of rainbowstream
145 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
146 You will be listed as contributor.
151 Rainbow Stream are released under an MIT License. See LICENSE.txt for
155 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
156 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
157 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
158 .. _@dtvd88: https://twitter.com/dtvd88
159 .. _fork: https://github.com/DTVD/rainbowstream/fork
160 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
161 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
162 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
163 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
164 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
165 .. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream