Update README.md
[rainbowstream.git] / README.md
... / ...
CommitLineData
1## Rainbow Stream
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.
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)
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
19git clone https://github.com/DTVD/rainbowstream.git
20cd rainbowstream
21virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
22source venv/bin/activate
23pip install -e .
24```
25**The quick way:**
26* Install everything over the air
27
28```bash
29sudo 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
35Just type
36```bash
37rainbow
38```
39and see your stream.
40
41In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
42Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
43
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
52```bash
53[@dtvd88]home
54```
55Show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'.
56
57```bash
58[@dtvd88]view @mdo
59```
60Show @mdo 's timeline.
61
62```bash
63[@dtvd88]t the rainbow is god's promise to noah
64```
65Tweet exactly 'the rainbow is god's promise to noah'
66
67```bash
68[@dtvd88]rt 1
69```
70Retweet the tweet with [id=1]. You can see id of each tweet beside the time.
71
72```bash
73[@dtvd88]rep 1 Really
74```
75Reply 'Really' to the tweet with [id=1].
76
77```bash
78[@dtvd88]del 1
79```
80Delete thw tweet with [id=1].
81
82```bash
83[@dtvd88]s #noah
84```
85Search the word 'noah'. Result will come back with highlight.
86
87```bash
88[@dtvd88]fr
89```
90List all friend (You are following people).
91
92```bash
93[@dtvd88]fl
94```
95List all follower.
96
97```bash
98[@dtvd88]h
99```
100SHow the help.
101
102```bash
103[@dtvd88]c
104```
105Clear the screen.
106
107
108```bash
109[@dtvd88]q
110```
111Quit.
112
113## License
114Rainbow Stream are released under an MIT License. See LICENSE.txt for details