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
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
.. 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
Troubleshooting\r
^^^^^^^^^^^^^^^\r
\r
-If you use Linux, you might need to install some packages if you haven't already. \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 libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\r
+ sudo apt-get install python-dev libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-dev\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
\r
If installation in *the quick way* doesn't work:\r
\r
-- `sudo pip uninstall rainbowstream`\r
+- ``sudo pip uninstall rainbowstream``\r
- use the *virtualenv way* above\r
- `create an issue`_ and provide:\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
+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
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
.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
:alt: larapaste\r
\r
-For detaile information, see `theme usage and customization`_.\r
+For detail information, see `theme usage and customization`_.\r
\r
\r
Bug and feature requests\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