X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=707ddbc5394de79487c07bc8a81aba79a3b1514e;hp=4fe23607a47a3a776dd45e50dc041e61673407be;hb=19d6c0023fa57cb008775a8f0440f222adb11f0d;hpb=3216f3f41a0a2466be30575fdb07ec7bfe9aee78 diff --git a/README.rst b/README.rst index 4fe2360..707ddbc 100644 --- a/README.rst +++ b/README.rst @@ -12,8 +12,11 @@ favorite … and much more fun directly from terminal. This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_. -Screenshot +Showcase ---------- +Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s + +Screenshot: .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png :alt: rainbowstream @@ -28,6 +31,15 @@ You will need Python 2.7+ and pip. .. code:: bash + sudo pip install rainbowstream + +or try with a virtualenv + +.. code:: bash + + sudo pip install virtualenv # skip if you already have virtualenv + virtualenv venv + source venv/bin/activate # use the brand new virtualenv. pip install rainbowstream Usage @@ -56,7 +68,7 @@ app at Twitter. Just click the “Authorize access” button and paste PIN number to the terminal, the rainbow will start. The 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 @@ -66,93 +78,35 @@ 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. -Here is full list of supported command - -**Action Commands** - -- ``trend`` will show global trending topics. ``trend US`` will show - trends in United States while ``trend JP Tokyo`` will show trends - in Tokyo/Japan. - -- ``home`` will show your timeline. ``home 10`` will print exactly 10 - tweets. - -- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print - exactly 9 tweets. - -- ``mentions`` will show mentions timeline. ``mentions 7`` will show - 7 mention tweets. - -- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the - rainbow is god’s promise to noah’* - -- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of - each tweet beside the time. - -- ``fav 12`` will favorite the tweet with *[id=12]*. - -- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*. - -- ``del 12`` will delete tweet with *[id=12]*. - -- ``ufav 12`` will unfavorite tweet with *[id=12]*. - -- ``s #noah`` will search the word *‘noah’*. Result will come back - with highlight. - -- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88. +Available commands are listed in `Read The Docs`_. -- ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer. +Theme customization +------------------------ -- ``ls fl`` will list all your followers (people who are following you). +Rainbow Stream is shipped with some default themes. +You can either change theme by ``theme`` command or create your favorite one. -- ``ls fr`` will list all your friends (people who you are following). +Theme’s screenshot: -- ``inbox`` will show inbox messages. ``inbox 7`` will show newest - 7 message. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png + :alt: monokai -- ``sent`` will show sent messages. ``sent 7`` will show newest - 7 message. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png + :alt: solarized -- ``trash 5`` will remove message with *[message_id=5]*. +For detaile information, see `theme usage and customization`_. -- ``whois @dtvd88`` will show profile of @dtvd88. - -- ``fl @dtvd88`` will follow @dtvd88. - -- ``ufl @dtvd88`` will unfollow @dtvd88. - -- ``h`` will show the help. - -- ``c`` will clear the screen. - -- ``q`` will quit. - -**Stream Commands** - -- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48`` - -- ``switch public #AKB48 -f`` will do exactly as above but will ask you - to provide 2 list: - - ``Only nicks`` decide what nicks will be include only. - - ``Ignore nicks`` decide what nicks will be exclude. - -- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and - *IGNORE\_LIST*. You can setup 2 list above at ``config.py`` - -- ``switch mine`` will switch current stream to personal stream. ``-f`` - and ``-d`` will work as well. - - -For example see the screenshot above. - -Bug Report ----------- +Bug and feature requests +------------------------ +Found a bug or a feature request ? Please `create an issue`_ or contact me at `@dtvd88`_ +Contributing +------------ +I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_. +You will be listed as contributor. + License ------- @@ -162,6 +116,10 @@ details .. _Python Twitter Tool: http://mike.verdone.ca/twitter/ .. _Twitter API: https://dev.twitter.com/docs/api/1.1 -.. _EarthQuake: https://github.com/jugyo/earthquake .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new .. _@dtvd88: https://twitter.com/dtvd88 +.. _fork: https://github.com/DTVD/rainbowstream/fork +.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/ +.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/ +.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md +.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md