bumped to 3.0
[rainbowstream.git] / README.md
CommitLineData
b8c1f42a 1## Rainbow Stream
169b134d 2
0d631c7a
O
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)
1e979485 5
b8c1f42a 6Terminal-based Twitter Client.
07d41d27 7Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal.
cd300211 8
90630e52 9This 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).
f5dcec85 10
5fba2a02 11## Showcase
b84845b9 12Screencast:
5fba2a02
O
13https://www.youtube.com/watch?v=tykCvPMJq8s
14<br>
12e072c0 15
040cec23 16Screenshot: (Click to see)
509cd4ae 17![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png)
b04861f5 18
91476ec3 19## Install
a693bd45 20#### The quick way
b4274147 21You will need Python and pip (2.7.x or 3.x).
c267927c 22```bash
303f38c9 23sudo pip install rainbowstream
b4274147 24# Python 3 users: sudo pip3 install rainbowstream
303f38c9
O
25```
26
a693bd45
O
27#### The recommended way
28Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
303f38c9 29```bash
b84845b9 30virtualenv venv
a693bd45
O
31# Python 3 users : use -p to specify your Python 3 localtion as below
32# virtualenv -p /usr/bin/python3 venv
33source venv/bin/activate
52974125 34pip install rainbowstream
c267927c 35```
91476ec3 36
303f38c9 37
91476ec3 38## Usage
a693bd45 39
f36f4df7 40Just type
91476ec3 41```bash
67339c79 42rainbowstream
91476ec3 43```
f36f4df7
O
44and see your stream.
45
c1fa7c94
O
46I shipped a feature which can display **tweet's images directly on terminal**.
47You can try it with:
acf4d473 48```bash
67339c79 49rainbowstream -iot # Or rainbowstream --image-on-term
acf4d473
O
50```
51
9f72f0f5 52In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 53Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 54
f13e64ac 55## Interactive mode
b800b6ef 56
f3177531 57While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1 58Simply type "h" and hit the Enter key to see the help.
f36f4df7 59
f5677fb1 60Input 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.
f36f4df7 61
c9cf9c63
O
62## Available commands
63
64Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
e2c52049
O
65
66## Theme customization
06302419 67Rainbow Stream is shipped with some default themes.
e2c52049
O
68You can either change theme by `theme` command or create your favorite one.
69
06302419 70Theme's screenshot:
b63400a0
O
71* Monokai
72![Monokai](./screenshot/themes/Monokai.png)
73* Solarized
74![Solarized](./screenshot/themes/Solarized.png)
80182490
O
75* Tomorrow Night
76![Solarized](./screenshot/themes/TomorrowNight.png)
77* Larapaste
78![Solarized](./screenshot/themes/larapaste.png)
b63400a0 79
e2c52049 80For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
72b9e670 81
3aa1d137 82## Bug and feature requests
b84845b9 83Found a bug or a feature request ?
b8c1f42a 84Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
6a26fca1
O
85or contact me at [@dtvd88](https://twitter.com/dtvd88)
86
d215820b
O
87## Development
88If you want to build a runnable version yourself, follow these simple steps
89* [Create your own Twitter Application](https://apps.twitter.com/app/new)
90* Get your Twitter application's API key and secret
91* Fork this repo
76cbed00 92* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content
d215820b
O
93```python
94# Consumer information
95CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
96CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret
97```
98* Use pip to install in local
99```bash
100# cd to directory which contains setup.py
2d341029
O
101virtualenv venv # Python3 users: use -p to specify python3
102source venv/bin/activate
d215820b 103pip install -e .
2ed891ae
O
104pip list | grep rainbowstream # confirm installed version
105rainbowstream # local version of rainbowstream
d215820b
O
106```
107
3aa1d137 108## Contributing
b84845b9
O
109I appreciate any help and support. Feel free to
110[fork](https://github.com/DTVD/rainbowstream/fork)
111and
3aa1d137
O
112[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
113You will be listed as contributor.
114
f5dcec85 115## License
13b5b854 116Rainbow Stream are released under an MIT License. See LICENSE.txt for details