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