Update README.md
[rainbowstream.git] / README.md
CommitLineData
91476ec3 1## Rainbow Stream
07d41d27
O
2Terminal-based Twitter Client.
3Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
cd300211
O
4
5This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) and inspired by [EarthQuake](https://github.com/jugyo/earthquake)
f5dcec85
O
6
7## Screenshot
7cf379e9
O
8![v0.0.1](./screenshot/RainbowStream.png)
9![v0.0.3](./screenshot/RainbowStreamIOT.png)
91476ec3
O
10
11## Install
52974125 12You will need Python 2.7+ and pip.
c267927c
O
13
14```bash
52974125 15pip install rainbowstream
c267927c 16```
91476ec3
O
17
18## Usage
f36f4df7
O
19#### The stream
20Just type
91476ec3 21```bash
20ba76f5 22rainbow
91476ec3 23```
f36f4df7
O
24and see your stream.
25
c1fa7c94
O
26I shipped a feature which can display **tweet's images directly on terminal**.
27You can try it with:
acf4d473 28```bash
c1fa7c94 29rainbow -iot # Or rainbow --image-on-term
acf4d473
O
30```
31
9f72f0f5 32In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 33Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 34
f36f4df7 35#### The interactive mode
f3177531 36While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1 37Simply type "h" and hit the Enter key to see the help.
f36f4df7 38
f5677fb1 39Input 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
O
40
41Here is full list of supported command
42
f4ffe56b
O
43__Stream Command__
44* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
45
46* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
47
48 ```Only nicks``` decide what nicks will be include only.
49
50 ```Ignore nicks```decide what nicks will be exclude.
51
52* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
53You can setup 2 list above at ```config.py```
54
55* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
56
57__Action Command__
58
aeacba5f 59* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
f36f4df7 60
aeacba5f 61* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
f36f4df7 62
aeacba5f 63* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
f36f4df7 64
da4e013a 65* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
c7ef0402 66
a1c246e6
O
67* ```fav 12```will favorite the tweet with *[id=12]*.
68
aeacba5f 69* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
f36f4df7 70
a1c246e6
O
71* ```del 12```will delete tweet with *[id=12]*.
72
73* ```ufav 12```will unfavorite tweet with *[id=12]*.
f36f4df7 74
aeacba5f 75* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
f36f4df7 76
f5677fb1 77* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
f36f4df7 78
f5677fb1
O
79* ```fl @dtvd88```will follow @dtvd88.
80
81* ```ufl @dtvd88```will unfollow @dtvd88.
f36f4df7 82
da4e013a 83* ```h```will show the help.
f36f4df7 84
da4e013a 85* ```c```will clear the screen.
f36f4df7 86
da4e013a 87* ```q```will quit.
7b2f82ad 88
72b9e670
O
89For example see the screenshot above.
90
6a26fca1
O
91## Bug Report
92Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
93or contact me at [@dtvd88](https://twitter.com/dtvd88)
94
f5dcec85 95## License
13b5b854 96Rainbow Stream are released under an MIT License. See LICENSE.txt for details