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/0.0.3
   6
   7 .. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat
   8    :target: https://pypi.python.org/pypi/rainbowstream/0.0.3
   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    tweet.
  93
  94 -  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print
  95    exactly 9 tweet.
  96
  97 -  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the
  98    rainbow is god’s promise to noah’*
  99
 100 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of
 101    each tweet beside the time.
 102
 103 -  ``fav 12`` will favorite the tweet with *[id=12]*.
 104
 105 -  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.
 106
 107 -  ``del 12`` will delete tweet with *[id=12]*.
 108
 109 -  ``ufav 12`` will unfavorite tweet with *[id=12]*.
 110
 111 -  ``s #noah`` will search the word *‘noah’*. Result will come back
 112    with highlight.
 113
 114 -  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.
 115
 116 -  ``fl @dtvd88`` will follow @dtvd88.
 117
 118 -  ``ufl @dtvd88`` will unfollow @dtvd88.
 119
 120 -  ``h`` will show the help.
 121
 122 -  ``c`` will clear the screen.
 123
 124 -  ``q`` will quit.
 125
 126 For example see the screenshot above.
 127
 128 Bug Report
 129 ----------
 130
 131 Please `create an issue`_ or contact me at `@dtvd88`_
 132
 133 License
 134 -------
 135
 136 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 137 details
 138
 139
 140 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 141 .. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming
 142 .. _EarthQuake: https://github.com/jugyo/earthquake
 143 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 144 .. _@dtvd88: https://twitter.com/dtvd88