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