## 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)
+[](https://pypi.python.org/pypi/rainbowstream)
+[](https://pypi.python.org/pypi/rainbowstream)
-## Screenshot
-
+Terminal-based Twitter Client.
+Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
-## Install
-You will need Python 2.7+ and pip to install
+This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
-**The recommened way:**
-* Clone this repo
-* Create virtualenv (optional but recommended)
-* Install dependencies
-* Install the package itself
+## Screenshot
+
+
-```bash
-git clone git@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
+## Install
+You will need Python 2.7+ and pip.
```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+pip install rainbowstream
```
## Usage
```
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
+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 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
-__Stream Command__
-* ```switch public #AKB48``` will switch current stream to public stream and track keyword ```AKB48```
+__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.
-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.
- ```Only nicks``` decide what nicks will be include only.
+* `show image 12` will show the image in tweet with *[id=12]* in your OS's image viewer.
- ```Ignore nicks```decide what nicks will be exclude.
+* `ls fl` will list all your followers (people who are following you).
-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+* `ls fr` will list all your friends (people who you are following).
-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.
-__Action Command__
+* `sent` will show sent messages. `sent 7` will show newest 7 messages.
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+* `trash 5` will remove message with *[message_id=5]*
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+* `whois @dtvd88` will show profile of @dtvd88.
-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+* `fl @dtvd88` will follow @dtvd88.
-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+* `ufl @dtvd88` will unfollow @dtvd88.
-* ```fav 12```will favorite the tweet with *[id=12]*.
+* `h` will show the help.
-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
+* `c` will clear the screen.
-* ```del 12```will delete tweet with *[id=12]*.
+* `q` will quit.
-* ```ufav 12```will unfavorite tweet with *[id=12]*.
+__Stream Commands__
-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
+* `switch public #AKB48` will switch current stream to public stream and track keyword `AKB48`
-* ```fr```will list all friend (You are following people).
+* `switch public #AKB48 -f ` will do exactly as above but will ask you to provide 2 list:
-* ```fl```will list all follower.
+ `Only nicks` decide what nicks will be include only.
-* ```h```will show the help.
+ `Ignore nicks`decide what nicks will be exclude.
-* ```c```will clear the screen.
+* `switch public #AKB48 -d ` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
+You can setup 2 list above at `config.py`
-* ```q```will quit.
+* `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)
+Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
or contact me at [@dtvd88](https://twitter.com/dtvd88)
## License
projects / rainbowstream.git / blobdiff