\r
This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
\r
-Showcase\r
-----------\r
-Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s \r
-\r
-Screenshot: \r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
- :alt: rainbowstream\r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
- :alt: rainbowstreamIOT\r
-\r
Install\r
-------\r
\r
-You will need Python 2.7+ and pip.\r
+The quick way\r
+^^^^^^^^^^^^^\r
+\r
+You will need Python and pip (2.7.x or 3.x).\r
\r
.. code:: bash\r
\r
sudo pip install rainbowstream\r
- \r
-or try with a virtualenv\r
+ # Python 3 users: sudo pip3 install rainbowstream\r
+\r
+The recommended way\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+Use `virtualenv`_\r
\r
.. code:: bash\r
\r
- sudo pip install virtualenv # skip if you already have virtualenv\r
- virtualenv venv \r
- source venv/bin/activate # use the brand new virtualenv.\r
+ virtualenv venv\r
+ # Python 3 users : use -p to specify your Python 3 localtion as below\r
+ # virtualenv -p /usr/bin/python3 venv\r
+ source venv/bin/activate\r
pip install rainbowstream\r
\r
+\r
Usage\r
-----\r
\r
\r
.. code:: bash\r
\r
- rainbow\r
+ rainbowstream\r
\r
and see your stream.\r
\r
\r
.. code:: bash\r
\r
- rainbow -iot # Or rainbow --image-on-term\r
+ rainbowstream -iot # Or rainbowstream --image-on-term\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
- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
each tweet beside the time.\r
\r
+- ``quote 12`` will quote the tweet with *[id=12]*. If no extra text is added,\r
+ the quote will be cancelled.\r
+\r
- ``allrt 12 20`` will list 20 newest retweets of the tweet with *[id=12]*. If the number of retweets is not specified, 5 newest retweets will be listed instead.\r
\r
- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
- ``show image 12`` will show the image in tweet with *[id=12]* in your\r
OS’s image viewer.\r
\r
+- ``open 12`` will open url in tweet with *[id=12]* in your\r
+ OS’s default browser.\r
+\r
**Direct Messages Commands**\r
\r
- ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
\r
**Screening Commands**\r
\r
+- ``theme`` will list available themes. \r
+ \r
+ + ``theme monokai`` will apply *monokai* theme immedaitely.\r
+ + ``theme current_as_default`` will remember current theme as next time default.\r
+ \r
- ``h`` will show the help.\r
\r
- ``c`` will clear the screen.\r
\r
- ``q`` will quit.\r
\r
+Available commands are listed in `Read The Docs`_.\r
\r
-For example see the screenshot above.\r
+Theme customization\r
+^^^^^^^^^^^^^^^^^^^\r
\r
-Bug and feature requests\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
\r
-Found a bug or a feature request ? \r
-Please `create an issue`_ or contact me at `@dtvd88`_\r
+Theme’s screenshot:\r
\r
-Contributing\r
-------------\r
-I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
-You will be listed as contributor.\r
+- Monokai\r
\r
-License\r
--------\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
+ :alt: monokai\r
+\r
+- Solarized\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
+ :alt: solarized\r
+\r
+- Tomorrow Night\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+ :alt: tomorrownight\r
+\r
+- Larapaste\r
+\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+ :alt: larapaste\r
\r
-Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
-details\r
+For detaile information, see `theme usage and customization`_.\r
\r
\r
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
-.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
-.. _@dtvd88: https://twitter.com/dtvd88\r
-.. _fork: https://github.com/DTVD/rainbowstream/fork\r
-.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
+.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
+.. _virtualenv: http://docs.python-guide.org/en/latest/dev/virtualenvs/\r