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 is built on the top of `Python Twitter Tool`_ and `Twitter API`_.
  14
  15 Showcase
  16 ----------
  17 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s
  18
  19 Screenshot:
  20
  21 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png
  22    :alt: rainbowstream
  23
  24 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png
  25    :alt: rainbowstreamIOT
  26
  27 Install
  28 -------
  29
  30 You will need Python 2.7+ and pip.
  31
  32 .. code:: bash
  33
  34     sudo pip install rainbowstream
  35
  36 or try with a virtualenv
  37
  38 .. code:: bash
  39
  40     sudo pip install virtualenv # skip if you already have virtualenv
  41     virtualenv venv
  42     source venv/bin/activate # use the brand new virtualenv.
  43     pip install rainbowstream
  44
  45 Usage
  46 -----
  47
  48 The stream
  49 ^^^^^^^^^^
  50
  51 Just type
  52
  53 .. code:: bash
  54
  55     rainbowstream
  56
  57 and see your stream.
  58
  59 I shipped a feature which can display **tweet's images directly on terminal**.
  60 You can try it with:
  61
  62 .. code:: bash
  63
  64     rainbowstream -iot # Or rainbowstream --image-on-term
  65
  66 In the first time you will be asked for authorization of Rainbow Stream
  67 app at Twitter. Just click the “Authorize access” button and paste PIN
  68 number to the terminal, the rainbow will start.
  69
  70 The interactive mode
  71 --------------------
  72
  73 While your personal stream is continued, you are also ready to tweet,
  74 search, reply, retweet… directly from console. Simply type “h” and hit
  75 the Enter key to see the help.
  76
  77 Input is in interactive mode. It means that you can use arrow key to
  78 move up and down history, tab-autocomplete or 2 tab to view available
  79 suggestion. Input history from previous run is available as well.
  80
  81 Available commands are listed in `Read The Docs`_.
  82
  83 Theme customization
  84 ------------------------
  85
  86 Rainbow Stream is shipped with some default themes.
  87 You can either change theme by ``theme`` command or create your favorite one.
  88
  89 Theme’s screenshot:
  90
  91 - Monokai
  92
  93 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png
  94    :alt: monokai
  95
  96 - Solarized
  97
  98 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png
  99    :alt: solarized
 100
 101 For detaile information, see `theme usage and customization`_.
 102
 103 Bug and feature requests
 104 ------------------------
 105
 106 Found a bug or a feature request ?
 107 Please `create an issue`_ or contact me at `@dtvd88`_
 108
 109 Contributing
 110 ------------
 111 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.
 112 You will be listed as contributor.
 113
 114 License
 115 -------
 116
 117 Rainbow Stream are released under an MIT License. See LICENSE.txt for
 118 details
 119
 120
 121 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/
 122 .. _Twitter API: https://dev.twitter.com/docs/api/1.1
 123 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new
 124 .. _@dtvd88: https://twitter.com/dtvd88
 125 .. _fork: https://github.com/DTVD/rainbowstream/fork
 126 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/
 127 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/
 128 .. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md
 129 .. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md