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