projects / rainbowstream.git / blame
| Commit | Line | Data |
|---|---|---|
| 91476ec3 | 1 | ## Rainbow Stream |
| cd300211 O |
2 | Terminal-based Twitter Client with Streaming API support. Only supports Python 2.7 or later. |
| 3 | ||
| 4 | This package build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) and inspired by [EarthQuake](https://github.com/jugyo/earthquake) | |
| f5dcec85 O |
5 | |
| 6 | ## Screenshot | |
| 7 |  | |
| 91476ec3 O |
8 | |
| 9 | ## Install | |
| 4ec25373 | 10 | **The easy way:** |
| c267927c | 11 | * Clone this repo |
| f5dcec85 | 12 | * Create virtualenv (optional but recommended) |
| c267927c O |
13 | * Install dependencies |
| 14 | * Install the package itself | |
| 15 | ||
| 91476ec3 | 16 | ```bash |
| c267927c O |
17 | git clone https://github.com/DTVD/rainbowstream.git |
| 18 | cd rainbowstream | |
| 4ec25373 | 19 | virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv" |
| f5dcec85 | 20 | source venv/bin/activate |
| 91476ec3 O |
21 | pip install -e . |
| 22 | ``` | |
| 4ec25373 | 23 | **The quick way:** |
| c267927c O |
24 | * Install everything over the air |
| 25 | ||
| 26 | ```bash | |
| 4ec25373 | 27 | sudo pip install git+https://github.com/DTVD/rainbowstream.git |
| c267927c O |
28 | ``` |
| 29 | **Note the I only support Python version 2.7+** | |
| 91476ec3 O |
30 | |
| 31 | ## Usage | |
| 32 | ```bash | |
| 33 | rainbowstream | |
| 34 | ``` | |
| 9f72f0f5 O |
35 | In the first time you will be asked for authorization of Rainbow Stream app at Twitter. |
| 36 | ||
| 4e2680f6 | 37 | Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start. |
| 91476ec3 | 38 | |
| f5dcec85 O |
39 | ## License |
| 40 | Rainbow Stream are released under an MIT License. See below for details | |
| 91476ec3 | 41 | |
| f5dcec85 | 42 | Copyright (c) 2014 Vu Nhat Minh |
| 91476ec3 | 43 | |
| f5dcec85 O |
44 | Permission is hereby granted, free of charge, to any person |
| 45 | obtaining a copy of this software and associated documentation | |
| 46 | files (the "Software"), to deal in the Software without | |
| 47 | restriction, including without limitation the rights to use, | |
| 48 | copy, modify, merge, publish, distribute, sublicense, and/or sell | |
| 49 | copies of the Software, and to permit persons to whom the | |
| 50 | Software is furnished to do so, subject to the following | |
| 51 | conditions: | |
| 52 | ||
| 53 | The above copyright notice and this permission notice shall be | |
| 54 | included in all copies or substantial portions of the Software. | |
| 55 | ||
| 56 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | |
| 57 | EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES | |
| 58 | OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | |
| 59 | NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT | |
| 60 | HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, | |
| 61 | WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
| 62 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR | |
| 63 | OTHER DEALINGS IN THE SOFTWARE. |