fix setup.py
[rainbowstream.git] / README.md
1 ## Rainbow Stream
2 Terminal-based Twitter Client. 
3 Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
4
5 This 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)
6
7 ## Screenshot
8 ![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png)
9 ![v0.0.2](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS(Image).png)
10
11 ## Install
12 You will need Python 2.7+ and pip.
13
14 ```bash
15 pip install rainbowstream
16 ```
17
18 ## Usage
19 #### The stream
20 Just type
21 ```bash
22 rainbow
23 ```
24 and see your stream.
25
26 In the case you want to see photos directly in terminal, the command is 
27 ```bash
28 rainbow -img 1 # Or rainbow --image 1
29 ```
30
31 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
32 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
33
34 #### The interactive mode
35 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
36 Simply type "h" and hit the Enter key to see the help
37
38 Input 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
40 Here is full list of supported command
41
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*.
52 You 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
58 * ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
59
60 * ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
61
62 * ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
63
64 * ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
65
66 * ```fav 12```will favorite the tweet with *[id=12]*.
67
68 * ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
69
70 * ```del 12```will delete tweet with *[id=12]*.
71
72 * ```ufav 12```will unfavorite tweet with *[id=12]*.
73
74 * ```s #noah```will search the word *'noah'*. Result will come back with highlight.
75
76 * ```fr```will list all friend (You are following people).
77
78 * ```fl```will list all follower.
79
80 * ```h```will show the help.
81
82 * ```c```will clear the screen.
83
84 * ```q```will quit.
85
86 For example see the screenshot above.
87
88 ## Bug Report
89 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) 
90 or contact me at [@dtvd88](https://twitter.com/dtvd88)
91
92 ## License
93 Rainbow Stream are released under an MIT License. See LICENSE.txt for details