add list support and seperate help
[rainbowstream.git] / README.rst
CommitLineData
3108149e 1Rainbow Stream\r
2--------------\r
3\r
3216f3f4
O
4.. image:: http://img.shields.io/pypi/dm/rainbowstream.svg?style=flat\r
5 :target: https://pypi.python.org/pypi/rainbowstream\r
6\r
7.. image:: http://img.shields.io/pypi/v/rainbowstream.svg?style=flat\r
8 :target: https://pypi.python.org/pypi/rainbowstream\r
c96321cc 9\r
3108149e 10Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11favorite … and much more fun directly from terminal.\r
12\r
3216f3f4 13This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
3108149e 14\r
456019d6 15Showcase\r
3108149e 16----------\r
b84845b9 17Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
456019d6 18\r
3216f3f4 19\r
3108149e 20Install\r
21-------\r
22\r
23You will need Python 2.7+ and pip.\r
24\r
25.. code:: bash\r
26\r
fd9cd791 27 sudo pip install rainbowstream\r
b84845b9 28\r
a011e0e2 29or try with a virtualenv\r
fd9cd791
O
30\r
31.. code:: bash\r
32\r
33 sudo pip install virtualenv # skip if you already have virtualenv\r
b84845b9 34 virtualenv venv\r
fd9cd791 35 source venv/bin/activate # use the brand new virtualenv.\r
3108149e 36 pip install rainbowstream\r
37\r
38Usage\r
39-----\r
40\r
41The stream\r
42^^^^^^^^^^\r
43\r
44Just type\r
45\r
46.. code:: bash\r
47\r
9f37426f 48 rainbowstream\r
3108149e 49\r
50and see your stream.\r
51\r
3216f3f4
O
52I shipped a feature which can display **tweet's images directly on terminal**.\r
53You can try it with:\r
4373c17c
O
54\r
55.. code:: bash\r
56\r
9f37426f 57 rainbowstream -iot # Or rainbowstream --image-on-term\r
4373c17c 58\r
3108149e 59In the first time you will be asked for authorization of Rainbow Stream\r
60app at Twitter. Just click the “Authorize access” button and paste PIN\r
3216f3f4 61number to the terminal, the rainbow will start.\r
3108149e 62\r
63The interactive mode\r
c1a3d5e5 64--------------------\r
3108149e 65\r
66While your personal stream is continued, you are also ready to tweet,\r
67search, reply, retweet… directly from console. Simply type “h” and hit\r
f5677fb1 68the Enter key to see the help.\r
3108149e 69\r
70Input is in interactive mode. It means that you can use arrow key to\r
71move up and down history, tab-autocomplete or 2 tab to view available\r
f5677fb1 72suggestion. Input history from previous run is available as well.\r
3108149e 73\r
b913cd75 74Available commands are listed in `Read The Docs`_.\r
3108149e 75\r
b913cd75
O
76Theme customization\r
77------------------------\r
78\r
06302419 79Rainbow Stream is shipped with some default themes.\r
b913cd75
O
80You can either change theme by ``theme`` command or create your favorite one.\r
81\r
547283bf 82Theme’s screenshot:\r
19d6c002 83\r
06302419
O
84- Monokai\r
85\r
547283bf
O
86.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Monokai.png\r
87 :alt: monokai\r
19d6c002 88\r
06302419
O
89- Solarized\r
90\r
547283bf
O
91.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/Solarized.png\r
92 :alt: solarized\r
93\r
98258022
O
94- Tomorrow Night\r
95\r
96.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/TomorrowNight.png\r
97 :alt: tomorrownight\r
98\r
99- Larapaste\r
100\r
101.. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/themes/larapaste.png\r
102 :alt: larapaste\r
103\r
104\r
b913cd75 105For detaile information, see `theme usage and customization`_.\r
3108149e 106\r
050c4214 107Bug and feature requests\r
36e1924e 108------------------------\r
3108149e 109\r
b84845b9 110Found a bug or a feature request ?\r
3216f3f4 111Please `create an issue`_ or contact me at `@dtvd88`_\r
3108149e 112\r
2d341029
O
113Development\r
114-----------\r
115\r
116If you want to build a runnable version yourself, follow these simple\r
117steps\r
118\r
119- `Create your own Twitter Application`_\r
120- Get your Twitter application’s API key and secret\r
121- Fork github's repo\r
122- Create a file ``consumer.py`` in ```rainbowstream```_ folder with\r
123 following content\r
124\r
125 .. code:: python\r
126\r
127 # Consumer information\r
128 CONSUMER_KEY = 'APIKey' # Your Twitter application's API key\r
129 CONSUMER_SECRET = 'APISecret' # Your Twitter application's API secret\r
130\r
131- Use pip to install in local\r
132\r
133 .. code:: bash\r
134\r
135 # cd to directory which contains setup.py\r
136 virtualenv venv # Python3 users: use -p to specify python3\r
137 source venv/bin/activate\r
138 pip install -e .\r
139 pip list | grep rainbowstream # confirm installed version\r
140 rainbowstream # local version of rainbowstream\r
141\r
142\r
050c4214 143Contributing\r
36e1924e 144------------\r
050c4214
O
145I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
146You will be listed as contributor.\r
147\r
3108149e 148License\r
149-------\r
150\r
151Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
152details\r
153\r
154\r
155.. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
bade45d4 156.. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
3108149e 157.. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
3216f3f4 158.. _@dtvd88: https://twitter.com/dtvd88\r
050c4214
O
159.. _fork: https://github.com/DTVD/rainbowstream/fork\r
160.. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
670e8049 161.. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
b52327dc 162.. _config guide: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
b913cd75 163.. _theme usage and customization: https://github.com/DTVD/rainbowstream/blob/master/theme.md\r
2d341029
O
164.. _Create your own Twitter Application: https://apps.twitter.com/app/new\r
165.. _``rainbowstream``: https://github.com/DTVD/rainbowstream/tree/master/rainbowstream\r