[rainbowstream.git] / README.md

## Rainbow Stream
Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.

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)

## 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
```bash
rainbowstream
```
In the first time you will be asked for authorization of Rainbow Stream app at Twitter.

Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.

## 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	Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later.
	3
	4	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)
	5
	6	## Screenshot
	7	![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png)
	8
	9	## Install
	10	The easy way:
	11	* Clone this repo
	12	* Create virtualenv (optional but recommended)
	13	* Install dependencies
	14	* Install the package itself
	15
	16	```bash
	17	git clone https://github.com/DTVD/rainbowstream.git
	18	cd rainbowstream
	19	virtualenv venv
	20	source venv/bin/activate
	21	pip install -r requirements.txt
	22	pip install -e .
	23	```
	24	The quick way:
	25	* Install everything over the air
	26
	27	```bash
	28	pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt
	29	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	rainbowstream
	36	```
	37	In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
	38
	39	Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
	40
	41	## License
	42	Rainbow Stream are released under an MIT License. See below for details
	43
	44	Copyright (c) 2014 Vu Nhat Minh
	45
	46	Permission is hereby granted, free of charge, to any person
	47	obtaining a copy of this software and associated documentation
	48	files (the "Software"), to deal in the Software without
	49	restriction, including without limitation the rights to use,
	50	copy, modify, merge, publish, distribute, sublicense, and/or sell
	51	copies of the Software, and to permit persons to whom the
	52	Software is furnished to do so, subject to the following
	53	conditions:
	54
	55	The above copyright notice and this permission notice shall be
	56	included in all copies or substantial portions of the Software.
	57
	58	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
	59	EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
	60	OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
	61	NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
	62	HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
	63	WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	64	FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
	65	OTHER DEALINGS IN THE SOFTWARE.