Package Health Score

30 / 100

security
Security issues found
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 4.65K
Forks: 275
Contributors: 50

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package rtv, we found that it has been starred 4,648 times.

Security

Security issues found

Security and license risk for latest version

Release Date: Feb 20, 2023
Direct Vulnerabilities: 0
C
0
H
1
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
2
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like rtv is missing a security policy.

Snyk detected that the latest version of rtv has a security vulnerability.

We highly advise you to review these security issues.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Fix it in your project with Snyk!

Maintenance

Inactive

archived

Commit Frequency

No Recent Commits

Open Issues: 92
Open PR: 11
Last Release: 2 years ago
Last Commit: 2 years ago

Further analysis of the maintenance status of rtv based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for rtv is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 50
Funding: No

With more than 10 contributors for the rtv repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like rtv is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: ==2.7.*, ==3.4.*, ==3.5.*, ==3.6.*, ==3.7.*

Age: 10 years
Latest Release: 2 years ago
Dependencies: 6 Direct / 10 Total
Versions: 51
Maintainers: 1
Wheels: OS Independent

Readme

THIS PROJECT IS NO LONGER MAINTAINED

Reddit Terminal Viewer (RTV)

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

title image

Demo

title image

You can use telnet or ssh to try out a lite version of RTV directly in your terminal, without needing to install it:

$ telnet redditbox.us
$ ssh redditbox.us

redditbox.us is an independent project by Alex Jarmoszuk

Installation

PyPI package

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

$ pip install rtv

Native packages

See Repology for an up-to-date list of supported distro packages:

# macOS
$ brew install rtv

# Arch
$ pacman -S rtv

# Nix
$ nix-env -i rtv

# Debian
$ apt install rtv

# FreeBSD
$ pkg install rtv

From source

$ git clone https://github.com/michael-lazar/rtv.git
$ cd rtv
$ python setup.py install

Windows

RTV is not supported on Windows, due to a lack of resources and interest. Sorry!

Usage

To run the program, type:

$ rtv --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/rtv/ directory.

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

$ rtv --copy-config

Viewing Media Links

You can use mailcap to configure how RTV 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.

$ rtv --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 rtv with the rtv --enable-media flag (or set it in your rtv.cfg)

Environment Variables

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

$RTV_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.
$RTV_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.
$RTV_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

RTV 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 RTV

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 rtv.cfg file. You can also use the F2 & F3 keys inside of RTV 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 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 > > bash > $ sudo pip uninstall rtv > $ sudo pip3 install -U rtv >

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 RTV in ascii-only mode with rtv --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 ~/rtv_project. > > bash > $ 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.

rtv dependencies

beautifulsoup4 decorator kitchen mailcap-fix requests six

FAQs

What is rtv?

A simple terminal viewer for Reddit (Reddit Terminal Viewer). Visit Snyk Advisor to see a full health score report for rtv, including popularity, security, maintenance & community analysis.

Is rtv popular?

The python package rtv receives a total of 449 weekly downloads. As such, rtv popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is rtv well maintained?

We found indications that rtv is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is rtv safe to use?

Security issues were found while scanning the latest version of rtv, and a total of 1 vulnerabilities were detected. It is highly advised to conduct a security review before using this package. View the full security scan results.

Last updated on 2 November-2024, at 03:00 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Reddit Terminal Viewer (RTV)

Table of Contents

Demo

Installation

PyPI package

Native packages

From source

Windows

Usage

Controls

Settings

Configuration File

Viewing Media Links

Environment Variables

Clipboard

Themes

FAQ

Contributing

License

rtv dependencies

FAQs

What is rtv?

Is rtv popular?

Is rtv well maintained?

Is rtv safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues