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