[rainbowstream.git] / README.md

## Rainbow Stream 

[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)

Terminal-based Twitter Client. 
Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.

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](./screenshot/RainbowStream.png)
![v0.0.3](./screenshot/RainbowStreamIOT.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.

I shipped a feature which can display **tweet's images directly on terminal**.
You can try it with:
```bash
rainbow -iot # Or rainbow --image-on-term
```

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. Input history from previous run is available as well.

Here is full list of supported command

__Action Commands__

* ```trend```will show global trending topics. ```trend US``` will show trends in United States while ```trend JP Tokyo``` will show trends in Tokyo/Japan.

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

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

* ```mentions```will show mentions timeline. ```mentions 7``` will show 7 mention tweets.

* ```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.

* ```mes @dtvd88 hi```will send a ```hi``` message to @dtvd88.

* ```show image 12``` will show the image in tweet with *[id=12]* in your OS's image viewer.

* ```ls fl```will list all your followers (people who are following you).

* ```ls fr```will list all your friends (people who you are following).

* ```inbox```will show inbox messages. ```inbox 7``` will show newest 7 messages.

* ```sent```will show sent messages. ```sent 7``` will show newest 7 messages.

* ```trash 5```will remove message with *[message_id=5]*

* ```whois @dtvd88```will show profile of @dtvd88.

* ```fl @dtvd88```will follow @dtvd88.

* ```ufl @dtvd88```will unfollow @dtvd88.

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

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

* ```q```will quit.

__Stream Commands__

* ```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.

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
169b134d O	1	## Rainbow Stream
169b134d O	2
0d631c7a O	3	[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
0d631c7a O	4	[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
1e979485	5
07d41d27 O	6	Terminal-based Twitter Client.
07d41d27 O	7	Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
cd300211 O	8
cd300211 O	9	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)
f5dcec85 O	10
f5dcec85 O	11	## Screenshot
7cf379e9 O	12	![v0.0.1](./screenshot/RainbowStream.png)
7cf379e9 O	13	![v0.0.3](./screenshot/RainbowStreamIOT.png)
91476ec3 O	14
91476ec3 O	15	## Install
52974125	16	You will need Python 2.7+ and pip.
c267927c O	17
c267927c O	18	```bash
52974125	19	pip install rainbowstream
c267927c	20	```
91476ec3 O	21
91476ec3 O	22	## Usage
f36f4df7 O	23	#### The stream
f36f4df7 O	24	Just type
91476ec3	25	```bash
20ba76f5	26	rainbow
91476ec3	27	```
f36f4df7 O	28	and see your stream.
f36f4df7 O	29
c1fa7c94 O	30	I shipped a feature which can display tweet's images directly on terminal.
c1fa7c94 O	31	You can try it with:
acf4d473	32	```bash
c1fa7c94	33	rainbow -iot # Or rainbow --image-on-term
acf4d473 O	34	```
acf4d473 O	35
9f72f0f5	36	In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6	37	Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3	38
f36f4df7	39	#### The interactive mode
f3177531	40	While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1	41	Simply type "h" and hit the Enter key to see the help.
f36f4df7	42
f5677fb1	43	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. Input history from previous run is available as well.
f36f4df7 O	44
	45	Here is full list of supported command
	46
4e0bf227	47	__Action Commands__
f4ffe56b	48
13e71acb	49	* ```trend```will show global trending topics. ```trend US``` will show trends in United States while ```trend JP Tokyo``` will show trends in Tokyo/Japan.
f4ffe56b	50
e2b81717	51	* ```home```will show your timeline. ```home 10``` will print exactly 10 tweets.
f36f4df7	52
e2b81717	53	* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweets.
f36f4df7	54
e2b81717 O	55	* ```mentions```will show mentions timeline. ```mentions 7``` will show 7 mention tweets.
	56
	57	* ```t the rainbow is god's promise to noah```will tweet exactly 'the rainbow is god's promise to noah'.
f36f4df7	58
da4e013a	59	* ```rt 12```will retweet the tweet with [id=12]. You can see id of each tweet beside the time.
c7ef0402	60
a1c246e6 O	61	* ```fav 12```will favorite the tweet with [id=12].
a1c246e6 O	62
aeacba5f	63	* ```rep 12 Really```will reply 'Really' to the tweet with [id=12].
f36f4df7	64
a1c246e6 O	65	* ```del 12```will delete tweet with [id=12].
	66
	67	* ```ufav 12```will unfavorite tweet with [id=12].
f36f4df7	68
aeacba5f	69	* ```s #noah```will search the word 'noah'. Result will come back with highlight.
f36f4df7	70
f485db0d O	71	* ```mes @dtvd88 hi```will send a ```hi``` message to @dtvd88.
f485db0d O	72
f5677fb1	73	* ```show image 12``` will show the image in tweet with [id=12] in your OS's image viewer.
f36f4df7	74
b5f92888	75	* ```ls fl```will list all your followers (people who are following you).
b8cc314c	76
	77	* ```ls fr```will list all your friends (people who you are following).
	78
e2b81717 O	79	* ```inbox```will show inbox messages. ```inbox 7``` will show newest 7 messages.
	80
	81	* ```sent```will show sent messages. ```sent 7``` will show newest 7 messages.
	82
	83	* ```trash 5```will remove message with [message_id=5]
	84
	85	* ```whois @dtvd88```will show profile of @dtvd88.
	86
f5677fb1 O	87	* ```fl @dtvd88```will follow @dtvd88.
	88
	89	* ```ufl @dtvd88```will unfollow @dtvd88.
f36f4df7	90
da4e013a	91	* ```h```will show the help.
f36f4df7	92
da4e013a	93	* ```c```will clear the screen.
f36f4df7	94
da4e013a	95	* ```q```will quit.
7b2f82ad	96
4e0bf227 O	97	__Stream Commands__
	98
	99	* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
	100
	101	* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
	102
	103	```Only nicks``` decide what nicks will be include only.
	104
	105	```Ignore nicks```decide what nicks will be exclude.
	106
	107	* ```switch public #AKB48 -d ``` will apply filter to ONLY_LIST and IGNORE_LIST.
	108	You can setup 2 list above at ```config.py```
	109
	110	* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
	111
72b9e670 O	112	For example see the screenshot above.
72b9e670 O	113
6a26fca1 O	114	## Bug Report
	115	Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
	116	or contact me at [@dtvd88](https://twitter.com/dtvd88)
	117
f5dcec85	118	## License
13b5b854	119	Rainbow Stream are released under an MIT License. See LICENSE.txt for details