add documents

[rainbowstream.git] / README.rst

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
This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
\r
Showcase\r
----------\r
Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
\r
\r
Install\r
-------\r
\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
    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
The stream\r
^^^^^^^^^^\r
\r
Just type\r
\r
.. code:: bash\r
\r
    rainbowstream\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
--------------------\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
\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. Input history from previous run is available as well.\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
\r
For detaile information, see `theme usage and customization`_.\r
\r
Bug and feature requests\r
------------------------\r
\r
Found a bug or a feature request ?\r
Please `create an issue`_ or contact me at `@dtvd88`_\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
   .. code:: bash\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
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
Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
details\r
\r
\r
.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\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
.. _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