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