name mode size
resources 040000
rtv 040000
.gitignore 100644 9B
LICENSE 100644 1.08kB
README.rst 100644 2.11kB
setup.cfg 100644 22B
setup.py 100644 1.6kB
README.rst
====================== Reddit Terminal Viewer ====================== **Reddit Terminal Viewer (RTV)** is a lightweight browser for Reddit (www.reddit.com) built into a terminal window. RTV is built in Python and utilizes the **curses** library. It is compatible with a large range of terminal emulators on Linux and OSX systems. .. image:: /resources/demo.gif ------------ Installation ------------ Reddit Terminal Viewer is Py2/Py3 compatible. The quickest way to install is through pip. .. code-block:: bash $ sudo pip install rtv Alternatively, the repo can be installed directly using python setuptools. .. code-block:: bash $ git clone https://github.com/michael-lazar/rtv.git $ cd rtv $ sudo python setup.py install After the installation has finished, a script will be placed in the system path. The program can then be started by typing .. code-block:: bash $ rtv Additional options can be viewed with .. code-block:: bash $ rtv --help ----- Usage ----- RTV currently supports browsing both subreddits and individual submissions. In each mode the controls are slightly different. **Global Commands** :``Arrow Keys`` or ``hjkl``: RTV supports both the arrow keys and vim bindings for navigation. Move up and down to scroll through items on the page. :``r`` or ``F5``: Refresh the current page. :``q``: Quit the program. **Subreddit Mode** In subreddit mode you can browse through the top submissions on either the front page or a specific subreddit. :``Right`` or ``Enter``: Open the currently selected submission in a new page. :``/``: Open a prompt to switch to a different subreddit. For example, pressing ``/`` and typing *python* will open */r/python*. You can return to Reddit's front page by using the alias */r/front*. **Submission Mode** In submission mode you can view the self text for a submission and browse comments. :``Right`` or ``Enter``: Toggle the currently selected comment between hidden and visible. Alternatively, load additional comments identified by *[+] more comments*. :``Left``: Exit the submission page and return to the subreddit.