document
[rainbowstream.git] / README.rst
1 Rainbow Stream\r
2 --------------\r
3 \r
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
9 \r
10 Terminal-based Twitter Client. Realtime tweetstream, compose, search ,\r
11 favorite … and much more fun directly from terminal.\r
12 \r
13 This package is built on the top of `Python Twitter Tool`_ and `Twitter API`_.\r
14 \r
15 Showcase\r
16 ----------\r
17 Screencast: https://www.youtube.com/watch?v=tykCvPMJq8s\r
18 \r
19 Screenshot:\r
20 \r
21 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStream.png\r
22    :alt: rainbowstream\r
23 \r
24 .. figure:: https://raw.githubusercontent.com/DTVD/rainbowstream/master/screenshot/RainbowStreamIOT.png\r
25    :alt: rainbowstreamIOT\r
26 \r
27 Install\r
28 -------\r
29 \r
30 You will need Python 2.7+ and pip.\r
31 \r
32 .. code:: bash\r
33 \r
34     sudo pip install rainbowstream\r
35 \r
36 or try with a virtualenv\r
37 \r
38 .. code:: bash\r
39 \r
40     sudo pip install virtualenv # skip if you already have virtualenv\r
41     virtualenv venv\r
42     source venv/bin/activate # use the brand new virtualenv.\r
43     pip install rainbowstream\r
44 \r
45 Usage\r
46 -----\r
47 \r
48 The stream\r
49 ^^^^^^^^^^\r
50 \r
51 Just type\r
52 \r
53 .. code:: bash\r
54 \r
55     rainbow\r
56 \r
57 and see your stream.\r
58 \r
59 I shipped a feature which can display **tweet's images directly on terminal**.\r
60 You can try it with:\r
61 \r
62 .. code:: bash\r
63 \r
64     rainbow -iot # Or rainbow --image-on-term\r
65 \r
66 In the first time you will be asked for authorization of Rainbow Stream\r
67 app at Twitter. Just click the “Authorize access” button and paste PIN\r
68 number to the terminal, the rainbow will start.\r
69 \r
70 The interactive mode\r
71 --------------------\r
72 \r
73 While your personal stream is continued, you are also ready to tweet,\r
74 search, reply, retweet… directly from console. Simply type “h” and hit\r
75 the Enter key to see the help.\r
76 \r
77 Input is in interactive mode. It means that you can use arrow key to\r
78 move up and down history, tab-autocomplete or 2 tab to view available\r
79 suggestion. Input history from previous run is available as well.\r
80 \r
81 For available commands, please `Read The Docs`_.\r
82 \r
83 For themes and color setting, see `config guide`_.\r
84 \r
85 Bug and feature requests\r
86 ------------------------\r
87 \r
88 Found a bug or a feature request ?\r
89 Please `create an issue`_ or contact me at `@dtvd88`_\r
90 \r
91 Contributing\r
92 ------------\r
93 I appreciate any help and support. Feel free to `fork`_ and `create a pull request`_.\r
94 You will be listed as contributor.\r
95 \r
96 License\r
97 -------\r
98 \r
99 Rainbow Stream are released under an MIT License. See LICENSE.txt for\r
100 details\r
101 \r
102 \r
103 .. _Python Twitter Tool: http://mike.verdone.ca/twitter/\r
104 .. _Twitter API: https://dev.twitter.com/docs/api/1.1\r
105 .. _create an issue: https://github.com/DTVD/rainbowstream/issues/new\r
106 .. _@dtvd88: https://twitter.com/dtvd88\r
107 .. _fork: https://github.com/DTVD/rainbowstream/fork\r
108 .. _create a pull request: https://github.com/DTVD/rainbowstream/compare/\r
109 .. _Read The Docs: http://rainbowstream.readthedocs.org/en/latest/\r
110 .. _config guide: #\r