Update README.rst
[rainbowstream.git] / docs / index.rst
CommitLineData
c264071c 1Rainbow 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
10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
2dd80ec9 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
687567eb 14can run on Python 2.7.x and 3.x .\r
c264071c 15\r
c264071c 16Install\r
17-------\r
18\r
0dc0dd00
O
19The quick way\r
20^^^^^^^^^^^^^\r
21\r
8b076818 22You will need Python and pip (2.7.x or 3.x).\r
c264071c 23\r
24.. code:: bash\r
25\r
26 sudo pip install rainbowstream\r
8b076818 27 # Python 3 users: sudo pip3 install rainbowstream\r
b84845b9 28\r
0dc0dd00
O
29The recommended way\r
30^^^^^^^^^^^^^^^^^^^\r
b84845b9 31\r
0dc0dd00 32Use `virtualenv`_\r
c264071c 33\r
34.. code:: bash\r
35\r
b84845b9 36 virtualenv venv\r
0dc0dd00
O
37 # Python 3 users : use -p to specify your Python 3 localtion as below\r
38 # virtualenv -p /usr/bin/python3 venv\r
39 source venv/bin/activate\r
c264071c 40 pip install rainbowstream\r
41\r
80fa0f3a
O
42Troubleshooting\r
43^^^^^^^^^^^^^^^\r
44\r
335e7803 45If you use Linux, you might need to install the python-dev package if you haven't already.\r
46c9fb81
O
46For debian-based distros, these can be installed with\r
47\r
48.. code:: bash\r
49\r
50 sudo apt-get install python-dev\r
51\r
52Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
80fa0f3a
O
53the ``Pillow`` package installation - a dependency of this app.\r
54If you are in this case, I recommend take a look at `Issue #10`_ and let me know if the workaround doesn't work for you.\r
0dc0dd00 55\r
c264071c 56Usage\r
57-----\r
58\r
59The stream\r
60^^^^^^^^^^\r
61\r
62Just type\r
63\r
64.. code:: bash\r
65\r
aa835f48 66 rainbowstream\r
c264071c 67\r
68and see your stream.\r
69\r
70I shipped a feature which can display **tweet's images directly on terminal**.\r
71You can try it with:\r
72\r
73.. code:: bash\r
74\r
aa835f48 75 rainbowstream -iot # Or rainbowstream --image-on-term\r
c264071c 76\r
d6cc4c67 77You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
5bfc62f2
O
78to enable above feature (see `config management`_ section).\r
79\r
c264071c 80In the first time you will be asked for authorization of Rainbow Stream\r
81app at Twitter. Just click the “Authorize access” button and paste PIN\r
82number to the terminal, the rainbow will start.\r
83\r
84The interactive mode\r
85^^^^^^^^^^^^^^^^^^^^\r
86\r
87While your personal stream is continued, you are also ready to tweet,\r
88search, reply, retweet… directly from console. Simply type “h” and hit\r
89the Enter key to see the help.\r
90\r
91Input is in interactive mode. It means that you can use arrow key to\r
92move up and down history, tab-autocomplete or 2 tab to view available\r
93suggestion. Input history from previous run is available as well.\r
94\r
95Here is full list of supported command:\r
96\r
97**Explore Commands**\r
98\r
99- ``trend`` will show global trending topics. ``trend US`` will show\r
100 trends in United States while ``trend JP Tokyo`` will show trends in\r
101 Tokyo/Japan.\r
102\r
103- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
104 tweets.\r
105\r
106- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
107 mention tweets.\r
108\r
109- ``whois @dtvd88`` will show profile of @dtvd88.\r
110\r
111- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
112 exactly 9 tweets.\r
113\r
03e08f86
O
114- ``s noah`` will search the word *‘noah’*. Result will come back with\r
115 highlight. Search can be performed with or without hashtag.\r
c264071c 116\r
117**Tweet Commands**\r
118\r
119- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
120 rainbow is god’s promise to noah’*.\r
121\r
122- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
123 each tweet beside the time.\r
124\r
162af8aa
O
125- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
126 the quote will be cancelled.\r
127\r
c264071c 128- ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
129\r
130- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
131\r
132- ``fav 12`` will favorite the tweet with *[id=12]*.\r
133\r
134- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
135\r
136- ``del 12`` will delete tweet with *[id=12]*.\r
137\r
138- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
139 OS’s image viewer.\r
140\r
162af8aa
O
141- ``open 12`` will open url in tweet with *[id=12]* in your\r
142 OS’s default browser.\r
143\r
c264071c 144**Direct Messages Commands**\r
145\r
146- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
147 messages.\r
148\r
149- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
150 messages.\r
151\r
152- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
153\r
154- ``trash 5`` will remove message with *[message\_id=5]*\r
155\r
156**Friends and followers Commands**\r
157\r
158- ``ls fl`` will list all your followers (people who are following\r
159 you).\r
160\r
161- ``ls fr`` will list all your friends (people who you are following).\r
162\r
163- ``fl @dtvd88`` will follow @dtvd88.\r
164\r
165- ``ufl @dtvd88`` will unfollow @dtvd88.\r
166\r
167- ``mute @dtvd88`` will mute @dtvd88.\r
168\r
169- ``unmute @dtvd88`` will unmute @dtvd88.\r
170\r
171- ``muting`` will list muting users.\r
172\r
173- ``block @dtvd88`` will block @dtvd88.\r
174\r
175- ``unblock @dtvd88`` will unblock @dtvd88.\r
176\r
177- ``report @dtvd88`` will report @dtvd88 as a spam account.\r
178\r
bef33491
O
179**Twitter list**\r
180\r
181- ``list`` will show all lists you are belong to.\r
182\r
183- ``list home`` will show timeline of list. You will be asked for list's name.\r
184\r
185- ``list all_mem`` will show list's all members.\r
186\r
187- ``list all_sub`` will show list's all subscribers.\r
188\r
189- ``list add`` will add specific person to a list owned by you.\r
bef33491
O
190\r
191- ``list rm`` will remove specific person from a list owned by you.\r
bef33491
O
192\r
193- ``list sub`` will subscribe you to a specific list.\r
194\r
195- ``list unsub`` will unsubscribe you from a specific list.\r
196\r
197- ``list own`` will show all list owned by you.\r
198\r
199- ``list new`` will create a new list.\r
200\r
201- ``list update`` will update a list owned by you.\r
202\r
203- ``list del`` will delete a list owned by you.\r
204\r
c264071c 205**Switching Stream Commands**\r
206\r
207- ``switch public #AKB48`` will switch current stream to public stream\r
208 and track keyword ``AKB48``\r
209\r
210- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
211 to provide 2 list:\r
212\r
213 ``Only nicks`` decide what nicks will be include only.\r
214\r
215 ``Ignore nicks``\ decide what nicks will be exclude.\r
216\r
217- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
218 *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
219\r
220- ``switch mine`` will switch current stream to personal stream. ``-f``\r
221 and ``-d`` will work as well.\r
222\r
223**Smart shell**\r
224\r
225- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
226\r
227 + ``142857*2`` or ``101**3`` like a calculator.\r
228 + Even ``cal`` will show the calendar for current month.\r
229 + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
230\r
8bfb2a32 231**Config Management**\r
c264071c 232\r
2d341029
O
233- ``theme`` will list available themes.\r
234\r
d317c01d
O
235 + ``theme monokai`` will apply *monokai* theme immediately.\r
236 + Changed theme will be remember as the next time's default theme.\r
2d341029 237\r
1603ff45
O
238- ``config`` will list all config key.\r
239\r
8bfb2a32 240 + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
42143fbe
O
241 + ``config TREND_MAX default`` will output default value of *TREND_MAX* config key.\r
242 + ``config CUSTOM_CONFIG drop`` will drop *CUSTOM_CONFIG* config key.\r
243 + ``config IMAGE_ON_TERM = true`` will set value of *IMAGE_ON_TERM* config key to *True*.\r
1603ff45
O
244\r
245**Screening Commands**\r
246\r
c264071c 247- ``h`` will show the help.\r
248\r
d6cc4c67
O
249- ``p`` will pause the stream.\r
250\r
251- ``r`` will unpause the stream.\r
252\r
c264071c 253- ``c`` will clear the screen.\r
254\r
255- ``q`` will quit.\r
256\r
e5057f23
O
257Theme customization\r
258^^^^^^^^^^^^^^^^^^^\r
259\r
06302419 260Rainbow Stream is shipped with some default themes.\r
e5057f23
O
261You can either change theme by ``theme`` command or create your favorite one.\r
262\r
155083ad
O
263Theme’s screenshot:\r
264\r
3681056d
O
265- Monokai\r
266\r
155083ad
O
267.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
268 :alt: monokai\r
269\r
3681056d
O
270- Solarized\r
271\r
155083ad
O
272.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
273 :alt: solarized\r
274\r
3681056d
O
275- Tomorrow Night\r
276\r
aa835f48
O
277.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
278 :alt: tomorrownight\r
279\r
3681056d
O
280- Larapaste\r
281\r
aa835f48
O
282.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
283 :alt: larapaste\r
284\r
e5057f23 285For detaile information, see `theme usage and customization`_.\r
c264071c 286\r
29fd0be6
O
287Config explanation\r
288^^^^^^^^^^^^^^^^^^\r
289\r
1603ff45
O
290Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
291You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
292\r
cb45dc23 293- ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
294\r
295- ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
296\r
4ef01bda 297- ``THEME``: current theme.\r
29fd0be6 298\r
4ef01bda 299- ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
29fd0be6 300\r
cb45dc23 301- ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
302\r
303- ``PREFIX``: display string of prompt.\r
335e7803 304\r
4ef01bda 305- ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
29fd0be6 306\r
4ef01bda
O
307- ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
308\r
309- ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
310\r
311- ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
312\r
313- ``TREND_MAX``: default trends to display on 'trend' command.\r
314\r
315- ``LIST_MAX``: default tweets to display on 'list home' command.\r
316\r
317- ``ONLY_LIST``: filter list on 'switch' command.\r
318\r
319- ``IGNORE_LIST``: ignore list on 'switch' command.\r
320\r
321- ``HISTORY_FILENAME``: name of file which stores input history.\r
322\r
323- ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
324\r
325- ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
326\r
327- ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
328\r
329- ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
330\r
331- ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
29fd0be6 332\r
7746aa96
O
333- ``FORMAT``: display format for tweet and message.\r
334\r
33cef8f6
O
335 + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
336 + ``DISPLAY``: decide how tweet will be printed.\r
d6cc4c67 337\r
33cef8f6
O
338 + ``#name``: Twitter's name\r
339 + ``#nick``: Twitter's screen name\r
340 + ``#clock``: Datetime\r
318cdd67
O
341 + ``#rt_count``: retweets count\r
342 + ``#fa_count``: favorites count\r
33cef8f6
O
343 + ``#id``: ID\r
344 + ``#fav``: favorited symbol\r
318cdd67 345 + ``#fav``: favorited symbol\r
33cef8f6
O
346 + ``#tweet``: Tweet's content\r
347 + ``#sender_name``: Message's sender name\r
348 + ``#sender_nick``: Message's sender screen name\r
349 + ``#to``: '>>>' symbol\r
350 + ``#recipient_name``: Message's recipient name\r
351 + ``#recipient_nick``: Message's recipient screen name\r
7746aa96
O
352\r
353\r
2d341029
O
354Development\r
355-----------\r
356\r
357If you want to build a runnable version yourself, follow these simple\r
358steps\r
359\r
360- `Create your own Twitter Application`_\r
361- Get your Twitter application’s API key and secret\r
9e1f9d56 362- Fork github's repo and clone in your system.\r
2d341029
O
363- Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
364 following content\r
365\r
366 .. code:: python\r
367\r
368 # Consumer information\r
369 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
370 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
371\r
372- Use pip to install in local\r
373\r
374 .. code:: bash\r
375\r
9e1f9d56 376 # cd to directory which contains setup.py (cloned directory)\r
2d341029
O
377 virtualenv venv # Python3 users: use -p to specify python3\r
378 source venv/bin/activate\r
379 pip install -e .\r
9e1f9d56
O
380 which rainbowstream # /this-directory/venv/bin/rainbowstream\r
381 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
382 # Remove ~/.rainbow_oauth if exists\r
2d341029 383 rainbowstream # local version of rainbowstream\r
c264071c 384\r
2d341029
O
385.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
386.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
c264071c 387.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
388.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
e5057f23 389.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
0dc0dd00 390.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
5bfc62f2 391.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
7746aa96 392.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
bdc155b7
O
393.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
394.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
5bfc62f2 395\r