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 API](https://dev.twitter.com/docs/api/1.1).
+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).
-## Screenshot
+## Showcase
+Screencast:
+https://www.youtube.com/watch?v=tykCvPMJq8s
+<br>
+
+Screenshot:
+
## Install
You will need Python 2.7+ and pip.
```bash
+sudo pip install rainbowstream
+```
+
+or try with a virtualenv
+```bash
+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
Here is full list of supported command
-__Action Commands__
+__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.
-* `mentions` will show mentions timeline. `mentions 7` will show 7 mention 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.
-
-* `fav 12` will favorite the tweet with *[id=12]*.
+
+* `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.
* `rep 12 Really` will reply *'Really'* to the tweet with *[id=12]*.
-* `del 12` will delete tweet with *[id=12]*.
+* `fav 12` will favorite the 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.
+* `del 12` will delete tweet with *[id=12]*.
* `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).
+__Direct Messages Commands__
* `inbox` will show inbox messages. `inbox 7` will show newest 7 messages.
* `sent` will show sent messages. `sent 7` will show newest 7 messages.
+* `mes @dtvd88 hi` will send a `hi` message to @dtvd88.
+
* `trash 5` will remove message with *[message_id=5]*
-* `whois @dtvd88` will show profile of @dtvd88.
+__Friends and followers Commands__
+
+* `ls fl` will list all your followers (people who are following you).
+
+* `ls fr` will list all your friends (people who you are following).
* `fl @dtvd88` will follow @dtvd88.
* `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.
-__Stream Commands__
+* `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 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
+## 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