setup.py update
[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
O
20#### The quick way
21You will need Python 2.7 and pip.
c267927c 22```bash
303f38c9
O
23sudo pip install rainbowstream
24```
25
a693bd45
O
26#### The recommended way
27Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/)
303f38c9 28```bash
b84845b9 29virtualenv venv
a693bd45
O
30# Python 3 users : use -p to specify your Python 3 localtion as below
31# virtualenv -p /usr/bin/python3 venv
32source venv/bin/activate
52974125 33pip install rainbowstream
c267927c 34```
91476ec3 35
303f38c9 36
91476ec3 37## Usage
a693bd45 38
f36f4df7 39Just type
91476ec3 40```bash
67339c79 41rainbowstream
91476ec3 42```
f36f4df7
O
43and see your stream.
44
c1fa7c94
O
45I shipped a feature which can display **tweet's images directly on terminal**.
46You can try it with:
acf4d473 47```bash
67339c79 48rainbowstream -iot # Or rainbowstream --image-on-term
acf4d473
O
49```
50
9f72f0f5 51In the first time you will be asked for authorization of Rainbow Stream app at Twitter.
4e2680f6 52Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start.
91476ec3 53
f13e64ac 54## Interactive mode
b800b6ef 55
f3177531 56While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console.
f5677fb1 57Simply type "h" and hit the Enter key to see the help.
f36f4df7 58
f5677fb1 59Input 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 60
c9cf9c63
O
61## Available commands
62
63Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) .
e2c52049
O
64
65## Theme customization
06302419 66Rainbow Stream is shipped with some default themes.
e2c52049
O
67You can either change theme by `theme` command or create your favorite one.
68
06302419 69Theme's screenshot:
b63400a0
O
70* Monokai
71![Monokai](./screenshot/themes/Monokai.png)
72* Solarized
73![Solarized](./screenshot/themes/Solarized.png)
80182490
O
74* Tomorrow Night
75![Solarized](./screenshot/themes/TomorrowNight.png)
76* Larapaste
77![Solarized](./screenshot/themes/larapaste.png)
b63400a0 78
e2c52049 79For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md)
72b9e670 80
3aa1d137 81## Bug and feature requests
b84845b9 82Found a bug or a feature request ?
b8c1f42a 83Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new)
6a26fca1
O
84or contact me at [@dtvd88](https://twitter.com/dtvd88)
85
d215820b
O
86## Development
87If 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
76cbed00 91* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content
d215820b
O
92```python
93# Consumer information
94CONSUMER_KEY = 'APIKey' # Your Twitter application's API key
95CONSUMER_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
100pip install -e .
2ed891ae
O
101pip list | grep rainbowstream # confirm installed version
102rainbowstream # local version of rainbowstream
d215820b
O
103```
104
3aa1d137 105## Contributing
b84845b9
O
106I appreciate any help and support. Feel free to
107[fork](https://github.com/DTVD/rainbowstream/fork)
108and
3aa1d137
O
109[create a pull request](https://github.com/DTVD/rainbowstream/compare/).
110You will be listed as contributor.
111
f5dcec85 112## License
13b5b854 113Rainbow Stream are released under an MIT License. See LICENSE.txt for details