redefine color and use seperate Twitter Oauth credential
[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
c267927c
O
10*The easy way:*
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
f5dcec85
O
19virtualenv venv
20source venv/bin/activate
c267927c 21pip install -r requirements.txt
91476ec3
O
22pip install -e .
23```
c267927c
O
24*The quick way:*
25* Install everything over the air
26
27```bash
28pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt
29pip install git+https://github.com/DTVD/rainbowstream.git
30```
31**Note the I only support Python version 2.7+**
91476ec3
O
32
33## Usage
c267927c 34Let's see the rainbow
91476ec3
O
35```bash
36rainbowstream
37```
38
f5dcec85
O
39## License
40Rainbow Stream are released under an MIT License. See below for details
91476ec3 41
f5dcec85 42Copyright (c) 2014 Vu Nhat Minh
91476ec3 43
f5dcec85
O
44Permission is hereby granted, free of charge, to any person
45obtaining a copy of this software and associated documentation
46files (the "Software"), to deal in the Software without
47restriction, including without limitation the rights to use,
48copy, modify, merge, publish, distribute, sublicense, and/or sell
49copies of the Software, and to permit persons to whom the
50Software is furnished to do so, subject to the following
51conditions:
52
53The above copyright notice and this permission notice shall be
54included in all copies or substantial portions of the Software.
55
56THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
57EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
58OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
59NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
60HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
61WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
62FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
63OTHER DEALINGS IN THE SOFTWARE.