version
[rainbowstream.git] / docs / index.rst
index 4f14854..8b4e1d8 100644 (file)
@@ -10,26 +10,36 @@ Rainbow Stream
 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
 favorite … and much more fun directly from terminal.\r
 \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
+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
 \r
 Install\r
 -------\r
 \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
 .. 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
 \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
     pip install rainbowstream\r
 \r
+\r
 Usage\r
 -----\r
 \r
 Usage\r
 -----\r
 \r
@@ -40,7 +50,7 @@ Just type
 \r
 .. code:: bash\r
 \r
 \r
 .. code:: bash\r
 \r
-    rainbow\r
+    rainbowstream\r
 \r
 and see your stream.\r
 \r
 \r
 and see your stream.\r
 \r
@@ -49,7 +59,7 @@ You can try it with:
 \r
 .. code:: bash\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
 \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
@@ -96,6 +106,9 @@ Here is full list of supported command:
 -  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
    each tweet beside the time.\r
 \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
 -  ``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
@@ -109,6 +122,9 @@ Here is full list of supported command:
 -  ``show image 12`` will show the image in tweet with *[id=12]* in your\r
    OS’s image viewer.\r
 \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
 **Direct Messages Commands**\r
 \r
 -  ``inbox`` will show inbox messages. ``inbox 7`` will show newest 7\r
@@ -144,6 +160,32 @@ Here is full list of supported command:
 \r
 -  ``report @dtvd88`` will report @dtvd88 as a spam account.\r
 \r
 \r
 -  ``report @dtvd88`` will report @dtvd88 as a spam account.\r
 \r
+**Twitter list**\r
+\r
+-  ``list`` will show all lists you are belong to.\r
+\r
+-  ``list home`` will show timeline of list. You will be asked for list's name.\r
+\r
+-  ``list all_mem`` will show list's all members.\r
+\r
+-  ``list all_sub`` will show list's all subscribers.\r
+\r
+-  ``list add`` will add specific person to a list owned by you.\r
+\r
+-  ``list rm`` will remove specific person from a list owned by you.\r
+\r
+-  ``list sub`` will subscribe you to a specific list.\r
+\r
+-  ``list unsub`` will unsubscribe you from a specific list.\r
+\r
+-  ``list own`` will show all list owned by you.\r
+\r
+-  ``list new`` will create a new list.\r
+\r
+-  ``list update`` will update a list owned by you.\r
+\r
+-  ``list del`` will delete a list owned by you.\r
+\r
 **Switching Stream Commands**\r
 \r
 -  ``switch public #AKB48`` will switch current stream to public stream\r
 **Switching Stream Commands**\r
 \r
 -  ``switch public #AKB48`` will switch current stream to public stream\r
@@ -172,14 +214,81 @@ Here is full list of supported command:
 \r
 **Screening Commands**\r
 \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
 -  ``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
+Theme customization\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
+\r
+Theme’s screenshot:\r
+\r
+- Monokai\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
+For detaile information, see `theme usage and customization`_.\r
+\r
+Development\r
+-----------\r
+\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
+\r
+-  `Create your own Twitter Application`_\r
+-  Get your Twitter application’s API key and secret\r
+-  Fork github's repo\r
+-  Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
+   following content\r
+\r
+   .. code:: python\r
+\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
 \r
+   .. code:: bash\r
 \r
 \r
+       # cd to directory which contains setup.py\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
+       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
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\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