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