Merge branch 'master' of github.com:DTVD/rainbowstream
[rainbowstream.git] / README.md
CommitLineData
91476ec3 1## Rainbow Stream
cd300211
O
2Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.
3
4This 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
5
6## Screenshot
7![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
91476ec3
O
8
9## Install
4ec25373 10**The easy way:**
c267927c 11* Clone this repo
f5dcec85 12* Create virtualenv (optional but recommended)
c267927c
O
13* Install dependencies
14* Install the package itself
15
91476ec3 16```bash
c267927c
O
17git clone https://github.com/DTVD/rainbowstream.git
18cd rainbowstream
4ec25373 19virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv"
f5dcec85 20source venv/bin/activate
91476ec3
O
21pip install -e .
22```
4ec25373 23**The quick way:**
c267927c
O
24* Install everything over the air
25
26```bash
4ec25373 27sudo pip install git+https://github.com/DTVD/rainbowstream.git
c267927c
O
28```
29**Note the I only support Python version 2.7+**
91476ec3
O
30
31## Usage
32```bash
33rainbowstream
34```
9f72f0f5
O
35In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
36
4e2680f6 37Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 38
f5dcec85 39## License
13b5b854 40Rainbow Stream are released under an MIT License. See LICENSE.txt for details