Update README.md
[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
040cec23 16Screenshot: (Click to see)
509cd4ae 17![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png)
b04861f5 18
91476ec3 19## Install
52974125 20You will need Python 2.7+ and pip.
c267927c
O
21
22```bash
303f38c9
O
23sudo pip install rainbowstream
24```
25
1dd4a2c9 26or try with a virtualenv
303f38c9 27```bash
1dd4a2c9 28sudo pip install virtualenv # skip if you already have virtualenv
b84845b9 29virtualenv venv
303f38c9 30source venv/bin/activate # use the brand new virtualenv.
52974125 31pip install rainbowstream
c267927c 32```
91476ec3 33
303f38c9 34
91476ec3 35## Usage
f36f4df7
O
36#### The stream
37Just type
91476ec3 38```bash
67339c79 39rainbowstream
91476ec3 40```
f36f4df7
O
41and see your stream.
42
c1fa7c94
O
43I shipped a feature which can display **tweet's images directly on terminal**.
44You can try it with:
acf4d473 45```bash
67339c79 46rainbowstream -iot # Or rainbowstream --image-on-term
acf4d473
O
47```
48
9f72f0f5 49In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 50Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 51
f13e64ac 52## Interactive mode
b800b6ef 53
f3177531 54While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1 55Simply type "h" and hit the Enter key to see the help.
f36f4df7 56
f5677fb1 57Input 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 58
e2c52049
O
59Available commands are listed in [Read The Docs](http://rainbowstream.readthedocs.org/en/latest/) .
60
61## Theme customization
06302419 62Rainbow Stream is shipped with some default themes.
e2c52049
O
63You can either change theme by `theme` command or create your favorite one.
64
06302419 65Theme's screenshot:
b63400a0
O
66* Monokai
67![Monokai](./screenshot/themes/Monokai.png)
68* Solarized
69![Solarized](./screenshot/themes/Solarized.png)
80182490
O
70* Tomorrow Night
71![Solarized](./screenshot/themes/TomorrowNight.png)
72* Larapaste
73![Solarized](./screenshot/themes/larapaste.png)
b63400a0 74
e2c52049 75For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
72b9e670 76
3aa1d137 77## Bug and feature requests
b84845b9 78Found a bug or a feature request ?
b8c1f42a 79Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
6a26fca1
O
80or contact me at [@dtvd88](https://twitter.com/dtvd88)
81
d215820b
O
82## Development
83If you want to build a runnable version yourself, follow these simple steps
84* [Create your own Twitter Application](https://apps.twitter.com/app/new)
85* Get your Twitter application's API key and secret
86* Fork this repo
791035e0 87* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with folowwing content.
d215820b
O
88```python
89# Consumer information
90CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
91CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
92```
93* Use pip to install in local
94```bash
95# cd to directory which contains setup.py
96pip install -e .
97pip list # confirm installed version
98rainbowstream # Local version of rainbowstream
99```
100
3aa1d137 101## Contributing
b84845b9
O
102I appreciate any help and support. Feel free to
103[fork](https://github.com/DTVD/rainbowstream/fork)
104and
3aa1d137
O
105[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
106You will be listed as contributor.
107
f5dcec85 108## License
13b5b854 109Rainbow Stream are released under an MIT License. See LICENSE.txt for details