Update README.md
[rainbowstream.git] / README.md
CommitLineData
169b134d
O
1## Rainbow Stream
2
1e979485
O
3[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
4[![Version](http://img.shields.io/pypi/v/rainbowstream.svg)](https://pypi.python.org/pypi/rainbowstream/0.0.3)
5
07d41d27
O
6Terminal-based Twitter Client.
7Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
cd300211
O
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)
f5dcec85
O
10
11## Screenshot
7cf379e9
O
12![v0.0.1](./screenshot/RainbowStream.png)
13![v0.0.3](./screenshot/RainbowStreamIOT.png)
91476ec3
O
14
15## Install
52974125 16You will need Python 2.7+ and pip.
c267927c
O
17
18```bash
52974125 19pip install rainbowstream
c267927c 20```
91476ec3
O
21
22## Usage
f36f4df7
O
23#### The stream
24Just type
91476ec3 25```bash
20ba76f5 26rainbow
91476ec3 27```
f36f4df7
O
28and see your stream.
29
c1fa7c94
O
30I shipped a feature which can display **tweet's images directly on terminal**.
31You can try it with:
acf4d473 32```bash
c1fa7c94 33rainbow -iot # Or rainbow --image-on-term
acf4d473
O
34```
35
9f72f0f5 36In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 37Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 38
f36f4df7 39#### The interactive mode
f3177531 40While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1 41Simply type "h" and hit the Enter key to see the help.
f36f4df7 42
f5677fb1 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.
f36f4df7
O
44
45Here is full list of supported command
46
f4ffe56b
O
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
aeacba5f 63* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
f36f4df7 64
aeacba5f 65* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
f36f4df7 66
aeacba5f 67* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
f36f4df7 68
da4e013a 69* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
c7ef0402 70
a1c246e6
O
71* ```fav 12```will favorite the tweet with *[id=12]*.
72
aeacba5f 73* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
f36f4df7 74
a1c246e6
O
75* ```del 12```will delete tweet with *[id=12]*.
76
77* ```ufav 12```will unfavorite tweet with *[id=12]*.
f36f4df7 78
aeacba5f 79* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
f36f4df7 80
f5677fb1 81* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.
f36f4df7 82
f5677fb1
O
83* ```fl @dtvd88```will follow @dtvd88.
84
85* ```ufl @dtvd88```will unfollow @dtvd88.
f36f4df7 86
da4e013a 87* ```h```will show the help.
f36f4df7 88
da4e013a 89* ```c```will clear the screen.
f36f4df7 90
da4e013a 91* ```q```will quit.
7b2f82ad 92
72b9e670
O
93For example see the screenshot above.
94
6a26fca1
O
95## Bug Report
96Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
97or contact me at [@dtvd88](https://twitter.com/dtvd88)
98
f5dcec85 99## License
13b5b854 100Rainbow Stream are released under an MIT License. See LICENSE.txt for details