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