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