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
96bea951
O
8![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/develop/screenshot/RainbowStreamvSS.png)
9![v0.0.2](https://raw.githubusercontent.com/DTVD/rainbowstream/develop/screenshot/RainbowStreamvSS(Image).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
acf4d473
O
26In the case you want to see photos directly in terminal, the command is
27```bash
28rainbow -img 1 # or rainbow --image 1
29```
30
9f72f0f5 31In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 32Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 33
f36f4df7 34#### The interactive mode
f3177531
O
35While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
36Simply type "h" and hit the Enter key to see the help
f36f4df7
O
37
38Input 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
39
40Here is full list of supported command
41
f4ffe56b
O
42__Stream Command__
43* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
44
45* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
46
47 ```Only nicks``` decide what nicks will be include only.
48
49 ```Ignore nicks```decide what nicks will be exclude.
50
51* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
52You can setup 2 list above at ```config.py```
53
54* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
55
56__Action Command__
57
aeacba5f 58* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
f36f4df7 59
aeacba5f 60* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
f36f4df7 61
aeacba5f 62* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
f36f4df7 63
da4e013a 64* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
c7ef0402 65
a1c246e6
O
66* ```fav 12```will favorite the tweet with *[id=12]*.
67
aeacba5f 68* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
f36f4df7 69
a1c246e6
O
70* ```del 12```will delete tweet with *[id=12]*.
71
72* ```ufav 12```will unfavorite tweet with *[id=12]*.
f36f4df7 73
aeacba5f 74* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
f36f4df7 75
da4e013a 76* ```fr```will list all friend (You are following people).
f36f4df7 77
da4e013a 78* ```fl```will list all follower.
f36f4df7 79
da4e013a 80* ```h```will show the help.
f36f4df7 81
da4e013a 82* ```c```will clear the screen.
f36f4df7 83
da4e013a 84* ```q```will quit.
7b2f82ad 85
72b9e670
O
86For example see the screenshot above.
87
6a26fca1
O
88## Bug Report
89Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
90or contact me at [@dtvd88](https://twitter.com/dtvd88)
91
f5dcec85 92## License
13b5b854 93Rainbow Stream are released under an MIT License. See LICENSE.txt for details