X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=6ec76feb9c9a243b876ab8fd9857a7c3a9cc5ec1;hp=9603f56c386d85265adc909df186738528fde1f7;hb=a8c5fce4b567697790144ec15546ce68e5469963;hpb=0cba104f13e87da40883ff10b4d5dbe7332b3084 diff --git a/README.rst b/README.rst index 9603f56..6ec76fe 100644 --- a/README.rst +++ b/README.rst @@ -1,27 +1,56 @@ Rainbow Stream -------------- -|Download| |Version| +.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat + :target: https://pypi.python.org/pypi/rainbowstream + +.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat + :target: 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`_ and `Twitter API`_. +This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, +can run on Python 2.7.x and 3.x . + -Screenshot +Showcase ---------- +Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s -|rainbowstream| |rainbowstreamIOT| +Screenshot: (click to see) +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png + :alt: all + Install ------- -You will need Python 2.7+ and pip. +The quick way +^^^^^^^^^^^^^ + +You will need Python and pip (2.7.x or 3.x). + +.. code:: bash + + sudo pip install rainbowstream + # Python 3 users: sudo pip3 install rainbowstream + + +The recommended way +^^^^^^^^^^^^^^^^^^^ + +Use `virtualenv`_ .. code:: bash + 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 + Usage ----- @@ -32,24 +61,23 @@ Just type .. code:: bash - rainbow + rainbowstream and see your stream. -I shipped a feature which can display **tweet’s images directly on -terminal**. You can try it with: +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: .. code:: bash - rainbow -iot # Or rainbow --image-on-term + 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 - +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 @@ -59,95 +87,81 @@ 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** +Available commands are listed in `Read The Docs`_. -- ``trend`` will show global trending topics. ``trend US`` will show - trends in United States while ``trend JP Tokyo`` will show trends in - Tokyo/Japan. +Theme customization +------------------------ -- ``home`` will show your timeline. ``home 10`` will print exactly 10 - tweets. +Rainbow Stream is shipped with some default themes. +You can either change theme by ``theme`` command or create your favorite one. -- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print - exactly 9 tweets. +Theme’s screenshot: -- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 - mention tweets. +- Monokai -- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the - rainbow is god’s promise to noah’*. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png + :alt: monokai -- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of - each tweet beside the time. +- Solarized -- ``fav 12`` will favorite the tweet with *[id=12]*. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png + :alt: solarized -- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*. +- Tomorrow Night -- ``del 12`` will delete tweet with *[id=12]*. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png + :alt: tomorrownight -- ``ufav 12`` will unfavorite tweet with *[id=12]*. +- Larapaste -- ``s #noah`` will search the word *‘noah’*. Result will come back with - highlight. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png + :alt: larapaste -- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88. -- ``show image 12`` will show the image in tweet with *[id=12]* in your - OS’s image viewer. +For detaile information, see `theme usage and customization`_. -- ``ls fl`` will list all your followers (people who are following - you). +Bug and feature requests +------------------------ -- ``ls fr`` will list all your friends (people who you are following). +Found a bug or a feature request ? +Please `create an issue`_ or contact me at `@dtvd88`_ -- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 - messages. +Development +----------- -- ``sent`` will show sent messages. ``sent 7`` will show newest 7 - messages. +If you want to build a runnable version yourself, follow these simple +steps -- ``trash 5`` will remove message with *[message\_id=5]* +- `Create your own Twitter Application`_ +- Get your Twitter application’s API key and secret +- Fork this repo and clone in your system. +- Create a file ``consumer.py`` in `rainbowstream`_ folder with + following content -- ``whois @dtvd88`` will show profile of @dtvd88. + .. code:: python -- ``fl @dtvd88`` will follow @dtvd88. + # Consumer information + CONSUMER_KEY = 'APIKey' # Your Twitter application's API key + CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret -- ``ufl @dtvd88`` will unfollow @dtvd88. +- Use pip to install in local -- ``h`` will show the help. + .. code:: bash -- ``c`` will clear the screen. + # cd to directory which contains setup.py (cloned directory) + virtualenv venv # Python3 users: use -p to specify python3 + source venv/bin/activate + pip install -e . + which rainbowstream # /this-directory/venv/bin/rainbowstream + pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory) + # Remove ~/.rainbow_oauth if exists + rainbowstream # local version of rainbowstream -- ``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 ----------- - -Please `create an issue`_ or contact me at -[@dtvd88](https://twitter.com/dtvd88) +Contributing +------------ +I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_. +You will be listed as contributor. License ------- @@ -159,10 +173,12 @@ details .. _Python Twitter Tool: http://mike.verdone.ca/twitter/ .. _Twitter API: https://dev.twitter.com/docs/api/1.1 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new - -.. |Download| image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat - :target: https://pypi.python.org/pypi/rainbowstream -.. |Version| image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat - :target: https://pypi.python.org/pypi/rainbowstream -.. |rainbowstream| image:: ./screenshot/RainbowStream.png -.. |rainbowstreamIOT| image:: ./screenshot/RainbowStreamIOT.png +.. _@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 +.. _Create your own Twitter Application: https://apps.twitter.com/app/new +.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream +.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/