[rainbowstream.git] / README.md

## Rainbow Stream
This is a Twitter timeline on the terminal, build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming)

## Screenshot
![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)

## Install
*The easy way:*
* Clone this repo
* Create virtualenv (optional but recommended)
* Install dependencies
* Install the package itself

```bash
git clone https://github.com/DTVD/rainbowstream.git
cd rainbowstream
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .
```
*The quick way:*
* Install everything over the air

```bash
pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt
pip install git+https://github.com/DTVD/rainbowstream.git
```
**Note the I only support Python version 2.7+**

## Usage
Let's see the rainbow
```bash
rainbowstream
```

## License
Rainbow Stream are released under an MIT License. See below for details

Copyright (c) 2014 Vu Nhat Minh

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
Commit	Line	Data
	1	## Rainbow Stream
	2	This is a Twitter timeline on the terminal, build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming)
	3
	4	## Screenshot
	5	![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
	6
	7	## Install
	8	The easy way:
	9	* Clone this repo
	10	* Create virtualenv (optional but recommended)
	11	* Install dependencies
	12	* Install the package itself
	13
	14	```bash
	15	git clone https://github.com/DTVD/rainbowstream.git
	16	cd rainbowstream
	17	virtualenv venv
	18	source venv/bin/activate
	19	pip install -r requirements.txt
	20	pip install -e .
	21	```
	22	The quick way:
	23	* Install everything over the air
	24
	25	```bash
	26	pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt
	27	pip install git+https://github.com/DTVD/rainbowstream.git
	28	```
	29	Note the I only support Python version 2.7+
	30
	31	## Usage
	32	Let's see the rainbow
	33	```bash
	34	rainbowstream
	35	```
	36
	37	## License
	38	Rainbow Stream are released under an MIT License. See below for details
	39
	40	Copyright (c) 2014 Vu Nhat Minh
	41
	42	Permission is hereby granted, free of charge, to any person
	43	obtaining a copy of this software and associated documentation
	44	files (the "Software"), to deal in the Software without
	45	restriction, including without limitation the rights to use,
	46	copy, modify, merge, publish, distribute, sublicense, and/or sell
	47	copies of the Software, and to permit persons to whom the
	48	Software is furnished to do so, subject to the following
	49	conditions:
	50
	51	The above copyright notice and this permission notice shall be
	52	included in all copies or substantial portions of the Software.
	53
	54	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	55	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
	56	OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	57	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
	58	HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
	59	WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	60	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	61	OTHER DEALINGS IN THE SOFTWARE.