X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=7727f720c57ed94c7aaa6fb1813c4ce60e6d69f7;hp=f2c760da8c413ff081dd53a18fe4b73c9fcd016e;hb=3b1912ee9c8127a1f3458d3272d9e3b134bda46e;hpb=4373c17c2eebb276c292b083c4145f57f1e72438;ds=sidebyside diff --git a/README.rst b/README.rst index f2c760d..7727f72 100644 --- a/README.rst +++ b/README.rst @@ -1,30 +1,79 @@ Rainbow Stream -------------- +.. 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 build on the top of `Python Twitter Tool`_ and `Twitter -Streaming API`_ and inspired by `EarthQuake`_ +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 ----------- -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS.png - :alt: v0.0.1 +Showcase +-------- -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamvSS(Image).png - :alt: v0.0.2 +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif + :alt: gif 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 +Troubleshooting +^^^^^^^^^^^^^^^ + +If you use Linux, you might need to install some packages if you haven't already. +For debian-based distros, these can be installed with + +.. code:: bash + + sudo apt-get install python-dev libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev + +Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with +the ``Pillow`` package installation - a dependency of this app. +If you are in this case, I recommend taking a look at `Issue #10`_ and let me know if this workaround doesn't work for you. + +.. code:: bash + + export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future + +If installation in *the quick way* doesn't work: + +- ``sudo pip uninstall rainbowstream`` +- use the *virtualenv way* above +- `create an issue`_ and provide: + + + Your OS + + Your Python version + Usage ----- @@ -35,15 +84,22 @@ Just type .. code:: bash - rainbow + rainbowstream and see your stream. -In the case you want to see photos directly in terminal, the command is +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: .. code:: bash - rainbow -img 1 # Or rainbow --image 1 + rainbowstream -iot # Or rainbowstream --image-on-term + +You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app +to enable above feature, +change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) +or ``IMAGE_MAX_HEIGHT`` to control max height of every image. +(see `config management`_ section). 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 @@ -54,72 +110,86 @@ 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 -the Enter key to see the help +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 +suggestion. Input history from previous run is available as well. -Here is full list of supported command +Available commands are listed in `Read The Docs`_. -**Stream Command** +Theme customization +^^^^^^^^^^^^^^^^^^^ -- ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48`` +Rainbow Stream is shipped with some default themes. +You can either change theme by ``theme`` command or create your favorite one. -- ``switch public #AKB48 -f`` will do exactly as above but will ask you - to provide 2 list: +Theme’s screenshot: - ``Only nicks`` decide what nicks will be include only. +- Monokai - ``Ignore nicks`` decide what nicks will be exclude. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png + :alt: monokai -- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and - *IGNORE\_LIST*. You can setup 2 list above at ``config.py`` +- Solarized -- ``switch mine`` will switch current stream to personal stream. ``-f`` - and ``-d`` will work as well. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png + :alt: solarized -**Action Command** +- Tomorrow Night -- ``home`` will show your timeline. ``home 10`` will print exactly 10 - tweet. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png + :alt: tomorrownight -- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print - exactly 9 tweet. +- Larapaste -- ``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/larapaste.png + :alt: larapaste -- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of - each tweet beside the time. +For detaile information, see `theme usage and customization`_. -- ``fav 12`` will favorite the tweet with *[id=12]*. -- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*. +Bug and feature requests +------------------------ -- ``del 12`` will delete tweet with *[id=12]*. +Found a bug or a feature request ? +Please `create an issue`_ or contact me at `@dtvd88`_ -- ``ufav 12`` will unfavorite tweet with *[id=12]*. +Development +----------- -- ``s #noah`` will search the word *‘noah’*. Result will come back - with highlight. +If you want to build a runnable version yourself, follow these simple +steps -- ``fr`` will list all friend (You are following people). +- `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 -- ``fl`` will list all follower. + .. code:: python -- ``h`` will show the help. + # Consumer information + CONSUMER_KEY = 'APIKey' # Your Twitter application's API key + CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret -- ``c`` will clear the screen. +- Use pip to install in local -- ``q`` will quit. + .. code:: bash -For example see the screenshot above. + # 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 + # Remove ~/.rainbow_oauth if exists + rainbowstream # local version of rainbowstream -Bug Report ----------- -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 ------- @@ -129,7 +199,17 @@ details .. _Python Twitter Tool: http://mike.verdone.ca/twitter/ -.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming -.. _EarthQuake: https://github.com/jugyo/earthquake +.. _Twitter API: https://dev.twitter.com/docs/api/1.1 .. _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 +.. _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/ +.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation +.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/ +.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10