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