README.md

   1 ## Rainbow Stream
   2
   3 [![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
   4 [![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream)
   5
   6 Terminal-based Twitter Client.
   7 Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
   8
   9 This package is built on top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter API](https://dev.twitter.com/docs/api/1.1).
  10
  11 ## Showcase
  12 Screencast:
  13 https://www.youtube.com/watch?v=tykCvPMJq8s
  14 <br>
  15
  16 Screenshot: (Click to see)
  17 ![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png)
  18
  19 ## Install
  20 #### The quick way
  21 You will need Python 2.7 and pip.
  22 ```bash
  23 sudo pip install rainbowstream
  24 ```
  25
  26 #### The recommended way
  27 Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
  28 ```bash
  29 virtualenv venv
  30 # Python 3 users : use -p to specify your Python 3 localtion as below
  31 # virtualenv -p /usr/bin/python3 venv
  32 source venv/bin/activate
  33 pip install rainbowstream
  34 ```
  35
  36
  37 ## Usage
  38
  39 Just type
  40 ```bash
  41 rainbowstream
  42 ```
  43 and see your stream.
  44
  45 I shipped a feature which can display **tweet's images directly on terminal**.
  46 You can try it with:
  47 ```bash
  48 rainbowstream -iot # Or rainbowstream --image-on-term
  49 ```
  50
  51 In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
  52 Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
  53
  54 ## Interactive mode
  55
  56 While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
  57 Simply type "h" and hit the Enter key to see the help.
  58
  59 Input is in interactive mode. It means that you can use arrow key to move up and down history, tab-autocomplete or 2 tab to view available suggestion. Input history from previous run is available as well.
  60
  61 ## Available commands
  62
  63 Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
  64
  65 ## Theme customization
  66 Rainbow Stream is shipped with some default themes.
  67 You can either change theme by `theme` command or create your favorite one.
  68
  69 Theme's screenshot:
  70 * Monokai
  71 ![Monokai](./screenshot/themes/Monokai.png)
  72 * Solarized
  73 ![Solarized](./screenshot/themes/Solarized.png)
  74 * Tomorrow Night
  75 ![Solarized](./screenshot/themes/TomorrowNight.png)
  76 * Larapaste
  77 ![Solarized](./screenshot/themes/larapaste.png)
  78
  79 For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
  80
  81 ## Bug and feature requests
  82 Found a bug or a feature request ?
  83 Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
  84 or contact me at [@dtvd88](https://twitter.com/dtvd88)
  85
  86 ## Development
  87 If you want to build a runnable version yourself, follow these simple steps
  88 * [Create your own Twitter Application](https://apps.twitter.com/app/new)
  89 * Get your Twitter application's API key and secret
  90 * Fork this repo
  91 * Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content
  92 ```python
  93 # Consumer information
  94 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
  95 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
  96 ```
  97 * Use pip to install in local
  98 ```bash
  99 # cd to directory which contains setup.py
 100 pip install -e .
 101 pip list | grep rainbowstream # confirm installed version
 102 rainbowstream # local version of rainbowstream
 103 ```
 104
 105 ## Contributing
 106 I appreciate any help and support. Feel free to
 107 [fork](https://github.com/DTVD/rainbowstream/fork)
 108 and
 109 [create a pull request](https://github.com/DTVD/rainbowstream/compare/).
 110 You will be listed as contributor.
 111
 112 ## License
 113 Rainbow Stream are released under an MIT License. See LICENSE.txt for details