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