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