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