[rainbowstream.git] / README.md

## Rainbow Stream
Terminal-based Twitter Client with Streaming API support. 
Realtime tweetstream, compose, search ... and much more fun directly from terminal.
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 recommened 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 # Assume that you have virtualenv installed by "pip install virtualenv"
source venv/bin/activate
pip install -e .
```
**The quick way:**
* Install everything over the air

```bash
sudo pip install git+https://github.com/DTVD/rainbowstream.git
```
**Note the I only support Python version 2.7+**

## Usage
#### The stream
Just type
```bash
rainbow
```
and see your stream.

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.

#### The interactive mode
While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
Simply hit Enter key and type "h" to view the help

Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion

Here is full list of supported command

* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.

* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.

* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*

* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.

* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.

* ```del 12```will delete thw tweet with *[id=12]*.

* ```s #noah```will search the word *'noah'*. Result will come back with highlight.

* ```fr```will list all friend (You are following people).

* ```fl```will list all follower.

* ```h```will show the help.

* ```c```will clear the screen.

* ```q```will quit.

For example see the screenshot above.

## Bug Report
Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) 
or contact me at [@dtvd88](https://twitter.com/dtvd88)

## License
Rainbow Stream are released under an MIT License. See LICENSE.txt for details
Commit	Line	Data
	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	#### The stream
	35	Just type
	36	```bash
	37	rainbow
	38	```
	39	and see your stream.
	40
	41	In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
	42	Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
	43
	44	#### The interactive mode
	45	While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
	46	Simply hit Enter key and type "h" to view the help
	47
	48	Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion
	49
	50	Here is full list of supported command
	51
	52	* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
	53
	54	* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
	55
	56	* ```t the rainbow is god's promise to noah```will tweet exactly 'the rainbow is god's promise to noah'
	57
	58	* ```rt 12```will retweet the tweet with [id=12]. You can see id of each tweet beside the time.
	59
	60	* ```rep 12 Really```will reply 'Really' to the tweet with [id=12].
	61
	62	* ```del 12```will delete thw tweet with [id=12].
	63
	64	* ```s #noah```will search the word 'noah'. Result will come back with highlight.
	65
	66	* ```fr```will list all friend (You are following people).
	67
	68	* ```fl```will list all follower.
	69
	70	* ```h```will show the help.
	71
	72	* ```c```will clear the screen.
	73
	74	* ```q```will quit.
	75
	76	For example see the screenshot above.
	77
	78	## Bug Report
	79	Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
	80	or contact me at [@dtvd88](https://twitter.com/dtvd88)
	81
	82	## License
	83	Rainbow Stream are released under an MIT License. See LICENSE.txt for details