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