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
21 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
24 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
25 :alt: rainbowstreamIOT
30 You will need Python 2.7+ and pip.
34 sudo pip install rainbowstream
36 or try with a virtualenv
40 sudo pip install virtualenv # skip if you already have virtualenv
42 source venv/bin/activate # use the brand new virtualenv.
43 pip install rainbowstream
59 I shipped a feature which can display **tweet's images directly on terminal**.
64 rainbowstream -iot # Or rainbowstream --image-on-term
66 In the first time you will be asked for authorization of Rainbow Stream
67 app at Twitter. Just click the “Authorize access” button and paste PIN
68 number to the terminal, the rainbow will start.
73 While your personal stream is continued, you are also ready to tweet,
74 search, reply, retweet… directly from console. Simply type “h” and hit
75 the Enter key to see the help.
77 Input is in interactive mode. It means that you can use arrow key to
78 move up and down history, tab-autocomplete or 2 tab to view available
79 suggestion. Input history from previous run is available as well.
81 Available commands are listed in `Read The Docs`_.
84 ------------------------
86 Rainbow Stream is shipped with some default themes.
87 You can either change theme by ``theme`` command or create your favorite one.
93 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
98 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
103 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png
108 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png
112 For detaile information, see `theme usage and customization`_.
114 Bug and feature requests
115 ------------------------
117 Found a bug or a feature request ?
118 Please `create an issue`_ or contact me at `@dtvd88`_
122 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
123 You will be listed as contributor.
128 Rainbow Stream are released under an MIT License. See LICENSE.txt for
132 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
133 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
134 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
135 .. _@dtvd88: https://twitter.com/dtvd88
136 .. _fork: https://github.com/DTVD/rainbowstream/fork
137 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
138 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
139 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
140 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md