Merge pull request #3 from ellisonleao/master
[rainbowstream.git] / README.md
CommitLineData
b8c1f42a 1## Rainbow Stream
169b134d 2
0d631c7a
O
3[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
4[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
1e979485 5
b8c1f42a 6Terminal-based Twitter Client.
07d41d27 7Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
cd300211 8
90630e52 9This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
f5dcec85 10
5fba2a02 11## Showcase
b84845b9 12Screencast:
5fba2a02
O
13https://www.youtube.com/watch?v=tykCvPMJq8s
14<br>
12e072c0 15
5fba2a02 16Screenshot:
577df0e3
O
17![rainbowstream](./screenshot/RainbowStream.png)
18![rainbowstreamIOT](./screenshot/RainbowStreamIOT.png)
91476ec3 19
b04861f5 20
91476ec3 21## Install
52974125 22You will need Python 2.7+ and pip.
c267927c
O
23
24```bash
303f38c9
O
25sudo pip install rainbowstream
26```
27
1dd4a2c9 28or try with a virtualenv
303f38c9 29```bash
1dd4a2c9 30sudo pip install virtualenv # skip if you already have virtualenv
b84845b9 31virtualenv venv
303f38c9 32source venv/bin/activate # use the brand new virtualenv.
52974125 33pip install rainbowstream
c267927c 34```
91476ec3 35
303f38c9 36
91476ec3 37## Usage
f36f4df7
O
38#### The stream
39Just type
91476ec3 40```bash
20ba76f5 41rainbow
91476ec3 42```
f36f4df7
O
43and see your stream.
44
c1fa7c94
O
45I shipped a feature which can display **tweet's images directly on terminal**.
46You can try it with:
acf4d473 47```bash
c1fa7c94 48rainbow -iot # Or rainbow --image-on-term
acf4d473
O
49```
50
9f72f0f5 51In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 52Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 53
f13e64ac 54## Interactive mode
b800b6ef 55
f3177531 56While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1 57Simply type "h" and hit the Enter key to see the help.
f36f4df7 58
f5677fb1 59Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well.
f36f4df7 60
e2c52049
O
61Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) .
62
63## Theme customization
64Rainbow Stream is shipped with some default themes.
65You can either change theme by `theme` command or create your favorite one.
66
b63400a0
O
67Theme's screenshot:
68* Monokai
69![Monokai](./screenshot/themes/Monokai.png)
70* Solarized
71![Solarized](./screenshot/themes/Solarized.png)
72
e2c52049 73For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
72b9e670 74
3aa1d137 75## Bug and feature requests
b84845b9 76Found a bug or a feature request ?
b8c1f42a 77Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
6a26fca1
O
78or contact me at [@dtvd88](https://twitter.com/dtvd88)
79
3aa1d137 80## Contributing
b84845b9
O
81I appreciate any help and support. Feel free to
82[fork](https://github.com/DTVD/rainbowstream/fork)
83and
3aa1d137
O
84[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
85You will be listed as contributor.
86
f5dcec85 87## License
13b5b854 88Rainbow Stream are released under an MIT License. See LICENSE.txt for details