search from config
[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
9![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
91476ec3
O
10
11## Install
c7ef0402 12**The recommened way:**
c267927c 13* Clone this repo
f5dcec85 14* Create virtualenv (optional but recommended)
c267927c
O
15* Install dependencies
16* Install the package itself
17
91476ec3 18```bash
c267927c
O
19git clone https://github.com/DTVD/rainbowstream.git
20cd rainbowstream
4ec25373 21virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
f5dcec85 22source venv/bin/activate
91476ec3
O
23pip install -e .
24```
4ec25373 25**The quick way:**
c267927c
O
26* Install everything over the air
27
28```bash
4ec25373 29sudo pip install git+https://github.com/DTVD/rainbowstream.git
c267927c
O
30```
31**Note the I only support Python version 2.7+**
91476ec3
O
32
33## Usage
f36f4df7
O
34#### The stream
35Just type
91476ec3 36```bash
20ba76f5 37rainbow
91476ec3 38```
f36f4df7
O
39and see your stream.
40
9f72f0f5 41In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 42Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 43
f36f4df7
O
44#### The interactive mode
45While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
46Simply hit Enter key and type "h" to view the help
47
48Input 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
49
50Here is full list of supported command
51
da4e013a 52* ```home```will show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
f36f4df7 53
da4e013a 54* ```view @mdo```will show @mdo 's timeline.
f36f4df7 55
da4e013a 56* ```t the rainbow is god's promise to noah```will tweet exactly **'the rainbow is god's promise to noah'**
f36f4df7 57
da4e013a 58* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
c7ef0402 59
da4e013a 60* ```rep 12 Really```will reply **'Really'** to the tweet with *[id=12]*.
f36f4df7 61
da4e013a 62* ```del 12```will delete thw tweet with *[id=12]*.
f36f4df7 63
da4e013a 64* ```s #noah```will search the word **'noah'**. Result will come back with highlight.
f36f4df7 65
da4e013a 66* ```fr```will list all friend (You are following people).
f36f4df7 67
da4e013a 68* ```fl```will list all follower.
f36f4df7 69
da4e013a 70* ```h```will show the help.
f36f4df7 71
da4e013a 72* ```c```will clear the screen.
f36f4df7 73
da4e013a 74* ```q```will quit.
7b2f82ad 75
72b9e670
O
76For example see the screenshot above.
77
6a26fca1
O
78## Bug Report
79Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
80or contact me at [@dtvd88](https://twitter.com/dtvd88)
81
f5dcec85 82## License
13b5b854 83Rainbow Stream are released under an MIT License. See LICENSE.txt for details