3b54b3987bbe18c754ccb0d4c704daa1038c0655
[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/RainbowStreamv0.0.1.png)
10
11 ## Install
12 **The recommened way:**
13 * Clone this repo
14 * Create virtualenv (optional but recommended)
15 * Install dependencies
16 * Install the package itself
17
18 ```bash
19 git clone https://github.com/DTVD/rainbowstream.git
20 cd rainbowstream
21 virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
22 source venv/bin/activate
23 pip install -e .
24 ```
25 **The quick way:**
26 * Install everything over the air
27
28 ```bash
29 sudo pip install git+https://github.com/DTVD/rainbowstream.git
30 ```
31 **Note the I only support Python version 2.7+**
32
33 ## Usage
34 #### The stream
35 Just type
36 ```bash
37 rainbow
38 ```
39 and see your stream.
40
41 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
42 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
43
44 #### The interactive mode
45 While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
46 Simply hit Enter key and type "h" to view the help
47
48 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
49
50 Here is full list of supported command
51
52 ```bash
53 [@dtvd88]home 
54 ```
55 Show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
56
57 ```bash
58 [@dtvd88]view @mdo 
59 ```
60 Show @mdo 's timeline.
61
62 ```bash
63 [@dtvd88]t the rainbow is god's promise to noah
64 ```
65 Tweet exactly 'the rainbow is god's promise to noah'
66
67 ```bash
68 [@dtvd88]rt 1
69 ```
70 Retweet the tweet with [id=1]. You can see id of each tweet beside the time.
71
72 ```bash
73 [@dtvd88]rep 1 Really
74 ```
75 Reply 'Really' to the tweet with [id=1].
76
77 ```bash
78 [@dtvd88]del 1
79 ```
80 Delete thw tweet with [id=1].
81
82 ```bash
83 [@dtvd88]s #noah
84 ```
85 Search the word 'noah'. Result will come back with highlight.
86
87 ```bash
88 [@dtvd88]fr
89 ```
90 List all friend (You are following people).
91
92 ```bash
93 [@dtvd88]fl
94 ```
95 List all follower.
96
97 ```bash
98 [@dtvd88]h
99 ```
100 SHow the help.
101
102 ```bash
103 [@dtvd88]c
104 ```
105 Clear the screen.
106
107
108 ```bash
109 [@dtvd88]q
110 ```
111 Quit.
112
113 For example see the screenshot above.
114
115 ## License
116 Rainbow Stream are released under an MIT License. See LICENSE.txt for details