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