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
\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
- ``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
\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
\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
\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
.. _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