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
+The recommended way\r
+^^^^^^^^^^^^^^^^^^^\r
\r
-or try with a virtualenv\r
+Use `virtualenv`_\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
+ # 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
\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
.. _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