Update README.rst

[rainbowstream.git] / README.rst

diff --git a/README.rst b/README.rst
index a6343400d603223d0774d5f4be62543179fa6485..718ac208e5f9e1884215a9d1e0ca2331592f0d32 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -10,27 +10,57 @@ 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 build on the top of `Python Twitter Tool`_ and `Twitter\r
-Streaming API`_ and inspired by `EarthQuake`_\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

-Screenshot\r
-----------\r

 \r
 \r

-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
-   :alt: v0.0.1\r
+Showcase\r
+--------\r

 \r
 \r

-.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
-   :alt: v0.0.3\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/rs.gif\r
+   :alt: gif\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
+    # Python 3 users: sudo pip3 install rainbowstream\r
+\r
+\r
+The recommended way\r
+^^^^^^^^^^^^^^^^^^^\r
+\r
+Use `virtualenv`_\r

 \r
 .. code:: bash\r
 \r
 \r
 .. code:: bash\r
 \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

+Troubleshooting\r
+^^^^^^^^^^^^^^^\r
+\r
+If you use Linux, you might need to install the some packages 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 libjpeg libjpeg-dev libfreetype6 libfreetype6-dev zlib1g-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
 Usage\r
 -----\r
 \r


@@ -41,7 +71,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


@@ -50,7 +80,13 @@ 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
+You also can change the config key ``IMAGE_ON_TERM`` to ``True`` inside the app \r
+to enable above feature, \r
+change ``IMAGE_SHIFT`` to set image's margin (relative to your terminal's width) \r
+or ``IMAGE_MAX_HEIGHT`` to control max height of every image.\r
+(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
 \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


@@ -67,85 +103,81 @@ 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
 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
-**Stream Command**\r
-\r
--  ``switch public #AKB48`` will switch current stream to public stream 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
-\r
-   ``Only nicks`` decide what nicks will be include only.\r
+Available commands are listed in `Read The Docs`_.\r

 \r
 \r

-   ``Ignore nicks`` decide what nicks will be exclude.\r
+Theme customization\r
+^^^^^^^^^^^^^^^^^^^\r

 \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
+Rainbow Stream is shipped with some default themes.\r
+You can either change theme by ``theme`` command or create your favorite one.\r

 \r
 \r

--  ``switch mine`` will switch current stream to personal stream. ``-f``\r
-   and ``-d`` will work as well.\r
+Theme’s screenshot:\r

 \r
 \r

-**Action Command**\r
+- Monokai\r

 \r
 \r

--  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
-   tweets.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
+   :alt: monokai\r

 \r
 \r

--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
-   exactly 9 tweets.\r
+- Solarized\r

 \r
 \r

--  ``mentions`` will show mentions timeline. ``mentions 7`` will show\r
-   7 mention tweets.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
+   :alt: solarized\r

 \r
 \r

--  ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
-   rainbow is god’s promise to noah’*\r
+- Tomorrow Night\r

 \r
 \r

--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
-   each tweet beside the time.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+   :alt: tomorrownight\r

 \r
 \r

--  ``fav 12`` will favorite the tweet with *[id=12]*.\r
+- Larapaste\r

 \r
 \r

--  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+   :alt: larapaste\r

 \r
 \r

--  ``del 12`` will delete tweet with *[id=12]*.\r
+For detaile information, see `theme usage and customization`_.\r

 \r
 \r

--  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r

 \r
 \r

--  ``s #noah`` will search the word *‘noah’*. Result will come back\r
-   with highlight.\r
+Bug and feature requests\r
+------------------------\r

 \r
 \r

--  ``show image 12`` will show the image in tweet with *[id=12]* in your OS's image viewer.\r
-\r
--  ``ls fl`` will list all your followers (people who are following you).\r
-\r
--  ``ls fr`` will list all your friends (people who you are following).\r
-\r
--  ``inbox`` will show inbox messages. ``inbox 7`` will show newest\r
-   7 message.\r
-\r
--  ``sent`` will show sent messages. ``sent 7`` will show newest\r
-   7 message.\r
+Found a bug or a feature request ?\r
+Please `create an issue`_ or contact me at `@dtvd88`_\r

 \r
 \r

--  ``trash 5`` will remove message with *[message_id=5]*.\r
+Development\r
+-----------\r

 \r
 \r

--  ``whois @dtvd88`` will show profile of @dtvd88.\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r

 \r
 \r

--  ``fl @dtvd88`` will follow @dtvd88.\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
 \r

--  ``ufl @dtvd88`` will unfollow @dtvd88.\r
+   .. code:: python\r

 \r
 \r

--  ``h`` will show the help.\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
 \r

--  ``c`` will clear the screen.\r
+-  Use pip to install in local\r

 \r
 \r

--  ``q`` will quit.\r
+   .. code:: bash\r

 \r
 \r

-For example see the screenshot above.\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
 \r

-Bug Report\r
-----------\r

 \r
 \r

-Please `create an issue`_ or contact me at `@dtvd88`_\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

 \r
 License\r
 -------\r
 \r
 License\r
 -------\r


@@ -155,7 +187,17 @@ details
 \r
 \r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
 \r
 \r
 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r

-.. _Twitter Streaming API: https://dev.twitter.com/docs/api/streaming\r
-.. _EarthQuake: https://github.com/jugyo/earthquake\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
 .. _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
+.. _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
+.. _config management: http://rainbowstream.readthedocs.org/en/latest/#config-explanation\r
+.. _clang unknown argument: http://kaspermunck.github.io/2014/03/fixing-clang-error/\r
+.. _Issue #10: https://github.com/DTVD/rainbowstream/issues/10\r