Commit | Line | Data |
---|---|---|
3108149e | 1 | Rainbow Stream\r |
2 | --------------\r | |
3 | \r | |
3216f3f4 O |
4 | .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r |
5 | :target: https://pypi.python.org/pypi/rainbowstream\r | |
6 | \r | |
7 | .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r | |
8 | :target: https://pypi.python.org/pypi/rainbowstream\r | |
c96321cc | 9 | \r |
3108149e | 10 | Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r |
11 | favorite … and much more fun directly from terminal.\r | |
12 | \r | |
3216f3f4 | 13 | This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r |
3108149e | 14 | \r |
15 | Screenshot\r | |
16 | ----------\r | |
17 | \r | |
3216f3f4 O |
18 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r |
19 | :alt: rainbowstream\r | |
20 | \r | |
21 | .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r | |
22 | :alt: rainbowstreamIOT\r | |
3108149e | 23 | \r |
24 | Install\r | |
25 | -------\r | |
26 | \r | |
27 | You will need Python 2.7+ and pip.\r | |
28 | \r | |
29 | .. code:: bash\r | |
30 | \r | |
31 | pip install rainbowstream\r | |
32 | \r | |
33 | Usage\r | |
34 | -----\r | |
35 | \r | |
36 | The stream\r | |
37 | ^^^^^^^^^^\r | |
38 | \r | |
39 | Just type\r | |
40 | \r | |
41 | .. code:: bash\r | |
42 | \r | |
43 | rainbow\r | |
44 | \r | |
45 | and see your stream.\r | |
46 | \r | |
3216f3f4 O |
47 | I shipped a feature which can display **tweet's images directly on terminal**.\r |
48 | You can try it with:\r | |
4373c17c O |
49 | \r |
50 | .. code:: bash\r | |
51 | \r | |
c1fa7c94 | 52 | rainbow -iot # Or rainbow --image-on-term\r |
4373c17c | 53 | \r |
3108149e | 54 | In the first time you will be asked for authorization of Rainbow Stream\r |
55 | app at Twitter. Just click the “Authorize access” button and paste PIN\r | |
3216f3f4 | 56 | number to the terminal, the rainbow will start.\r |
3108149e | 57 | \r |
58 | The interactive mode\r | |
59 | ^^^^^^^^^^^^^^^^^^^^\r | |
60 | \r | |
61 | While your personal stream is continued, you are also ready to tweet,\r | |
62 | search, reply, retweet… directly from console. Simply type “h” and hit\r | |
f5677fb1 | 63 | the Enter key to see the help.\r |
3108149e | 64 | \r |
65 | Input is in interactive mode. It means that you can use arrow key to\r | |
66 | move up and down history, tab-autocomplete or 2 tab to view available\r | |
f5677fb1 | 67 | suggestion. Input history from previous run is available as well.\r |
3108149e | 68 | \r |
a38a6465 | 69 | Here is full list of supported command:\r |
3108149e | 70 | \r |
a38a6465 | 71 | **Explore Commands**\r |
3108149e | 72 | \r |
eebc0ae6 | 73 | - ``trend`` will show global trending topics. ``trend US`` will show\r |
a38a6465 O |
74 | trends in United States while ``trend JP Tokyo`` will show trends in\r |
75 | Tokyo/Japan.\r | |
3108149e | 76 | \r |
77 | - ``home`` will show your timeline. ``home 10`` will print exactly 10\r | |
e2b81717 | 78 | tweets.\r |
3108149e | 79 | \r |
a38a6465 O |
80 | - ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r |
81 | mention tweets.\r | |
82 | \r | |
83 | - ``whois @dtvd88`` will show profile of @dtvd88.\r | |
84 | \r | |
3108149e | 85 | - ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r |
e2b81717 O |
86 | exactly 9 tweets.\r |
87 | \r | |
a38a6465 O |
88 | - ``s #noah`` will search the word *‘noah’*. Result will come back with\r |
89 | highlight.\r | |
90 | \r | |
91 | **Tweet Commands**\r | |
3108149e | 92 | \r |
93 | - ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r | |
a38a6465 | 94 | rainbow is god’s promise to noah’*.\r |
3108149e | 95 | \r |
96 | - ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r | |
97 | each tweet beside the time.\r | |
98 | \r | |
a38a6465 O |
99 | - ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r |
100 | \r | |
3108149e | 101 | - ``fav 12`` will favorite the tweet with *[id=12]*.\r |
102 | \r | |
a38a6465 | 103 | - ``ufav 12`` will unfavorite tweet with *[id=12]*.\r |
3108149e | 104 | \r |
105 | - ``del 12`` will delete tweet with *[id=12]*.\r | |
106 | \r | |
a38a6465 O |
107 | - ``show image 12`` will show the image in tweet with *[id=12]* in your\r |
108 | OS’s image viewer.\r | |
109 | \r | |
110 | **Direct Messages Commands**\r | |
111 | \r | |
112 | - ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r | |
113 | messages.\r | |
3108149e | 114 | \r |
a38a6465 O |
115 | - ``sent`` will show sent messages. ``sent 7`` will show newest 7\r |
116 | messages.\r | |
3108149e | 117 | \r |
d286f104 O |
118 | - ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r |
119 | \r | |
a38a6465 | 120 | - ``trash 5`` will remove message with *[message\_id=5]*\r |
3108149e | 121 | \r |
a38a6465 O |
122 | **Friends and followers Commands**\r |
123 | \r | |
124 | - ``ls fl`` will list all your followers (people who are following\r | |
125 | you).\r | |
b8cc314c | 126 | \r |
127 | - ``ls fr`` will list all your friends (people who you are following).\r | |
128 | \r | |
a38a6465 | 129 | - ``fl @dtvd88`` will follow @dtvd88.\r |
e2b81717 | 130 | \r |
a38a6465 | 131 | - ``ufl @dtvd88`` will unfollow @dtvd88.\r |
e2b81717 | 132 | \r |
a38a6465 | 133 | - ``mute @dtvd88`` will mute @dtvd88.\r |
e2b81717 | 134 | \r |
a38a6465 | 135 | - ``unmute @dtvd88`` will unmute @dtvd88.\r |
e2b81717 | 136 | \r |
a38a6465 | 137 | - ``muting`` will list muting users.\r |
f5677fb1 | 138 | \r |
a38a6465 O |
139 | - ``block @dtvd88`` will block @dtvd88.\r |
140 | \r | |
141 | - ``unblock @dtvd88`` will unblock @dtvd88.\r | |
142 | \r | |
143 | - ``report @dtvd88`` will report @dtvd88 as a spam account.\r | |
144 | \r | |
145 | **Screening Commands**\r | |
3108149e | 146 | \r |
147 | - ``h`` will show the help.\r | |
148 | \r | |
149 | - ``c`` will clear the screen.\r | |
150 | \r | |
151 | - ``q`` will quit.\r | |
152 | \r | |
a38a6465 | 153 | **Switching Stream Commands**\r |
eebc0ae6 | 154 | \r |
a38a6465 O |
155 | - ``switch public #AKB48`` will switch current stream to public stream\r |
156 | and track keyword ``AKB48``\r | |
eebc0ae6 O |
157 | \r |
158 | - ``switch public #AKB48 -f`` will do exactly as above but will ask you\r | |
159 | to provide 2 list:\r | |
160 | \r | |
161 | ``Only nicks`` decide what nicks will be include only.\r | |
162 | \r | |
a38a6465 | 163 | ``Ignore nicks``\ decide what nicks will be exclude.\r |
eebc0ae6 O |
164 | \r |
165 | - ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r | |
166 | *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r | |
167 | \r | |
168 | - ``switch mine`` will switch current stream to personal stream. ``-f``\r | |
169 | and ``-d`` will work as well.\r | |
170 | \r | |
3216f3f4 | 171 | \r |
a38a6465 | 172 | \r |
3108149e | 173 | For example see the screenshot above.\r |
174 | \r | |
175 | Bug Report\r | |
176 | ----------\r | |
177 | \r | |
3216f3f4 | 178 | Please `create an issue`_ or contact me at `@dtvd88`_\r |
3108149e | 179 | \r |
180 | License\r | |
181 | -------\r | |
182 | \r | |
183 | Rainbow Stream are released under an MIT License. See LICENSE.txt for\r | |
184 | details\r | |
185 | \r | |
186 | \r | |
187 | .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r | |
bade45d4 | 188 | .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r |
3216f3f4 | 189 | .. _EarthQuake: https://github.com/jugyo/earthquake\r |
3108149e | 190 | .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r |
3216f3f4 | 191 | .. _@dtvd88: https://twitter.com/dtvd88\r |