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