Rainbow Stream\r
--------------\r
\r
-.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
- :target: https://pypi.python.org/pypi/rainbowstream\r
+.. image:: http://img.shields.io/pypi/l/rainbowstream.svg?style=flat-square\r
+ :target: https://github.com/DTVD/rainbowstream/blob/master/LICENSE.txt\r
\r
-.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat-square\r
:target: https://pypi.python.org/pypi/rainbowstream\r
\r
-Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
+Terminal-based Twitter Client. Realtime tweetstream, compose, search,\r
favorite … and much more fun directly from terminal.\r
\r
-This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_, \r
-can run on Python 2.7.x and 3.4.x .\r
+This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_,\r
+can run on Python 2.7.x and 3.x .\r
+\r
+Home page : http://www.rainbowstream.org/\r
\r
+Source code : https://github.com/DTVD/rainbowstream\r
\r
Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
+--------\r
\r
-Screenshot: (click to see)\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+ :alt: gif\r
\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
- :alt: all\r
- \r
Install\r
-------\r
\r
.. code:: bash\r
\r
virtualenv venv\r
- # Python 3 users : use -p to specify your Python 3 localtion as below\r
+ # Python 3 users : use -p to specify your Python 3 location as below\r
# virtualenv -p /usr/bin/python3 venv\r
source venv/bin/activate\r
pip install rainbowstream\r
\r
+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install some packages if you haven't already.\r
+For debian-based distros, these can be installed with\r
+\r
+.. code:: bash\r
+\r
+ sudo apt-get install python-dev libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
+\r
+For CentOS:\r
+\r
+.. code:: bash\r
+\r
+ sudo yum install python-devel libjpeg-devel\r
+\r
+Besides, Mac OSX Maverick with Xcode 5.1 has a well-known `clang unknown argument`_ problem with\r
+the ``Pillow`` package installation - a dependency of this app.\r
+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.\r
+\r
+.. code:: bash\r
+\r
+ export ARCHFLAGS=-Wno-error=unused-command-line-argument-hard-error-in-future\r
+\r
+If installation in *the quick way* doesn't work:\r
+\r
+- ``sudo pip uninstall rainbowstream``\r
+- use the *virtualenv way* above\r
+- `create an issue`_ and provide:\r
+\r
+ + Your OS\r
+ + Your Python version\r
\r
Usage\r
-----\r
\r
rainbowstream -iot # Or rainbowstream --image-on-term\r
\r
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app\r
+to enable above feature,\r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width)\r
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
+(see `config management`_ section).\r
+\r
In the first time you will be asked for authorization of Rainbow Stream\r
app at Twitter. Just click the “Authorize access” button and paste PIN\r
number to the terminal, the rainbow will start.\r
\r
+You might want to use rainbowstream via an **HTTP/SOCKS proxy**. Proxy settings are\r
+provided as follows:\r
+\r
+.. code:: bash\r
+\r
+ rainbowstream --proxy-host localhost --proxy-port 1337 --proxy-type HTTP\r
+ # or using the short form:\r
+ rainbowstream -ph localhost -pp 1337 -pt HTTP\r
+\r
+Both ``--proxy-port`` and ``--proxy-type`` can be omitted. In this case default\r
+proxy port ``8080`` and default proxy type ``SOCKS5`` are used.\r
+\r
The interactive mode\r
---------------------\r
+^^^^^^^^^^^^^^^^^^^^\r
\r
While your personal stream is continued, you are also ready to tweet,\r
search, reply, retweet… directly from console. Simply type “h” and hit\r
Available commands are listed in `Read The Docs`_.\r
\r
Theme customization\r
-------------------------\r
+^^^^^^^^^^^^^^^^^^^\r
\r
Rainbow Stream is shipped with some default themes.\r
You can either change theme by ``theme`` command or create your favorite one.\r
.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
:alt: larapaste\r
\r
+For detail information, see `theme usage and customization`_.\r
\r
-For detaile information, see `theme usage and customization`_.\r
\r
Bug and feature requests\r
------------------------\r
source venv/bin/activate\r
pip install -e .\r
which rainbowstream # /this-directory/venv/bin/rainbowstream\r
- pip list | grep rainbowstream # rainbowstream (0.x.x, /this-directory)\r
# Remove ~/.rainbow_oauth if exists\r
rainbowstream # local version of rainbowstream\r
\r
.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
.. _rainbowstream: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r
.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r
projects / rainbowstream.git / blobdiff