X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=a621318ecbe9084a8447985da3a50e82800cdc22;hp=fd3ea3fea029fa5c15ad9e4f4ef46405e4f81f38;hb=422dd3858dacc83de5e9d053140341b62a44012b;hpb=f5dcec852475f6d80cfcd9a0d232aa129308815a diff --git a/README.md b/README.md index fd3ea3f..a621318 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,116 @@ ## Rainbow Stream -This is a Twitter timeline on the terminal, build on the top of [Python Twitter Tool](http://mike.verdone.ca/twitter/) and [Twitter Streaming API](https://dev.twitter.com/docs/api/streaming) -## Screenshot -![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png) +[![Download](http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream) +[![Version](http://img.shields.io/pypi/v/rainbowstream.svg?style=flat)](https://pypi.python.org/pypi/rainbowstream) + +Terminal-based Twitter Client. +Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal. + +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). + +## Showcase +Screencast: +https://www.youtube.com/watch?v=tykCvPMJq8s +
+ +Screenshot: (Click to see) +![rainbowstream](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png) ## Install -*The easy way:* -* Clone this repo -* Create virtualenv (optional but recommended) -* Install dependencies -* Install the package itself +#### The quick way +You will need Python and pip (2.7.x or 3.x). +```bash +sudo pip install rainbowstream +# Python 3 users: sudo pip3 install rainbowstream +``` +#### The recommended way +Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) ```bash -git clone https://github.com/DTVD/rainbowstream.git -cd rainbowstream virtualenv venv +# Python 3 users : use -p to specify your Python 3 localtion as below +# virtualenv -p /usr/bin/python3 venv source venv/bin/activate -pip install -r requirements.txt -pip install -e . +pip install rainbowstream ``` -*The quick way:* -* Install everything over the air -```bash -pip install -r https://raw.githubusercontent.com/DTVD/rainbowstream/master/requirements.txt -pip install git+https://github.com/DTVD/rainbowstream.git -``` -**Note the I only support Python version 2.7+** ## Usage -Let's see the rainbow + +Just type ```bash rainbowstream ``` +and see your stream. + +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: +```bash +rainbowstream -iot # Or rainbowstream --image-on-term +``` + +In the first time you will be asked for authorization of Rainbow Stream app at Twitter. +Just click the "Authorize access" button and paste PIN number to the terminal, the rainbow will start. + +## Interactive mode + +While your personal stream is continued, you are also ready to tweet, search, reply, retweet... directly from console. +Simply type "h" and hit the Enter key to see the help. + +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. + +## Available commands + +Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) . + +## Theme customization +Rainbow Stream is shipped with some default themes. +You can either change theme by `theme` command or create your favorite one. + +Theme's screenshot: +* Monokai +![Monokai](./screenshot/themes/Monokai.png) +* Solarized +![Solarized](./screenshot/themes/Solarized.png) +* Tomorrow Night +![Solarized](./screenshot/themes/TomorrowNight.png) +* Larapaste +![Solarized](./screenshot/themes/larapaste.png) + +For detaile information, see [theme usage and customization](https://github.com/DTVD/rainbowstream/blob/master/theme.md) + +## Bug and feature requests +Found a bug or a feature request ? +Please [create an issue](https://github.com/DTVD/rainbowstream/issues/new) +or contact me at [@dtvd88](https://twitter.com/dtvd88) + +## Development +If you want to build a runnable version yourself, follow these simple steps +* [Create your own Twitter Application](https://apps.twitter.com/app/new) +* Get your Twitter application's API key and secret +* Fork this repo +* Create a file `consumer.py` in [`rainbowstream`](https://github.com/DTVD/rainbowstream/tree/master/rainbowstream) folder with following content +```python +# Consumer information +CONSUMER_KEY = 'APIKey' # Your Twitter application's API key +CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret +``` +* Use pip to install in local +```bash +# cd to directory which contains setup.py +virtualenv venv # Python3 users: use -p to specify python3 +source venv/bin/activate +pip install -e . +pip list | grep rainbowstream # confirm installed version +rainbowstream # local version of rainbowstream +``` + +## Contributing +I appreciate any help and support. Feel free to +[fork](https://github.com/DTVD/rainbowstream/fork) +and +[create a pull request](https://github.com/DTVD/rainbowstream/compare/). +You will be listed as contributor. ## License -Rainbow Stream are released under an MIT License. See below for details - -Copyright (c) 2014 Vu Nhat Minh - -Permission is hereby granted, free of charge, to any person -obtaining a copy of this software and associated documentation -files (the "Software"), to deal in the Software without -restriction, including without limitation the rights to use, -copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the -Software is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES -OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND -NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT -HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, -WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING -FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR -OTHER DEALINGS IN THE SOFTWARE. +Rainbow Stream are released under an MIT License. See LICENSE.txt for details