X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.md;h=a621318ecbe9084a8447985da3a50e82800cdc22;hp=3b54b3987bbe18c754ccb0d4c704daa1038c0655;hb=422dd3858dacc83de5e9d053140341b62a44012b;hpb=72b9e670b1b7d4285494fca22fe39dcea66feb44 diff --git a/README.md b/README.md index 3b54b39..a621318 100644 --- a/README.md +++ b/README.md @@ -1,116 +1,116 @@ ## Rainbow Stream -Terminal-based Twitter Client with Streaming API support. -Realtime tweetstream, compose, search ... and much more fun directly from terminal. -Only supports Python 2.7 or later. -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) +[![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) -## Screenshot -![v0.0.1](https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamv0.0.1.png) +Terminal-based Twitter Client. +Realtime tweetstream, compose, search , favorite ... and much more fun directly from terminal. -## Install -**The recommened way:** -* Clone this repo -* Create virtualenv (optional but recommended) -* Install dependencies -* Install the package itself +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). -```bash -git clone https://github.com/DTVD/rainbowstream.git -cd rainbowstream -virtualenv venv # Assume that you have virtualenv installed by "pip install virtualenv" -source venv/bin/activate -pip install -e . -``` -**The quick way:** -* Install everything over the air +## 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 quick way +You will need Python and pip (2.7.x or 3.x). ```bash -sudo pip install git+https://github.com/DTVD/rainbowstream.git +sudo pip install rainbowstream +# Python 3 users: sudo pip3 install rainbowstream ``` -**Note the I only support Python version 2.7+** -## Usage -#### The stream -Just type +#### The recommended way +Use [virtualenv](http://docs.python-guide.org/en/latest/dev/virtualenvs/) ```bash -rainbow +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 rainbowstream ``` -and see your stream. -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. - -#### The interactive mode -While the rainbow stream is continued, you are also ready to tweet, search, reply, retweet... directly from console. -Simply hit Enter key and type "h" to view 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 - -Here is full list of supported command +## Usage +Just type ```bash -[@dtvd88]home +rainbowstream ``` -Show your timeline. A number come after will decide number of tweets to print. Ex 'home 10'. +and see your stream. +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: ```bash -[@dtvd88]view @mdo +rainbowstream -iot # Or rainbowstream --image-on-term ``` -Show @mdo 's timeline. -```bash -[@dtvd88]t the rainbow is god's promise to noah -``` -Tweet exactly 'the rainbow is god's promise to noah' +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. -```bash -[@dtvd88]rt 1 -``` -Retweet the tweet with [id=1]. You can see id of each tweet beside the time. +## Interactive mode -```bash -[@dtvd88]rep 1 Really -``` -Reply 'Really' to the tweet with [id=1]. +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. -```bash -[@dtvd88]del 1 -``` -Delete thw tweet with [id=1]. +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. -```bash -[@dtvd88]s #noah -``` -Search the word 'noah'. Result will come back with highlight. +## Available commands -```bash -[@dtvd88]fr -``` -List all friend (You are following people). +Available commands are listed in [ReadTheDocs documents](http://rainbowstream.readthedocs.org/en/latest/) . -```bash -[@dtvd88]fl -``` -List all follower. +## Theme customization +Rainbow Stream is shipped with some default themes. +You can either change theme by `theme` command or create your favorite one. -```bash -[@dtvd88]h -``` -SHow the help. +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) -```bash -[@dtvd88]c -``` -Clear the screen. +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 -[@dtvd88]q +# 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 ``` -Quit. -For example see the screenshot above. +## 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 LICENSE.txt for details