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
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
- ``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 tweet with *[id=12]*.\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 OS’s image viewer.\r
\r
``Ignore nicks``\ decide what nicks will be exclude.\r
\r
-- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and *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`` 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
- ``c`` will clear the screen.\r
\r
+- ``v`` will show version info.\r
+\r
- ``q`` will quit.\r
\r
Theme customization\r
\r
- ``HIDE_PROMPT``: hide prompt after receiving a tweet or not.\r
\r
-- ``PREFIX``: display string of prompt.\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
\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
+ ``#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
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
.. _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
-\r
+.. _Emoji cheatsheet: http://www.emoji-cheat-sheet.com/\r
projects / rainbowstream.git / blobdiff