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