sphinx
[rainbowstream.git] / docs / index.rst
index 08a98d4..f60f42a 100644 (file)
@@ -10,7 +10,8 @@ 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
 Install\r
 -------\r
@@ -94,8 +95,8 @@ Here is full list of supported command:
 -  ``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
+-  ``s noah`` will search the word *‘noah’*. Result will come back with\r
+   highlight. Search can be performed with or without hashtag.\r
 \r
 **Tweet Commands**\r
 \r
@@ -170,10 +171,8 @@ Here is full list of supported command:
 -  ``list all_sub`` will show list's all subscribers.\r
 \r
 -  ``list add`` will add specific person to a list owned by you.\r
-    You will be asked for list's name and person's name.\r
 \r
 -  ``list rm`` will remove specific person from a list owned by you.\r
-    You will be asked for list's name and person's name.\r
 \r
 -  ``list sub`` will subscribe you to a specific list.\r
 \r
@@ -213,13 +212,21 @@ Here is full list of supported command:
   + Even ``cal`` will show the calendar for current month.\r
   + Put ``order_rainbow('anything')`` or ``random_rainbow('wahahaha')`` will make more fun :)\r
 \r
-**Screening Commands**\r
+**Config Management**\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
+-  ``config`` will list all config key.\r
+\r
+  + ``config ASCII_ART`` will output current value of *ASCII_ART* config key.\r
+  + ``config ASCII_ART default`` will output default value of *ASCII_ART* config key.\r
+  + ``config ASCII_ART = False`` will set value of *ASCII_ART* config key to *False*.\r
+\r
+**Screening Commands**\r
+\r
 -  ``h`` will show the help.\r
 \r
 -  ``c`` will clear the screen.\r
@@ -258,6 +265,44 @@ Theme’s screenshot:
 \r
 For detaile information, see `theme usage and customization`_.\r
 \r
+Config explanation\r
+^^^^^^^^^^^^^^^^^^\r
+\r
+Rainbow Stream has a config file located at ``~/.rainbow_config.json``.\r
+You can view or set a new value of every config key by ``config`` command (See **Interactive mode** section above).\r
+\r
+-  ``THEME``: current theme.\r
+\r
+-  ``ASCII_ART``: diplay your twitter name by ascii art at stream begin or not.\r
+\r
+-  ``SEARCH_MAX_RECORD``: max tweets can display on 'search' command.\r
+\r
+-  ``HOME_TWEET_NUM``: default tweets to display on 'home' command.\r
+\r
+-  ``RETWEETS_SHOW_NUM``: default tweets to display on 'allrt' command.\r
+\r
+-  ``MESSAGES_DISPLAY``: default messages to display on 'inbox' or 'sent' command.\r
+\r
+-  ``TREND_MAX``: default trends to display on 'trend' command.\r
+\r
+-  ``LIST_MAX``: default tweets to display on 'list home' command.\r
+\r
+-  ``ONLY_LIST``: filter list on 'switch' command.\r
+\r
+-  ``IGNORE_LIST``: ignore list on 'switch' command.\r
+\r
+-  ``HISTORY_FILENAME``: name of file which stores input history.\r
+\r
+-  ``IMAGE_SHIFT``: left and right margin of image in '-iot'/'--image-on-term' mode.\r
+\r
+-  ``IMAGE_MAX_HEIGHT``: max height of image in '-iot'/'--image-on-term' mode.\r
+\r
+-  ``USER_DOMAIN``: user URL of Twitter Streaming API.\r
+\r
+-  ``PUBLIC_DOMAIN``: public URL of Twitter Streaming API.\r
+\r
+-  ``SITE_DOMAIN``: site URL of Twitter Streaming API.\r
+\r
 Development\r
 -----------\r
 \r
@@ -266,7 +311,7 @@ steps
 \r
 -  `Create your own Twitter Application`_\r
 -  Get your Twitter application’s API key and secret\r
--  Fork github's repo\r
+-  Fork github's repo and clone in your system.\r
 -  Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
    following content\r
 \r
@@ -280,11 +325,13 @@ steps
 \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
 .. _Create your own Twitter Application: https://apps.twitter.com/app/new\r