Skip to content

Latest commit

 

History

History
233 lines (173 loc) · 8.26 KB

README.md

File metadata and controls

233 lines (173 loc) · 8.26 KB
Raw

Sorry do not have time to work on this project. I am going to archive it. I have over estimated the tildeverse community interest in seeing this project continue. Thanks to everyone that has put some time in to offering up some PR's.

Tilde Terminal Reddit Viewer (TTRV)

Forked from Original source/development at: RTV

A text-based interface (TUI) to view and interact with Reddit from your terminal.

title image

Table of Contents

Demo

title image

Installation

PyPI package

TTRV is available on PyPI and can be installed with pip:

$ pip install ttrv

From source

$ git clone https://github.com/tildeclub/ttrv.git
$ cd ttrv/
$ python setup.py install

IMPORTANT: you will need to configure appropriate OAuth2 client ID and secrets in settings. Request one from reddit (client_id is the opaque string in the upper left corner, below your app's name, while the client_secret is the value of Secret).

Windows

TTRV is not supported on Windows but you can enable Windows subsystem for Linux, download your preferred Linux distribution from Microsoft Store and access it from there.

To open links on Edge, paste the line below to {HOME}/.bashrc

export BROWSER='/mnt/c/Program Files (x86)/Microsoft/Edge/Application/msedge.exe'

Usage

To run the program, type:

$ ttrv --help

Controls

Move the cursor using either the arrow keys or Vim style movement:

  • Press ▲ and ▼ to scroll through submissions
  • Press ▶ to view the selected submission and ◀ to return
  • Press space-bar to expand/collapse comments
  • Press u to login (this requires a web browser for OAuth)
  • 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
  • /u/me
  • /u/multi-mod/m/art
  • /domain/github.com

See CONTROLS for the full list of commands.

Settings

Configuration File

Configuration files are stored in the {HOME}/.config/ttrv/ directory.

Check out ttrv.cfg for the full list of configurable options. You can clone this file into your home directory by running:

$ ttrv --copy-config

Viewing Media Links

You can use mailcap to configure how TTRV will open different types of links.

title image

A mailcap file allows you to associate different MIME media types, like image/jpeg or video/mp4, with shell commands. This feature is disabled by default because it takes a few extra steps to configure. To get started, copy the default mailcap template to your home directory.

$ ttrv --copy-mailcap

This template contains examples for common MIME types that work with popular reddit websites like imgur, youtube, and gfycat. Open the mailcap template and follow the instructions listed inside.

Once you've setup your mailcap file, enable it by launching ttrv with the ttrv --enable-media flag (or set it in your ttrv.cfg)

Environment Variables

The default programs that TTRV interacts with can be configured through environment variables:

$TTRV_EDITOR A program used to compose text submissions and comments, e.g. vim, emacs, gedit
If not specified, will fallback to $VISUAL and $EDITOR in that order.
$TTRV_BROWSER A program used to open links to external websites, e.g. firefox, google-chrome, w3m, lynx
If not specified, will fallback to $BROWSER, or your system's default browser.
$TTRV_URLVIEWER A tool used to extract hyperlinks from blocks of text, e.g. urlview, urlscan
If not specified, will fallback to urlview if it is installed.

Clipboard

TTRV supports copying submission links to the OS clipboard. On macOS this is supported out of the box. On Linux systems you will need to install either xsel or xclip.

Themes

Themes can be used to customize the look and feel of TTRV

Solarized Dark

Solarized Light

Papercolor

Molokai

You can list all installed themes with the --list-themes command, and select one with --theme. You can save your choice permanently in your ttrv.cfg file. You can also use the F2 & F3 keys inside of TTRV to cycle through all available themes.

For instructions on writing and installing your own themes, see THEMES.md.

FAQ

Why am I getting an error during installation/when launching ttrv?

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 ttrv using python 3. If you don't already have pip3, see http://stackoverflow.com/a/6587528 for setup instructions. Then do

$ sudo pip uninstall ttrv
$ sudo pip3 install -U ttrv
Why do I see garbled text like M-b~@M-" or ^@?

This type of text usually shows up when python is unable to render unicode properly.

  1. Try starting TTRV in ascii-only mode with ttrv --ascii
  2. Make sure that the terminal/font that you're using supports unicode
  3. Try setting the LOCALE to utf-8
  4. Your python may have been built against the wrong curses library, see here and here for more information
How do I run the code directly from the repository?

This project is structured to be run as a python module. This means that you need to launch it using python's -m flag. See the example below, which assumes that you have cloned the repository into the directory ~/ttrv_project.

$ cd ~/ttrv_project
$ python3 -m ttrv

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.