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 .
19 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
21 Screenshot: (click to see)
23 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png
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 localtion as below
49 # virtualenv -p /usr/bin/python3 venv
50 source venv/bin/activate
51 pip install rainbowstream
68 I shipped a feature which can display **tweet's images directly on terminal**.
73 rainbowstream -iot # Or rainbowstream --image-on-term
75 In the first time you will be asked for authorization of Rainbow Stream
76 app at Twitter. Just click the “Authorize access” button and paste PIN
77 number to the terminal, the rainbow will start.
82 While your personal stream is continued, you are also ready to tweet,
83 search, reply, retweet… directly from console. Simply type “h” and hit
84 the Enter key to see the help.
86 Input is in interactive mode. It means that you can use arrow key to
87 move up and down history, tab-autocomplete or 2 tab to view available
88 suggestion. Input history from previous run is available as well.
90 Available commands are listed in `Read The Docs`_.
93 ------------------------
95 Rainbow Stream is shipped with some default themes.
96 You can either change theme by ``theme`` command or create your favorite one.
102 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
107 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
112 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
117 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
121 For detaile information, see `theme usage and customization`_.
123 Bug and feature requests
124 ------------------------
126 Found a bug or a feature request ?
127 Please `create an issue`_ or contact me at `@dtvd88`_
132 If you want to build a runnable version yourself, follow these simple
135 - `Create your own Twitter Application`_
136 - Get your Twitter application’s API key and secret
137 - Fork this repo and clone in your system.
138 - Create a file ``consumer.py`` in `rainbowstream`_ folder with
143 # Consumer information
144 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
145 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
147 - Use pip to install in local
151 # cd to directory which contains setup.py (cloned directory)
152 virtualenv venv # Python3 users: use -p to specify python3
153 source venv/bin/activate
155 which rainbowstream # /this-directory/venv/bin/rainbowstream
156 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)
157 # Remove ~/.rainbow_oauth if exists
158 rainbowstream # local version of rainbowstream
163 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
164 You will be listed as contributor.
169 Rainbow Stream are released under an MIT License. See LICENSE.txt for
173 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
174 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
175 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
176 .. _@dtvd88: https://twitter.com/dtvd88
177 .. _fork: https://github.com/DTVD/rainbowstream/fork
178 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
179 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
180 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
181 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md
182 .. _Create your own Twitter Application: https://apps.twitter.com/app/new
183 .. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream
184 .. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/