current_buffer in unicode wrapper
[rainbowstream.git] / docs / index.rst
... / ...
CommitLineData
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
13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
14can run on Python 2.7.x and 3.x .\r
15\r
16Install\r
17-------\r
18\r
19The quick way\r
20^^^^^^^^^^^^^\r
21\r
22You will need Python and pip (2.7.x or 3.x).\r
23\r
24.. code:: bash\r
25\r
26 sudo pip install rainbowstream\r
27 # Python 3 users: sudo pip3 install rainbowstream\r
28\r
29The recommended way\r
30^^^^^^^^^^^^^^^^^^^\r
31\r
32Use `virtualenv`_\r
33\r
34.. code:: bash\r
35\r
36 virtualenv venv\r
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
40 pip install rainbowstream\r
41\r
42Troubleshooting\r
43^^^^^^^^^^^^^^^\r
44\r
45If you use Linux, you might need to install the python-dev package if you haven't already.\r
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
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
55\r
56Usage\r
57-----\r
58\r
59The stream\r
60^^^^^^^^^^\r
61\r
62Just type\r
63\r
64.. code:: bash\r
65\r
66 rainbowstream\r
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
75 rainbowstream -iot # Or rainbowstream --image-on-term\r
76\r
77You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
78to enable above feature (see `config management`_ section).\r
79\r
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
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
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
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
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
141- ``open 12`` will open url in tweet with *[id=12]* in your\r
142 OS’s default browser.\r
143\r
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
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
190\r
191- ``list rm`` will remove specific person from a list owned by you.\r
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
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
231**Config Management**\r
232\r
233- ``theme`` will list available themes.\r
234\r
235 + ``theme monokai`` will apply *monokai* theme immediately.\r
236 + Changed theme will be remember as the next time's default theme.\r
237\r
238- ``config`` will list all config key.\r
239\r
240 + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
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
244\r
245**Screening Commands**\r
246\r
247- ``h`` will show the help.\r
248\r
249- ``p`` will pause the stream.\r
250\r
251- ``r`` will unpause the stream.\r
252\r
253- ``c`` will clear the screen.\r
254\r
255- ``q`` will quit.\r
256\r
257Available commands are listed in `Read The Docs`_.\r
258\r
259Theme customization\r
260^^^^^^^^^^^^^^^^^^^\r
261\r
262Rainbow Stream is shipped with some default themes.\r
263You can either change theme by ``theme`` command or create your favorite one.\r
264\r
265Theme’s screenshot:\r
266\r
267- Monokai\r
268\r
269.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
270 :alt: monokai\r
271\r
272- Solarized\r
273\r
274.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
275 :alt: solarized\r
276\r
277- Tomorrow Night\r
278\r
279.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
280 :alt: tomorrownight\r
281\r
282- Larapaste\r
283\r
284.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
285 :alt: larapaste\r
286\r
287For detaile information, see `theme usage and customization`_.\r
288\r
289Config explanation\r
290^^^^^^^^^^^^^^^^^^\r
291\r
292Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
293You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
294\r
295- ``THEME``: current theme.\r
296\r
297- ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
298\r
299- ``HIDE_PROMPT``: Hide prompt after receiving a tweet or not.\r
300\r
301- ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
302\r
303- ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
304\r
305- ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
306\r
307- ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
308\r
309- ``TREND_MAX``: default trends to display on 'trend' command.\r
310\r
311- ``LIST_MAX``: default tweets to display on 'list home' command.\r
312\r
313- ``ONLY_LIST``: filter list on 'switch' command.\r
314\r
315- ``IGNORE_LIST``: ignore list on 'switch' command.\r
316\r
317- ``HISTORY_FILENAME``: name of file which stores input history.\r
318\r
319- ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
320\r
321- ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
322\r
323- ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
324\r
325- ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
326\r
327- ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
328\r
329- ``FORMAT``: display format for tweet and message.\r
330\r
331 + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
332 + ``DISPLAY``: decide how tweet will be printed.\r
333\r
334 + ``#name``: Twitter's name\r
335 + ``#nick``: Twitter's screen name\r
336 + ``#clock``: Datetime\r
337 + ``#id``: ID\r
338 + ``#fav``: favorited symbol\r
339 + ``#tweet``: Tweet's content\r
340 + ``#sender_name``: Message's sender name\r
341 + ``#sender_nick``: Message's sender screen name\r
342 + ``#to``: '>>>' symbol\r
343 + ``#recipient_name``: Message's recipient name\r
344 + ``#recipient_nick``: Message's recipient screen name\r
345\r
346\r
347Development\r
348-----------\r
349\r
350If you want to build a runnable version yourself, follow these simple\r
351steps\r
352\r
353- `Create your own Twitter Application`_\r
354- Get your Twitter application’s API key and secret\r
355- Fork github's repo and clone in your system.\r
356- Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
357 following content\r
358\r
359 .. code:: python\r
360\r
361 # Consumer information\r
362 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
363 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
364\r
365- Use pip to install in local\r
366\r
367 .. code:: bash\r
368\r
369 # cd to directory which contains setup.py (cloned directory)\r
370 virtualenv venv # Python3 users: use -p to specify python3\r
371 source venv/bin/activate\r
372 pip install -e .\r
373 which rainbowstream # /this-directory/venv/bin/rainbowstream\r
374 pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
375 # Remove ~/.rainbow_oauth if exists\r
376 rainbowstream # local version of rainbowstream\r
377\r
378.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
379.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
380.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
381.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
382.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
383.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
384.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
385.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
386.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
387.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
388\r