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+ and 3.2+.\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
\r
Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
+--------\r
\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+ :alt: gif\r
\r
Install\r
-------\r
source venv/bin/activate\r
pip install rainbowstream\r
\r
+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install the python-dev package 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\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 take a look at `Issue #10`_ and let me know if the workaround doesn't work for you.\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 (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
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
-\r
For detaile information, see `theme usage and customization`_.\r
\r
+\r
Bug and feature requests\r
------------------------\r
\r
\r
- `Create your own Twitter Application`_\r
- Get your Twitter application’s API key and secret\r
-- Fork github's repo\r
+- Fork this repo and clone in your system.\r
- Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
following content\r
\r
\r
.. code:: bash\r
\r
- # cd to directory which contains setup.py\r
+ # cd to directory which contains setup.py (cloned directory)\r
virtualenv venv # Python3 users: use -p to specify python3\r
source venv/bin/activate\r
pip install -e .\r
- pip list | grep rainbowstream # confirm installed version\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
\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/#the-interactive-mode\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