autopep8 and bumped version
[rainbowstream.git] / README.rst
index 04f3395..6ec76fe 100644 (file)
@@ -1,28 +1,56 @@
 Rainbow Stream\r
 --------------\r
 \r
 Rainbow Stream\r
 --------------\r
 \r
+.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
+   :target: https://pypi.python.org/pypi/rainbowstream\r
+\r
+.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
+   :target: https://pypi.python.org/pypi/rainbowstream\r
+\r
 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/RainbowStreamvSS.png\r
-   :alt: v0.0.1\r
+Showcase\r
+----------\r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
 \r
 \r
+Screenshot: (click to see)\r
 \r
 \r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamAll.png\r
+   :alt: all\r
+   \r
 Install\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
 \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
+    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
@@ -33,85 +61,107 @@ 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
+I shipped a feature which can display **tweet's images directly on terminal**.\r
+You can try it with:\r
+\r
+.. code:: bash\r
+\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
 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
 \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
-the Enter key to see the help\r
+the Enter key to see the help.\r
 \r
 Input is in interactive mode. It means that you can use arrow key to\r
 move up and down history, tab-autocomplete or 2 tab to view available\r
 \r
 Input is in interactive mode. It means that you can use arrow key to\r
 move up and down history, tab-autocomplete or 2 tab to view available\r
-suggestion\r
+suggestion. Input history from previous run is available as well.\r
 \r
 \r
-Here is full list of supported command\r
+Available commands are listed in `Read The Docs`_.\r
 \r
 \r
-**Stream Command**\r
+Theme customization\r
+------------------------\r
 \r
 \r
--  ``switch public #AKB48`` will switch current stream to public stream and track keyword ``AKB48``\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 public #AKB48 -f`` will do exactly as above but will ask you\r
-   to provide 2 list:\r
+Theme’s screenshot:\r
 \r
 \r
-   ``Only nicks`` decide what nicks will be include only.\r
+- Monokai\r
 \r
 \r
-   ``Ignore nicks`` decide what nicks will be exclude.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
+   :alt: monokai\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
+- Solarized\r
 \r
 \r
--  ``switch mine`` will switch current stream to personal stream. ``-f``\r
-   and ``-d`` will work as well.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
+   :alt: solarized\r
 \r
 \r
-**Action Command**\r
+- Tomorrow Night\r
 \r
 \r
--  ``home`` will show your timeline. ``home 10`` will print exactly 10\r
-   tweet.\r
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
+   :alt: tomorrownight\r
 \r
 \r
--  ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
-   exactly 9 tweet.\r
+- Larapaste\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
+.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
+   :alt: larapaste\r
 \r
 \r
--  ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
-   each tweet beside the time.\r
 \r
 \r
--  ``fav 12`` will favorite the tweet with *[id=12]*.\r
+For detaile information, see `theme usage and customization`_.\r
 \r
 \r
--  ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
+Bug and feature requests\r
+------------------------\r
 \r
 \r
--  ``del 12`` will delete tweet with *[id=12]*.\r
+Found a bug or a feature request ?\r
+Please `create an issue`_ or contact me at `@dtvd88`_\r
 \r
 \r
--  ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
+Development\r
+-----------\r
 \r
 \r
--  ``s #noah`` will search the word *‘noah’*. Result will come back\r
-   with highlight.\r
+If you want to build a runnable version yourself, follow these simple\r
+steps\r
 \r
 \r
--  ``fr`` will list all friend (You are following people).\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
--  ``fl`` will list all follower.\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
@@ -121,7 +171,14 @@ 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