Rainbow Stream\r
--------------\r
\r
-.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
- :target: https://pypi.python.org/pypi/rainbowstream\r
+.. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square\r
+ :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt\r
\r
-.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square\r
:target: https://pypi.python.org/pypi/rainbowstream\r
\r
Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
can run on Python 2.7.x and 3.x .\r
\r
+Home page : http://www.rainbowstream.org/\r
+\r
+Source code : https://github.com/DTVD/rainbowstream\r
+\r
Install\r
-------\r
\r
source venv/bin/activate\r
pip install rainbowstream\r
\r
+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install some packages if you haven't already.\r
+For debian-based distros, these can be installed with\r
+\r
+.. code:: bash\r
+\r
+ sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
+\r
+Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
+the ``Pillow`` package installation - a dependency of this app.\r
+If you are in this case, I recommend taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you.\r
+\r
+.. code:: bash\r
+\r
+ export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
+\r
+If installation in *the quick way* doesn't work:\r
+\r
+- ``sudo pip uninstall rainbowstream``\r
+- use the *virtualenv way* above\r
+- `create an issue`_ and provide:\r
+\r
+ + Your OS\r
+ + Your Python version\r
\r
Usage\r
-----\r
\r
rainbowstream -iot # Or rainbowstream --image-on-term\r
\r
-You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
-to enable above feature (see `config management`_ section).\r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
+to enable above feature,\r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)\r
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
+(see `config management`_ section).\r
\r
In the first time you will be asked for authorization of Rainbow Stream\r
app at Twitter. Just click the “Authorize access” button and paste PIN\r
number to the terminal, the rainbow will start.\r
\r
+You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are\r
+provided as follows:\r
+\r
+.. code:: bash\r
+\r
+ rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP\r
+ # or using the short form:\r
+ rainbowstream -ph localhost -pp 1337 -pt HTTP\r
+\r
+Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default\r
+proxy port ``8080`` and default proxy type ``SOCKS5`` are used.\r
+\r
The interactive mode\r
^^^^^^^^^^^^^^^^^^^^\r
\r
\r
**Explore Commands**\r
\r
-- ``trend`` will show global trending topics. ``trend US`` will show\r
- trends in United States while ``trend JP Tokyo`` will show trends in\r
- Tokyo/Japan.\r
+- ``trend`` will show global trending topics. ``trend US`` will show trends in United States while ``trend JP Tokyo`` will show trends in Tokyo/Japan.\r
+\r
+- ``home`` will show your timeline. ``home 10`` will print exactly 10 tweets.\r
\r
-- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
- tweets.\r
+- ``notification`` will show your notification from the time you started RainbowStream.\r
\r
-- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
- mention tweets.\r
+- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 mention tweets.\r
\r
- ``whois @dtvd88`` will show profile of @dtvd88.\r
\r
-- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
- exactly 9 tweets.\r
+- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print exactly 9 tweets.\r
\r
-- ``s noah`` will search the word *‘noah’*. Result will come back with\r
- highlight. Search can be performed with or without hashtag.\r
+- ``s noah`` will search the word *‘noah’*. Result will come back with highlight. Search can be performed with or without hashtag.\r
\r
**Tweet Commands**\r
\r
-- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
- rainbow is god’s promise to noah’*.\r
+- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the rainbow is god’s promise to noah’*.\r
\r
-- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
- each tweet beside the time.\r
+- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of each tweet beside the time.\r
\r
-- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
- the quote will be cancelled.\r
+- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added, the quote will be cancelled.\r
\r
- ``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
\r
-- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
+- ``conversation 12`` will show the chain of replies prior to the tweet with *[id=12]*.\r
+\r
+- ``rep 12 Really`` will reply *‘Really’* to the owner of the tweet with *[id=12]*.\r
+\r
+- ``repall 12 Really`` will reply *‘Really’* to all people in the tweet with *[id=12]*.\r
\r
- ``fav 12`` will favorite the tweet with *[id=12]*.\r
\r
- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
\r
+- ``share 12`` will copy link to tweet with *[id=12]* to your clipboard if you are on a Mac, or display it directly if you are on Linux.\r
+\r
- ``del 12`` will delete tweet with *[id=12]*.\r
\r
-- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
- OS’s image viewer.\r
+- ``show image 12`` will show the image in tweet with *[id=12]* in your OS’s image viewer.\r
\r
-- ``open 12`` will open url in tweet with *[id=12]* in your\r
- OS’s default browser.\r
+- ``open 12`` will open url in tweet with *[id=12]* in your OS’s default browser.\r
\r
**Direct Messages Commands**\r
\r
-- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
- messages.\r
+- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 messages.\r
\r
-- ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
- messages.\r
+- ``thread 2`` will show full thread with [id=2].\r
\r
- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
\r
\r
**Friends and followers Commands**\r
\r
-- ``ls fl`` will list all your followers (people who are following\r
- you).\r
+- ``ls fl`` will list all your followers (people who are following you).\r
\r
- ``ls fr`` will list all your friends (people who you are following).\r
\r
\r
**Switching Stream Commands**\r
\r
-- ``switch public #AKB48`` will switch current stream to public stream\r
- and track keyword ``AKB48``\r
+- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\r
\r
-- ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
- to provide 2 list:\r
+- ``switch public #AKB48 -f`` will do exactly as above but will ask you to provide 2 list:\r
\r
``Only nicks`` decide what nicks will be include only.\r
\r
``Ignore nicks``\ decide what nicks will be exclude.\r
\r
-- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
- *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+- ``switch mine`` will switch current stream to personal stream. ``-f`` will work as well.\r
\r
-- ``switch mine`` will switch current stream to personal stream. ``-f``\r
- and ``-d`` will work as well.\r
+- ``switch list`` will switch to a Twitter list's stream. You will be asked for list name.\r
\r
**Smart shell**\r
\r
\r
- ``theme`` will list available themes.\r
\r
- + ``theme monokai`` will apply *monokai* theme immedaitely.\r
- + ``theme current_as_default`` will remember current theme as next time default.\r
+ + ``theme monokai`` will apply *monokai* theme immediately.\r
+ + Changed theme will be remember as the next time's default theme.\r
\r
- ``config`` will list all config key.\r
\r
\r
- ``h`` will show the help.\r
\r
+- ``p`` will pause the stream.\r
+\r
+- ``r`` will unpause the stream.\r
+\r
- ``c`` will clear the screen.\r
\r
-- ``q`` will quit.\r
+- ``v`` will show version info.\r
\r
-Available commands are listed in `Read The Docs`_.\r
+- ``q`` will quit.\r
\r
Theme customization\r
^^^^^^^^^^^^^^^^^^^\r
Config explanation\r
^^^^^^^^^^^^^^^^^^\r
\r
-Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
-You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
+Rainbow Stream has a custom config file located at ``~/.rainbow_config.json`` which will be loaded **after** its `default config`_. You are free to change anything on your custom config, but if you messed up with JSON format, the app would still works fine. Simply overwrite your custom config withe the `default config`_ to solve format problems.\r
+\r
+You also can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
+\r
+- ``HEARTBEAT_TIMEOUT``: after this timeout (count by minutes), the stream will automatically hangup.\r
+\r
+- ``IMAGE_ON_TERM``: display tweet's image directly on terminal.\r
+\r
+- ``IMAGE_RESIZE_TO_FIT``: display tweet's image fit inside terminal view (width and height).\r
\r
- ``THEME``: current theme.\r
\r
- ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
\r
+- ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
+\r
+- ``PREFIX``: display formated string of prompt.\r
+\r
+ + ``#me``: Your username with '@', only available in personal stream.\r
+ + ``#place``: List name, only available in list stream.\r
+ + ``#owner``: Owner of list name, only available in list stream.\r
+ + ``#keyword``: Keyword, only available on public stream.\r
+\r
+- ``SEARCH_TYPE``: search type in 'search' command ('mixed','recent','popular').\r
+\r
- ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
\r
- ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
\r
- ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
\r
+- ``CONVERSATION_MAX``: max tweet in a 'conversation' thread.\r
+\r
+- ``QUOTE_FORMAT``: format when quote a tweet\r
+\r
+ + ``#comment``: Your own comment about the tweet\r
+ + ``#owner``: owner's username with '@'\r
+ + ``#tweet``: original tweet\r
+\r
+- ``THREAD_META_LEFT``: format for meta information of messages from partner which is display in the left of screen.\r
+\r
+- ``THREAD_META_RIGHT``: format for meta information of messages from you which is display in the right of screen.\r
+\r
+- ``THREAD_MIN_WIDTH``: minimum width of a message frame.\r
+\r
+- ``NOTIFY_FORMAT``: format of a notification.\r
+\r
- ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
\r
- ``TREND_MAX``: default trends to display on 'trend' command.\r
\r
- ``LIST_MAX``: default tweets to display on 'list home' command.\r
\r
-- ``ONLY_LIST``: filter list on 'switch' command.\r
+- ``ONLY_LIST``: filter list on 'switch' command. Eg: ["@fat","mdo"]\r
\r
-- ``IGNORE_LIST``: ignore list on 'switch' command.\r
+- ``IGNORE_LIST``: ignore list on 'switch' command. Eg: ["@fat"]\r
\r
- ``HISTORY_FILENAME``: name of file which stores input history.\r
\r
\r
- ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
\r
+- ``STREAM_DELAY``: seconds to wait before displaying another tweet, will drop all tweets while waiting. This value can be used to slow down the stream.\r
+\r
- ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
\r
- ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
\r
- ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
\r
+- ``FORMAT``: display format for tweet and message.\r
+\r
+ + ``CLOCK_FORMAT``: time format, see `Python's strftime format`_.\r
+ + ``DISPLAY``: decide how tweet will be printed.\r
+\r
+ + ``#name``: Twitter's name\r
+ + ``#nick``: Twitter's screen name\r
+ + ``#clock``: Datetime\r
+ + ``#rt_count``: retweets count\r
+ + ``#fa_count``: favorites count\r
+ + ``#id``: ID\r
+ + ``#fav``: favorited symbol\r
+ + ``#fav``: favorited symbol\r
+ + ``#tweet``: Tweet's content\r
+ + ``#sender_name``: Message's sender name\r
+ + ``#sender_nick``: Message's sender screen name\r
+ + ``#to``: '>>>' symbol\r
+ + ``#recipient_name``: Message's recipient name\r
+ + ``#recipient_nick``: Message's recipient screen name\r
+\r
+In every format, you can use unicode characters like ``\u2665``.\r
+Mac users also can use emoji characters as well (Ex: ``::zap::``).\r
+See `Emoji cheatsheet`_ for details.\r
+\r
Development\r
-----------\r
\r
source venv/bin/activate\r
pip install -e .\r
which rainbowstream # /this-directory/venv/bin/rainbowstream\r
- pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
# Remove ~/.rainbow_oauth if exists\r
rainbowstream # local version of rainbowstream\r
\r
.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
-.. _config management: http://rainbowstream.readthedocs.org/en/latest/#the-interactive-mode\r
-\r
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
+.. _Python's strftime format: https://docs.python.org/2/library/time.html#time.strftime\r
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
+.. _default config: https://github.com/DTVD/rainbowstream/blob/master/rainbowstream/colorset/config\r
+.. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/\r
projects / rainbowstream.git / blobdiff