RTV (Reddit Terminal Viewer)
Installation
Install using pip (recommended)
$ pip install rtv
or clone the repository
$ git clone https://github.com/michael-lazar/rtv.git
$ cd rtv
$ python3 setup.py install
on Arch Linux or Arch based distros (Antergos, Manjaro, etc.) you can install directly with an aur helper such as yaourt.
$ yaourt -S rtv
$ # or to keep up to date with the master branch
$ yaourt -S rtv-git
Usage
To run the program, type
$ rtv --help
Controls
Move the cursor using either the arrow keys or Vim style movement
Press up and down to scroll through submissions
Press right to view the selected submission and left to return
Press space to expand/collapse comments
Press u to login
Press ? to open the help screen
Press / to open the navigation prompt, where you can type things like
/front
/r/commandprompt+linuxmasterrace
/r/programming/controversial-week
/u/me
/u/multi-mod/m/art
/domain/github.com
See CONTROLS for the full list of commands.
Settings
Configuration
Configuration settings are stored in {HOME}/.config/rtv/rtv.cfg. Auto-generate the config file by running
$ rtv --copy-config
See the default config for the full list of settings.
Editor
You can compose posts and reply to comments using your preferred text editor. Set the editor by changing $RTV_EDITOR in your environment.
$ export RTV_EDITOR=gedit
If not specified, the default system $EDITOR (or nano) will be used.
Web Browser
You can open submission links using your web browser. On most systems the default web browser will open in a new window. If you prefer the complete terminal experience, set $BROWSER to a console-based web browser.
$ export BROWSER=w3m
Url Viewer
You can extract links from inside of comments using urlview. Use $RTV_URLVIEWER to specify a custom url viewer.
$ export RTV_URLVIEWER=urlview
urlview and urlscan are known to be compatible, but any program that accepts text via a stdin pipe will do. These applications don't come pre-installed, but are available through most systems' package managers.
FAQ
- Why am I getting an error during installation/when launching rtv?
If your distro ships with an older version of python 2.7 or python-requests, you may experience SSL errors or other package incompatibilities. The easiest way to fix this is to install rtv using python 3. If you don't already have pip3, see http://stackoverflow.com/a/6587528 for setup instructions. Then do
$ sudo pip uninstall rtv $ sudo pip3 install -U rtv- How do I run the repository code directly?
This project is structured to be run as a python module. This means that in order to resolve imports you need to launch using python's -m flag. This method works for all versions of python. See the example below, which assumes that you have cloned the repository into the directory ~/rtv_project.
$ cd ~/rtv_project $ python3 -m rtv
Contributing
All feedback and suggestions are welcome, just post an issue!
Before writing any code, please read the Contributor Guidelines.
License
This project is distributed under the MIT license.