control prefix
[rainbowstream.git] / README.md
CommitLineData
91476ec3 1## Rainbow Stream
c7ef0402
O
2Terminal-based Twitter Client with Streaming API support.
3Realtime tweetstream, compose, search ... and much more fun directly from terminal.
4Only supports Python 2.7 or later.
cd300211
O
5
6This 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
7
8## Screenshot
1985f23e 9![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png)
91476ec3
O
10
11## Install
cf26c0a3
O
12You will need Python 2.7+ and pip to install
13
c7ef0402 14**The recommened way:**
c267927c 15* Clone this repo
f5dcec85 16* Create virtualenv (optional but recommended)
c267927c
O
17* Install dependencies
18* Install the package itself
19
91476ec3 20```bash
99f13828 21git clone git@github.com:DTVD/rainbowstream.git
c267927c 22cd rainbowstream
4ec25373 23virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
f5dcec85 24source venv/bin/activate
91476ec3
O
25pip install -e .
26```
4ec25373 27**The quick way:**
c267927c
O
28* Install everything over the air
29
30```bash
4ec25373 31sudo pip install git+https://github.com/DTVD/rainbowstream.git
c267927c 32```
91476ec3
O
33
34## Usage
f36f4df7
O
35#### The stream
36Just type
91476ec3 37```bash
20ba76f5 38rainbow
91476ec3 39```
f36f4df7
O
40and see your stream.
41
9f72f0f5 42In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 43Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 44
f36f4df7
O
45#### The interactive mode
46While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
47Simply hit Enter key and type "h" to view the help
48
49Input 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
50
51Here is full list of supported command
52
f4ffe56b
O
53__Stream Command__
54* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
55
56* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
57
58 ```Only nicks``` decide what nicks will be include only.
59
60 ```Ignore nicks```decide what nicks will be exclude.
61
62* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
63You can setup 2 list above at ```config.py```
64
65* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
66
67__Action Command__
68
aeacba5f 69* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
f36f4df7 70
aeacba5f 71* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
f36f4df7 72
aeacba5f 73* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
f36f4df7 74
da4e013a 75* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
c7ef0402 76
aeacba5f 77* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
f36f4df7 78
da4e013a 79* ```del 12```will delete thw tweet with *[id=12]*.
f36f4df7 80
aeacba5f 81* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
f36f4df7 82
da4e013a 83* ```fr```will list all friend (You are following people).
f36f4df7 84
da4e013a 85* ```fl```will list all follower.
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