autopep8 and bumped version
[rainbowstream.git] / README.rst
index a0e038b..6ec76fe 100644 (file)
@@ -10,38 +10,47 @@ Rainbow Stream
 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
+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
-Screenshot: \r
-\r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
-   :alt: rainbowstream\r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
-   :alt: rainbowstreamIOT\r
+Screenshot: (click to see)\r
 \r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
+   :alt: all\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
+\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
@@ -52,7 +61,7 @@ Just type
 \r
 .. code:: bash\r
 \r
-    rainbow\r
+    rainbowstream\r
 \r
 and see your stream.\r
 \r
@@ -61,14 +70,14 @@ You can try it with:
 \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
 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
@@ -78,124 +87,76 @@ 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\r
 suggestion. Input history from previous run is available as well.\r
 \r
-Here is full list of supported command:\r
-\r
-**Explore Commands**\r
-\r
--  ``trend`` will show global trending topics. ``trend US`` will show\r
-   trends in United States while ``trend JP Tokyo`` will show trends in\r
-   Tokyo/Japan.\r
-\r
--  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
-   tweets.\r
-\r
--  ``mentions`` will show mentions timeline. ``mentions 7`` will show 7\r
-   mention tweets.\r
-\r
--  ``whois @dtvd88`` will show profile of @dtvd88.\r
-\r
--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
-   exactly 9 tweets.\r
-\r
--  ``s #noah`` will search the word *‘noah’*. Result will come back with\r
-   highlight.\r
-\r
-**Tweet Commands**\r
-\r
--  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
-   rainbow is god’s promise to noah’*.\r
-\r
--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
-   each tweet beside the time.\r
-\r
--  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
-\r
--  ``fav 12`` will favorite the tweet with *[id=12]*.\r
+Available commands are listed in `Read The Docs`_.\r
 \r
--  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
-\r
--  ``del 12`` will delete tweet with *[id=12]*.\r
-\r
--  ``show image 12`` will show the image in tweet with *[id=12]* in your\r
-   OS’s image viewer.\r
-\r
-**Direct Messages Commands**\r
-\r
--  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
-   messages.\r
-\r
--  ``sent`` will show sent messages. ``sent 7`` will show newest 7\r
-   messages.\r
-\r
--  ``mes @dtvd88 hi`` will send a ``hi`` message to @dtvd88.\r
-\r
--  ``trash 5`` will remove message with *[message\_id=5]*\r
-\r
-**Friends and followers Commands**\r
-\r
--  ``ls fl`` will list all your followers (people who are following\r
-   you).\r
-\r
--  ``ls fr`` will list all your friends (people who you are following).\r
-\r
--  ``fl @dtvd88`` will follow @dtvd88.\r
-\r
--  ``ufl @dtvd88`` will unfollow @dtvd88.\r
-\r
--  ``mute @dtvd88`` will mute @dtvd88.\r
+Theme customization\r
+------------------------\r
 \r
--  ``unmute @dtvd88`` will unmute @dtvd88.\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
--  ``muting`` will list muting users.\r
+Theme’s screenshot:\r
 \r
--  ``block @dtvd88`` will block @dtvd88.\r
+- Monokai\r
 \r
--  ``unblock @dtvd88`` will unblock @dtvd88.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
+   :alt: monokai\r
 \r
--  ``report @dtvd88`` will report @dtvd88 as a spam account.\r
+- Solarized\r
 \r
-**Screening Commands**\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
+   :alt: solarized\r
 \r
--  ``h`` will show the help.\r
+- Tomorrow Night\r
 \r
--  ``c`` will clear the screen.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+   :alt: tomorrownight\r
 \r
--  ``q`` will quit.\r
+- Larapaste\r
 \r
-**Switching Stream Commands**\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+   :alt: larapaste\r
 \r
--  ``switch public #AKB48`` will switch current stream to public stream\r
-   and track keyword ``AKB48``\r
 \r
--  ``switch public #AKB48 -f`` will do exactly as above but will ask you\r
-   to provide 2 list:\r
+For detaile information, see `theme usage and customization`_.\r
 \r
-   ``Only nicks`` decide what nicks will be include only.\r
+Bug and feature requests\r
+------------------------\r
 \r
-   ``Ignore nicks``\ decide what nicks will be exclude.\r
+Found a bug or a feature request ?\r
+Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
--  ``switch public #AKB48 -d`` will apply filter to *ONLY\_LIST* and\r
-   *IGNORE\_LIST*. You can setup 2 list above at ``config.py``\r
+Development\r
+-----------\r
 \r
--  ``switch mine`` will switch current stream to personal stream. ``-f``\r
-   and ``-d`` will work as well.\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
 \r
-**Smart shell**\r
+-  `Create your own Twitter Application`_\r
+-  Get your Twitter application’s API key and secret\r
+-  Fork this repo and clone in your system.\r
+-  Create a file ``consumer.py`` in `rainbowstream`_ folder with\r
+   following content\r
 \r
-- Put anything to terminal, the app will try to eval and display result as a python interactive shell.\r
+   .. code:: python\r
 \r
-  + ``142857*2`` or ``101**3`` like a calculator.\r
-  + Even ``cal`` will show the calendar for current month.\r
-  + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
+       # Consumer information\r
+       CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
+       CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
 \r
+-  Use pip to install in local\r
 \r
-For example see the screenshot above.\r
+   .. code:: bash\r
 \r
-Bug and feature requests\r
-------------------------\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
+       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
-Found a bug or a feature request ? \r
-Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 Contributing\r
 ------------\r
@@ -215,3 +176,9 @@ details
 .. _@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
+.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
+.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
+.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\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