README.rst

   1 Rainbow Stream
   2 --------------
   3
   4 .. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat
   5    :target: https://pypi.python.org/pypi/rainbowstream
   6
   7 .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat
   8    :target: https://pypi.python.org/pypi/rainbowstream
   9
  10 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,
  11 favorite … and much more fun directly from terminal.
  12
  13 This package build on the top of `Python Twitter Tool`_ and `Twitter
  14 Streaming API`_ and inspired by `EarthQuake`_
  15
  16 Screenshot
  17 ----------
  18
  19 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
  20    :alt: v0.0.1
  21
  22 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
  23    :alt: v0.0.3
  24
  25 Install
  26 -------
  27
  28 You will need Python 2.7+ and pip.
  29
  30 .. code:: bash
  31
  32     pip install rainbowstream
  33
  34 Usage
  35 -----
  36
  37 The stream
  38 ^^^^^^^^^^
  39
  40 Just type
  41
  42 .. code:: bash
  43
  44     rainbow
  45
  46 and see your stream.
  47
  48 I shipped a feature which can display **tweet's images directly on terminal**.
  49 You can try it with:
  50
  51 .. code:: bash
  52
  53     rainbow -iot # Or rainbow --image-on-term
  54
  55 In the first time you will be asked for authorization of Rainbow Stream
  56 app at Twitter. Just click the “Authorize access” button and paste PIN
  57 number to the terminal, the rainbow will start.
  58
  59 The interactive mode
  60 ^^^^^^^^^^^^^^^^^^^^
  61
  62 While your personal stream is continued, you are also ready to tweet,
  63 search, reply, retweet… directly from console. Simply type “h” and hit
  64 the Enter key to see the help.
  65
  66 Input is in interactive mode. It means that you can use arrow key to
  67 move up and down history, tab-autocomplete or 2 tab to view available
  68 suggestion. Input history from previous run is available as well.
  69
  70 Here is full list of supported command
  71
  72 **Stream Command**
  73
  74 -  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``
  75
  76 -  ``switch public #AKB48 -f`` will do exactly as above but will ask you
  77    to provide 2 list:
  78
  79    ``Only nicks`` decide what nicks will be include only.
  80
  81    ``Ignore nicks`` decide what nicks will be exclude.
  82
  83 -  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and
  84    *IGNORE\_LIST*. You can setup 2 list above at ``config.py``
  85
  86 -  ``switch mine`` will switch current stream to personal stream. ``-f``
  87    and ``-d`` will work as well.
  88
  89 **Action Command**
  90
  91 -  ``home`` will show your timeline. ``home 10`` will print exactly 10
  92    tweets.
  93
  94 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
  95    exactly 9 tweets.
  96
  97 -  ``mentions`` will show mentions timeline. ``mentions 7`` will show
  98    7 mention tweets.
  99
 100 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
 101    rainbow is god’s promise to noah’*
 102
 103 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
 104    each tweet beside the time.
 105
 106 -  ``fav 12`` will favorite the tweet with *[id=12]*.
 107
 108 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
 109
 110 -  ``del 12`` will delete tweet with *[id=12]*.
 111
 112 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
 113
 114 -  ``s #noah`` will search the word *‘noah’*. Result will come back
 115    with highlight.
 116
 117 -  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.
 118
 119 -  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.
 120
 121 -  ``ls fl`` will list all your followers (people who are following you).
 122
 123 -  ``ls fr`` will list all your friends (people who you are following).
 124
 125 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest
 126    7 message.
 127
 128 -  ``sent`` will show sent messages. ``sent 7`` will show newest
 129    7 message.
 130
 131 -  ``trash 5`` will remove message with *[message_id=5]*.
 132
 133 -  ``whois @dtvd88`` will show profile of @dtvd88.
 134
 135 -  ``fl @dtvd88`` will follow @dtvd88.
 136
 137 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 138
 139 -  ``h`` will show the help.
 140
 141 -  ``c`` will clear the screen.
 142
 143 -  ``q`` will quit.
 144
 145 For example see the screenshot above.
 146
 147 Bug Report
 148 ----------
 149
 150 Please `create an issue`_ or contact me at `@dtvd88`_
 151
 152 License
 153 -------
 154
 155 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 156 details
 157
 158
 159 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 160 .. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming
 161 .. _EarthQuake: https://github.com/jugyo/earthquake
 162 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 163 .. _@dtvd88: https://twitter.com/dtvd88