## 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 is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
+
+## Showcase
+Screencast:
+https://www.youtube.com/watch?v=tykCvPMJq8s
+<br>
+
+Screenshot:
+
+
-**The recommened way:**
-* Clone this repo
-* Create virtualenv (optional but recommended)
-* Install dependencies
-* Install the package itself
+
+## Install
+You will need Python 2.7+ and pip.
```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 .
+sudo pip install rainbowstream
```
-**The quick way:**
-* Install everything over the air
+or try with a virtualenv
```bash
-sudo pip install git+https://github.com/DTVD/rainbowstream.git
+sudo pip install virtualenv # skip if you already have virtualenv
+virtualenv venv
+source venv/bin/activate # use the brand new virtualenv.
+pip install rainbowstream
```
+
## Usage
#### The stream
Just type
```
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 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
+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 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```
+__Explore 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.
+
+* `mentions` will show mentions timeline. `mentions 7` will show 7 mention tweets.
+
+* `whois @dtvd88` will show profile of @dtvd88.
+
+* `view @mdo` will show @mdo 's timeline. `view @dmo 9` will print exactly 9 tweets.
+
+* `s #noah` will search the word *'noah'*. Result will come back with highlight.
+
+__Tweet Commands__
+
+* `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.
+
+* `allrt 12 20` will list 20 newest retweets of the tweet with *[id=12]*.
+If the number of retweets is not specified, 5 newest retweets will be listed instead.
-* ```switch public #AKB48 -f ``` will do exactly as above but will ask you to provide 2 list:
+* `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.
- ```Only nicks``` decide what nicks will be include only.
+* `fav 12` will favorite the tweet with *[id=12]*.
- ```Ignore nicks```decide what nicks will be exclude.
+* `ufav 12` will unfavorite tweet with *[id=12]*.
-* ```switch public #AKB48 -d ``` will apply filter to *ONLY_LIST* and *IGNORE_LIST*.
-You can setup 2 list above at ```config.py```
+* `del 12` will delete tweet with *[id=12]*.
-* ```switch mine``` will switch current stream to personal stream. ```-f``` and ```-d``` will work as well.
+* `show image 12` will show the image in tweet with *[id=12]* in your OS's image viewer.
-__Action Command__
+__Direct Messages Commands__
-* ```home```will show your timeline. ```home 10``` will print exactly 10 tweet.
+* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.
-* ```view @mdo```will show @mdo 's timeline. ```view @dmo 9``` will print exactly 9 tweet.
+* `sent` will show sent messages. `sent 7` will show newest 7 messages.
-* ```t the rainbow is god's promise to noah```will tweet exactly *'the rainbow is god's promise to noah'*
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.
-* ```rt 12```will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.
+* `trash 5` will remove message with *[message_id=5]*
-* ```rep 12 Really```will reply *'Really'* to the tweet with *[id=12]*.
+__Friends and followers Commands__
-* ```del 12```will delete thw tweet with *[id=12]*.
+* `ls fl` will list all your followers (people who are following you).
-* ```s #noah```will search the word *'noah'*. Result will come back with highlight.
+* `ls fr` will list all your friends (people who you are following).
-* ```fr```will list all friend (You are following people).
+* `fl @dtvd88` will follow @dtvd88.
-* ```fl```will list all follower.
+* `ufl @dtvd88` will unfollow @dtvd88.
-* ```h```will show the help.
+* `mute @dtvd88` will mute @dtvd88.
-* ```c```will clear the screen.
+* `unmute @dtvd88` will unmute @dtvd88.
-* ```q```will quit.
+* `muting` will list muting users.
+
+* `block @dtvd88` will block @dtvd88.
+
+* `unblock @dtvd88` will unblock @dtvd88.
+
+* `report @dtvd88` will report @dtvd88 as a spam account.
+
+__Switching 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.
+
+__Smart shell__
+
+* Put anything to terminal, the app will try to eval and display result as a python interactive shell.
+ * `142857*2` or `101**3` like a calculator.
+ * Even `cal` will show the calendar for current month.
+ * Put `order_rainbow('anything')` or `random_rainbow('wahahaha')` will make more fun :)
+
+__Screening Commands__
+
+* `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)
+## Bug and feature requests
+Found a bug or a feature request ?
+Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
or contact me at [@dtvd88](https://twitter.com/dtvd88)
+## Contributing
+I appreciate any help and support. Feel free to
+[fork](https://github.com/DTVD/rainbowstream/fork)
+and
+[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
+You will be listed as contributor.
+
## License
Rainbow Stream are released under an MIT License. See LICENSE.txt for details
projects / rainbowstream.git / blobdiff