[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/RainbowStreamvSS.png)

## Install
You will need Python 2.7+ and pip.

```bash
pip install rainbowstream
```

## 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 your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
Simply type "h" and hit the Enter key to see 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

__Stream Command__
* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```

* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:

    ```Only nicks``` decide what nicks will be include only.

    ```Ignore nicks```decide what nicks will be exclude.

* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
You can setup 2 list above at ```config.py```

* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.

__Action 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.

* ```fav 12```will favorite the tweet with *[id=12]*.

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

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

* ```ufav 12```will unfavorite 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/RainbowStreamvSS.png)
	10
	11	## Install
	12	You will need Python 2.7+ and pip.
	13
	14	```bash
	15	pip install rainbowstream
	16	```
	17
	18	## Usage
	19	#### The stream
	20	Just type
	21	```bash
	22	rainbow
	23	```
	24	and see your stream.
	25
	26	In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
	27	Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
	28
	29	#### The interactive mode
	30	While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
	31	Simply type "h" and hit the Enter key to see the help
	32
	33	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
	34
	35	Here is full list of supported command
	36
	37	__Stream Command__
	38	* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
	39
	40	* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
	41
	42	```Only nicks``` decide what nicks will be include only.
	43
	44	```Ignore nicks```decide what nicks will be exclude.
	45
	46	* ```switch public #AKB48 -d ``` will apply filter to ONLY_LIST and IGNORE_LIST.
	47	You can setup 2 list above at ```config.py```
	48
	49	* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
	50
	51	__Action Command__
	52
	53	* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
	54
	55	* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
	56
	57	* ```t the rainbow is god's promise to noah```will tweet exactly 'the rainbow is god's promise to noah'
	58
	59	* ```rt 12```will retweet the tweet with [id=12]. You can see id of each tweet beside the time.
	60
	61	* ```fav 12```will favorite the tweet with [id=12].
	62
	63	* ```rep 12 Really```will reply 'Really' to the tweet with [id=12].
	64
	65	* ```del 12```will delete tweet with [id=12].
	66
	67	* ```ufav 12```will unfavorite tweet with [id=12].
	68
	69	* ```s #noah```will search the word 'noah'. Result will come back with highlight.
	70
	71	* ```fr```will list all friend (You are following people).
	72
	73	* ```fl```will list all follower.
	74
	75	* ```h```will show the help.
	76
	77	* ```c```will clear the screen.
	78
	79	* ```q```will quit.
	80
	81	For example see the screenshot above.
	82
	83	## Bug Report
	84	Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
	85	or contact me at [@dtvd88](https://twitter.com/dtvd88)
	86
	87	## License
	88	Rainbow Stream are released under an MIT License. See LICENSE.txt for details