X-Git-Url: https://vcs.fsf.org/?p=rainbowstream.git;a=blobdiff_plain;f=README.rst;h=34a81fd2ded341e5bb9dff5918e46740dd80a376;hp=cc633747ab095253263237a551a318daaf82fa4b;hb=0b176bc3c51336bbd44b1cd095bf84c0fe0ef74d;hpb=a38a6465afe78ae4694da66744f8dda7d33d9c1d diff --git a/README.rst b/README.rst index cc63374..34a81fd 100644 --- a/README.rst +++ b/README.rst @@ -1,181 +1,210 @@ 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/l/rainbowstream.svg?style=flat-square + :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt -.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat +.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square :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 the 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 . + +Home page : http://www.rainbowstream.org/ -Screenshot ----------- +Source code : https://github.com/DTVD/rainbowstream -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png - :alt: rainbowstream +Showcase +-------- -.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png - :alt: rainbowstreamIOT +.. 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 - pip install rainbowstream + sudo pip install rainbowstream + # Python 3 users: sudo pip3 install rainbowstream -Usage ------ -The stream -^^^^^^^^^^ +The recommended way +^^^^^^^^^^^^^^^^^^^ -Just type +Use `virtualenv`_ .. code:: 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. +Troubleshooting +^^^^^^^^^^^^^^^ -I shipped a feature which can display **tweet's images directly on terminal**. -You can try it with: +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 - rainbow -iot # Or rainbow --image-on-term + sudo apt-get install python-dev libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev -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. +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. -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. - -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. +.. code:: bash -Here is full list of supported command: + export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future -**Explore Commands** +If installation in *the quick way* doesn't work: -- ``trend`` will show global trending topics. ``trend US`` will show - trends in United States while ``trend JP Tokyo`` will show trends in - Tokyo/Japan. +- ``sudo pip uninstall rainbowstream`` +- use the *virtualenv way* above +- `create an issue`_ and provide: -- ``home`` will show your timeline. ``home 10`` will print exactly 10 - tweets. + + Your OS + + Your Python version -- ``mentions`` will show mentions timeline. ``mentions 7`` will show 7 - mention tweets. +Usage +----- -- ``whois @dtvd88`` will show profile of @dtvd88. +The stream +^^^^^^^^^^ -- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print - exactly 9 tweets. +Just type -- ``s #noah`` will search the word *‘noah’*. Result will come back with - highlight. +.. code:: bash -**Tweet Commands** + rainbowstream -- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the - rainbow is god’s promise to noah’*. +and see your stream. -- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of - each tweet beside the time. +I shipped a feature which can display **tweet's images directly on terminal**. +You can try it with: -- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*. +.. code:: bash -- ``fav 12`` will favorite the tweet with *[id=12]*. + rainbowstream -iot # Or rainbowstream --image-on-term -- ``ufav 12`` will unfavorite tweet with *[id=12]*. +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). -- ``del 12`` will delete tweet with *[id=12]*. +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. -- ``show image 12`` will show the image in tweet with *[id=12]* in your - OS’s image viewer. +You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are +provided as follows: -**Direct Messages Commands** +.. code:: bash -- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7 - messages. + rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP + # or using the short form: + rainbowstream -ph localhost -pp 1337 -pt HTTP -- ``sent`` will show sent messages. ``sent 7`` will show newest 7 - messages. +Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default +proxy port ``8080`` and default proxy type ``SOCKS5`` are used. -- ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88. +The interactive mode +^^^^^^^^^^^^^^^^^^^^ -- ``trash 5`` will remove message with *[message\_id=5]* +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. -**Friends and followers Commands** +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. -- ``ls fl`` will list all your followers (people who are following - you). +Available commands are listed in `Read The Docs`_. -- ``ls fr`` will list all your friends (people who you are following). +Theme customization +^^^^^^^^^^^^^^^^^^^ -- ``fl @dtvd88`` will follow @dtvd88. +Rainbow Stream is shipped with some default themes. +You can either change theme by ``theme`` command or create your favorite one. -- ``ufl @dtvd88`` will unfollow @dtvd88. +Theme’s screenshot: -- ``mute @dtvd88`` will mute @dtvd88. +- Monokai -- ``unmute @dtvd88`` will unmute @dtvd88. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png + :alt: monokai -- ``muting`` will list muting users. +- Solarized -- ``block @dtvd88`` will block @dtvd88. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png + :alt: solarized -- ``unblock @dtvd88`` will unblock @dtvd88. +- Tomorrow Night -- ``report @dtvd88`` will report @dtvd88 as a spam account. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png + :alt: tomorrownight -**Screening Commands** +- Larapaste -- ``h`` will show the help. +.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png + :alt: larapaste -- ``c`` will clear the screen. +For detail information, see `theme usage and customization`_. -- ``q`` will quit. -**Switching Stream Commands** +Bug and feature requests +------------------------ -- ``switch public #AKB48`` will switch current stream to public stream - and track keyword ``AKB48`` +Found a bug or a feature request ? +Please `create an issue`_ or contact me at `@dtvd88`_ -- ``switch public #AKB48 -f`` will do exactly as above but will ask you - to provide 2 list: +Development +----------- - ``Only nicks`` decide what nicks will be include only. +If you want to build a runnable version yourself, follow these simple +steps - ``Ignore nicks``\ decide what nicks will be exclude. +- `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 -- ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and - *IGNORE\_LIST*. You can setup 2 list above at ``config.py`` + .. code:: python -- ``switch mine`` will switch current stream to personal stream. ``-f`` - and ``-d`` will work as well. + # 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 + .. 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 ------- @@ -186,6 +215,16 @@ 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 +.. _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