fix typo
[rainbowstream.git] / README.md
... / ...
CommitLineData
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
6Terminal-based Twitter Client.
7Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
8
9This 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
16You will need Python 2.7+ and pip.
17
18```bash
19pip install rainbowstream
20```
21
22## Usage
23#### The stream
24Just type
25```bash
26rainbow
27```
28and see your stream.
29
30I shipped a feature which can display **tweet's images directly on terminal**.
31You can try it with:
32```bash
33rainbow -iot # Or rainbow --image-on-term
34```
35
36In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
37Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
38
39#### The interactive mode
40While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
41Simply type "h" and hit the Enter key to see the help.
42
43Input 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
45Here 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*.
57You 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 tweet.
64
65* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
66
67* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
68
69* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
70
71* ```fav 12```will favorite the tweet with *[id=12]*.
72
73* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
74
75* ```del 12```will delete tweet with *[id=12]*.
76
77* ```ufav 12```will unfavorite tweet with *[id=12]*.
78
79* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
80
81* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
82
83* ```ls fl```will list all your followers (people who are following you).
84
85* ```ls fr```will list all your friends (people who you are following).
86
87* ```fl @dtvd88```will follow @dtvd88.
88
89* ```ufl @dtvd88```will unfollow @dtvd88.
90
91* ```h```will show the help.
92
93* ```c```will clear the screen.
94
95* ```q```will quit.
96
97For example see the screenshot above.
98
99## Bug Report
100Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
101or contact me at [@dtvd88](https://twitter.com/dtvd88)
102
103## License
104Rainbow Stream are released under an MIT License. See LICENSE.txt for details