syntax check
[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 ```bash
35 rainbow
36 ```
37 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
38 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
39
40 While the rainbow stream is continued, you can search, reply, retweet, tweet directly from terminal ...
41 Type 'h' to view full help or use TAB auto-completion to see what is available. 
42
43
44 ## License
45 Rainbow Stream are released under an MIT License. See LICENSE.txt for details