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
\r
-Screenshot\r
+Showcase\r
----------\r
+Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
+\r
+Screenshot:\r
\r
.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
- :alt: v0.0.1\r
+ :alt: rainbowstream\r
\r
.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
- :alt: v0.0.3\r
+ :alt: rainbowstreamIOT\r
\r
Install\r
-------\r
\r
.. code:: bash\r
\r
+ sudo pip install rainbowstream\r
+\r
+or try with a 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
pip install rainbowstream\r
\r
Usage\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
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
-\r
- ``Ignore nicks`` decide what nicks will be exclude.\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
-\r
-- ``switch mine`` will switch current stream to personal stream. ``-f``\r
- and ``-d`` will work as well.\r
-\r
-**Action Command**\r
-\r
-- ``home`` will show your timeline. ``home 10`` will print exactly 10\r
- tweet.\r
-\r
-- ``view @mdo`` will show @mdo ’s timeline. ``view @dmo 9`` will print\r
- exactly 9 tweet.\r
-\r
-- ``t the rainbow is god's promise to noah`` will tweet exactly *‘the\r
- rainbow is god’s promise to noah’*\r
+For available commands, please `Read The Docs`_.\r
\r
-- ``rt 12`` will retweet the tweet with *[id=12]*. You can see id of\r
- each tweet beside the time.\r
+For themes and color setting, see `config guide`_.\r
\r
-- ``fav 12`` will favorite the tweet with *[id=12]*.\r
-\r
-- ``rep 12 Really`` will reply *‘Really’* to the tweet with *[id=12]*.\r
-\r
-- ``del 12`` will delete tweet with *[id=12]*.\r
-\r
-- ``ufav 12`` will unfavorite tweet with *[id=12]*.\r
-\r
-- ``s #noah`` will search the word *‘noah’*. Result will come back\r
- with highlight.\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
-- ``fl @dtvd88`` will follow @dtvd88.\r
-\r
-- ``ufl @dtvd88`` will unfollow @dtvd88.\r
-\r
-- ``h`` will show the help.\r
-\r
-- ``c`` will clear the screen.\r
-\r
-- ``q`` will quit.\r
-\r
-For example see the screenshot above.\r
-\r
-Bug Report\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
+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
\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
+.. _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
projects / rainbowstream.git / blobdiff